7 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
8 "group": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
9 "groupTitle": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
17 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
18 "group": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
19 "groupTitle": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
27 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
28 "group": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
29 "groupTitle": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
37 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
38 "group": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
39 "groupTitle": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
47 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
48 "group": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
49 "groupTitle": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.model.js",
54 "url": "/api/actions/{id}",
55 "title": "Deletes a Action",
58 "title": "Example usage:",
59 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
63 "name": "DeleteActions",
65 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
67 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/action/index.js",
68 "groupTitle": "Actions"
72 "url": "/api/actions/{id}",
73 "title": "Update an existing Action",
76 "title": "Example usage:",
77 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
81 "name": "updateActions",
83 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
85 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/action/index.js",
86 "groupTitle": "Actions"
90 "url": "/api/analytics/custom_reports",
91 "title": "Creates a new Analytic Custom Report",
94 "title": "Example usage:",
95 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
99 "name": "CreateAnalytic_Custom_Reports",
100 "group": "Analytic_Custom_Reports",
115 "field": "description",
136 "field": "conditions",
149 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
151 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
152 "groupTitle": "Analytic_Custom_Reports"
156 "url": "/api/analytics/custom_reports/{id}",
157 "title": "Deletes a Analytic Custom Report",
160 "title": "Example usage:",
161 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
165 "name": "DeleteAnalytic_Custom_Reports",
166 "group": "Analytic_Custom_Reports",
167 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
169 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
170 "groupTitle": "Analytic_Custom_Reports"
174 "url": "/api/analytics/custom_reports",
175 "title": "Gets a list of Analytic Custom Reports",
178 "title": "Example usage:",
179 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
183 "name": "GetAnalytic_Custom_Reports",
184 "group": "Analytic_Custom_Reports",
185 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
187 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
188 "groupTitle": "Analytic_Custom_Reports"
192 "url": "/api/analytics/custom_reports/{id}",
193 "title": "Gets a single Analytic Custom Report",
196 "title": "Example usage:",
197 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
201 "name": "ShowAnalytic_Custom_Reports",
202 "group": "Analytic_Custom_Reports",
203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
205 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
206 "groupTitle": "Analytic_Custom_Reports"
210 "url": "/api/analytics/custom_reports/{id}/preview",
211 "title": "Report Preview",
214 "title": "Example usage:",
215 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
220 "group": "Analytic_Custom_Reports",
221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
223 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
224 "groupTitle": "Analytic_Custom_Reports"
228 "url": "/api/analytics/custom_reports/{id}/query",
229 "title": "Report Query SQL",
232 "title": "Example usage:",
233 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
238 "group": "Analytic_Custom_Reports",
239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
241 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
242 "groupTitle": "Analytic_Custom_Reports"
246 "url": "/api/analytics/custom_reports/{id}/run",
247 "title": "Report Run",
250 "title": "Example usage:",
251 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
256 "group": "Analytic_Custom_Reports",
257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
259 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
260 "groupTitle": "Analytic_Custom_Reports"
264 "url": "/api/analytics/custom_reports/{id}",
265 "title": "Update an existing Analytic Custom Report",
268 "title": "Example usage:",
269 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
273 "name": "updateAnalytic_Custom_Reports",
274 "group": "Analytic_Custom_Reports",
275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
277 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticCustomReport/index.js",
278 "groupTitle": "Analytic_Custom_Reports"
282 "url": "/api/analytics/default_reports",
283 "title": "Creates a new Analytic Default Report",
286 "title": "Example usage:",
287 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
291 "name": "CreateAnalytic_Default_Reports",
292 "group": "Analytic_Default_Reports",
307 "field": "description",
328 "field": "conditions",
341 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
343 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
344 "groupTitle": "Analytic_Default_Reports"
348 "url": "/api/analytics/default_reports/{id}",
349 "title": "Deletes a Analytic Default Report",
352 "title": "Example usage:",
353 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
357 "name": "DeleteAnalytic_Default_Reports",
358 "group": "Analytic_Default_Reports",
359 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
361 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
362 "groupTitle": "Analytic_Default_Reports"
366 "url": "/api/analytics/default_reports",
367 "title": "Gets a list of Analytic Default Reports",
370 "title": "Example usage:",
371 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
375 "name": "GetAnalytic_Default_Reports",
376 "group": "Analytic_Default_Reports",
377 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
379 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
380 "groupTitle": "Analytic_Default_Reports"
384 "url": "/api/analytics/default_reports/{id}",
385 "title": "Gets a single Analytic Default Report",
388 "title": "Example usage:",
389 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
393 "name": "ShowAnalytic_Default_Reports",
394 "group": "Analytic_Default_Reports",
395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
397 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
398 "groupTitle": "Analytic_Default_Reports"
402 "url": "/api/analytics/default_reports/{id}/preview",
403 "title": "Report Preview",
406 "title": "Example usage:",
407 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
412 "group": "Analytic_Default_Reports",
413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
415 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
416 "groupTitle": "Analytic_Default_Reports"
420 "url": "/api/analytics/default_reports/{id}/query",
421 "title": "Report Query SQL",
424 "title": "Example usage:",
425 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
430 "group": "Analytic_Default_Reports",
431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
433 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
434 "groupTitle": "Analytic_Default_Reports"
438 "url": "/api/analytics/default_reports/{id}/run",
439 "title": "Report Run",
442 "title": "Example usage:",
443 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
448 "group": "Analytic_Default_Reports",
449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
451 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
452 "groupTitle": "Analytic_Default_Reports"
456 "url": "/api/analytics/default_reports/{id}",
457 "title": "Update an existing Analytic Default Report",
460 "title": "Example usage:",
461 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
465 "name": "updateAnalytic_Default_Reports",
466 "group": "Analytic_Default_Reports",
467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
469 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticDefaultReport/index.js",
470 "groupTitle": "Analytic_Default_Reports"
474 "url": "/api/analytics/extracted_reports",
475 "title": "Creates a new Analytic Extracted Report",
478 "title": "Example usage:",
479 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
483 "name": "CreateAnalytic_Extacted_Reports",
484 "group": "Analytic_Extracted_Reports",
525 "field": "startDate",
564 "field": "reportType",
570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
572 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticExtractedReport/index.js",
573 "groupTitle": "Analytic_Extracted_Reports"
577 "url": "/api/analytics/extracted_reports/{id}",
578 "title": "Deletes a Analytic Extracted Report",
581 "title": "Example usage:",
582 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
586 "name": "DeleteAnalytic_Extacted_Reports",
587 "group": "Analytic_Extracted_Reports",
588 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
590 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticExtractedReport/index.js",
591 "groupTitle": "Analytic_Extracted_Reports"
595 "url": "/api/analytics/extracted_reports",
596 "title": "Gets a list of Analytic Extacted Reports",
599 "title": "Example usage:",
600 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
604 "name": "GetAnalytic_Extacted_Reports",
605 "group": "Analytic_Extracted_Reports",
606 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
608 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticExtractedReport/index.js",
609 "groupTitle": "Analytic_Extracted_Reports"
613 "url": "/api/analytics/extracted_reports/{id}",
614 "title": "Gets a single Analytic Extracted Report",
617 "title": "Example usage:",
618 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
622 "name": "ShowAnalytic_Extacted_Reports",
623 "group": "Analytic_Extracted_Reports",
624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
626 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticExtractedReport/index.js",
627 "groupTitle": "Analytic_Extracted_Reports"
631 "url": "/api/analytics/extracted_reports/{id}/download",
632 "title": "Download Extracted Report",
635 "title": "Example usage:",
636 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
641 "group": "Analytic_Extracted_Reports",
642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
644 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticExtractedReport/index.js",
645 "groupTitle": "Analytic_Extracted_Reports"
649 "url": "/api/analytics/extracted_reports/{id}",
650 "title": "Update an existing Analytic Extracted Report",
653 "title": "Example usage:",
654 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
658 "name": "updateAnalytic_Extacted_Reports",
659 "group": "Analytic_Extracted_Reports",
660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
662 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticExtractedReport/index.js",
663 "groupTitle": "Analytic_Extracted_Reports"
667 "url": "/api/analytics/field_reports/create_many",
668 "title": "Creates many Analytic Field Reports",
671 "title": "Example usage:",
672 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
676 "name": "BulkCreateAnalytic_Field_Reports",
677 "group": "Analytic_Field_Reports",
733 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
735 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
736 "groupTitle": "Analytic_Field_Reports"
740 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
741 "title": "Deletes many Analytic Field Reports",
744 "title": "Example usage:",
745 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
749 "name": "BulkDeleteAnalytic_Field_Reports",
750 "group": "Analytic_Field_Reports",
751 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
753 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
754 "groupTitle": "Analytic_Field_Reports"
758 "url": "/api/analytics/field_reports",
759 "title": "Creates a new Analytic Field Report",
762 "title": "Example usage:",
763 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
767 "name": "CreateAnalytic_Field_Reports",
768 "group": "Analytic_Field_Reports",
824 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
826 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
827 "groupTitle": "Analytic_Field_Reports"
831 "url": "/api/analytics/field_reports/{id}",
832 "title": "Deletes a Analytic Field Report",
835 "title": "Example usage:",
836 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
840 "name": "DeleteAnalytic_Field_Reports",
841 "group": "Analytic_Field_Reports",
842 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
844 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
845 "groupTitle": "Analytic_Field_Reports"
849 "url": "/api/analytics/field_reports",
850 "title": "Gets a list of Analytic Field Reports",
853 "title": "Example usage:",
854 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
858 "name": "GetAnalytic_Field_Reports",
859 "group": "Analytic_Field_Reports",
860 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
862 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
863 "groupTitle": "Analytic_Field_Reports"
867 "url": "/api/analytics/field_reports/{id}",
868 "title": "Gets a single Analytic Field Report",
871 "title": "Example usage:",
872 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
876 "name": "ShowAnalytic_Field_Reports",
877 "group": "Analytic_Field_Reports",
878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
880 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
881 "groupTitle": "Analytic_Field_Reports"
885 "url": "/api/analytics/field_reports/{id}/create_many",
886 "title": "Rewrite fields set",
889 "title": "Example usage:",
890 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
895 "group": "Analytic_Field_Reports",
896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
898 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
899 "groupTitle": "Analytic_Field_Reports"
903 "url": "/api/analytics/field_reports/{id}",
904 "title": "Update an existing Analytic Field Report",
907 "title": "Example usage:",
908 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
912 "name": "updateAnalytic_Field_Reports",
913 "group": "Analytic_Field_Reports",
914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
916 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticFieldReport/index.js",
917 "groupTitle": "Analytic_Field_Reports"
921 "url": "/api/analytics/metrics",
922 "title": "Creates a new Analytic Metrics",
925 "title": "Example usage:",
926 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
930 "name": "CreateAnalytic_Metric",
931 "group": "Analytic_Metrics",
960 "field": "description",
966 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
968 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticMetric/index.js",
969 "groupTitle": "Analytic_Metrics"
973 "url": "/api/analytics/metrics/{id}",
974 "title": "Deletes a Analytic Metrics",
977 "title": "Example usage:",
978 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
982 "name": "DeleteAnalytic_Metric",
983 "group": "Analytic_Metrics",
984 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
986 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticMetric/index.js",
987 "groupTitle": "Analytic_Metrics"
991 "url": "/api/analytics/metrics",
992 "title": "Gets a list of Analytic Metric",
995 "title": "Example usage:",
996 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
1000 "name": "GetAnalytic_Metric",
1001 "group": "Analytic_Metrics",
1002 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1004 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticMetric/index.js",
1005 "groupTitle": "Analytic_Metrics"
1009 "url": "/api/analytics/metrics/{id}",
1010 "title": "Gets a single Analytic Metrics",
1013 "title": "Example usage:",
1014 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
1018 "name": "ShowAnalytic_Metric",
1019 "group": "Analytic_Metrics",
1020 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1022 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticMetric/index.js",
1023 "groupTitle": "Analytic_Metrics"
1027 "url": "/api/analytics/metrics/{id}",
1028 "title": "Update an existing Analytic Metrics",
1031 "title": "Example usage:",
1032 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1036 "name": "updateAnalytic_Metric",
1037 "group": "Analytic_Metrics",
1038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1040 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticMetric/index.js",
1041 "groupTitle": "Analytic_Metrics"
1045 "url": "/api/analytics/tree_reports",
1046 "title": "Creates a new Analytic Tree Report",
1049 "title": "Example usage:",
1050 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1054 "name": "CreateAnalytic_Tree_Reports",
1055 "group": "Analytic_Tree_Reports",
1069 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1071 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticTreeReport/index.js",
1072 "groupTitle": "Analytic_Tree_Reports"
1076 "url": "/api/analytics/tree_reports/{id}",
1077 "title": "Deletes a Analytic Tree Report",
1080 "title": "Example usage:",
1081 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1085 "name": "DeleteAnalytic_Tree_Reports",
1086 "group": "Analytic_Tree_Reports",
1087 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1089 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticTreeReport/index.js",
1090 "groupTitle": "Analytic_Tree_Reports"
1094 "url": "/api/analytics/tree_reports",
1095 "title": "Gets a list of Analytic Tree Reports",
1098 "title": "Example usage:",
1099 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1103 "name": "GetAnalytic_Tree_Reports",
1104 "group": "Analytic_Tree_Reports",
1105 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1107 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticTreeReport/index.js",
1108 "groupTitle": "Analytic_Tree_Reports"
1112 "url": "/api/analytics/tree_reports/{id}",
1113 "title": "Gets a single Analytic Tree Report",
1116 "title": "Example usage:",
1117 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1121 "name": "ShowAnalytic_Tree_Reports",
1122 "group": "Analytic_Tree_Reports",
1123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1125 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticTreeReport/index.js",
1126 "groupTitle": "Analytic_Tree_Reports"
1130 "url": "/api/analytics/tree_reports/{id}",
1131 "title": "Update an existing Analytic Tree Report",
1134 "title": "Example usage:",
1135 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1139 "name": "updateAnalytic_Tree_Reports",
1140 "group": "Analytic_Tree_Reports",
1141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1143 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/analyticTreeReport/index.js",
1144 "groupTitle": "Analytic_Tree_Reports"
1148 "url": "/api/attachments/clone",
1149 "title": "Clone an existing Attachment",
1152 "title": "Example usage:",
1153 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1157 "name": "CloneAttachments",
1158 "group": "Attachments",
1159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1161 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1162 "groupTitle": "Attachments"
1166 "url": "/CreateAttachment",
1167 "title": "Creates a new Attachment",
1168 "name": "CreateAttachment",
1169 "group": "Attachments",
1171 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/attachment.rpc.js",
1172 "groupTitle": "Attachments"
1176 "url": "/api/attachments/{id}",
1177 "title": "Deletes a Attachment",
1180 "title": "Example usage:",
1181 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1185 "name": "DeleteAttachments",
1186 "group": "Attachments",
1187 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1189 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1190 "groupTitle": "Attachments"
1194 "url": "/api/attachments",
1195 "title": "Gets a list of Attachments",
1198 "title": "Example usage:",
1199 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1203 "name": "GetAttachments",
1204 "group": "Attachments",
1205 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1207 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1208 "groupTitle": "Attachments"
1212 "url": "/api/attachments/{id}",
1213 "title": "Gets a single Attachment",
1216 "title": "Example usage:",
1217 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1221 "name": "ShowAttachments",
1222 "group": "Attachments",
1223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1225 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1226 "groupTitle": "Attachments"
1230 "url": "/api/attachments",
1231 "title": "Add attachment",
1234 "title": "Example usage:",
1235 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1240 "group": "Attachments",
1241 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1243 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1244 "groupTitle": "Attachments"
1248 "url": "/api/attachments/:id/download",
1249 "title": "Download attachment",
1252 "title": "Example usage:",
1253 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1258 "group": "Attachments",
1259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1261 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1262 "groupTitle": "Attachments"
1266 "url": "/api/chat/interactions/{id}/attachment_download",
1267 "title": "Download attachment",
1270 "title": "Example usage:",
1271 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1276 "group": "Attachments",
1277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1279 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
1280 "groupTitle": "Attachments"
1284 "url": "/api/attachments/{id}",
1285 "title": "Update an existing Attachment",
1288 "title": "Example usage:",
1289 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1293 "name": "updateAttachments",
1294 "group": "Attachments",
1295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1297 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/attachment/index.js",
1298 "groupTitle": "Attachments"
1302 "url": "/api/auth/local/forgot",
1303 "title": "Creates a new password reset token",
1306 "title": "Example usage:",
1307 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1311 "name": "Local_Forgot_Password",
1312 "group": "Authentication",
1326 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1328 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/authLocal/index.js",
1329 "groupTitle": "Authentication"
1333 "url": "/api/auth/local/reset/:token",
1334 "title": "Reset user password",
1337 "title": "Example usage:",
1338 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1342 "name": "Local_Reset_Password",
1343 "group": "Authentication",
1351 "field": "password",
1357 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1359 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/authLocal/index.js",
1360 "groupTitle": "Authentication"
1364 "url": "/api/auth/google",
1365 "title": "Creates a new User token",
1368 "title": "Example usage:",
1369 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1373 "name": "Local_login",
1374 "group": "Authentication",
1389 "field": "password",
1395 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1397 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/authGoogle/index.js",
1398 "groupTitle": "Authentication"
1402 "url": "/api/auth/local",
1403 "title": "Creates a new User token",
1406 "title": "Example usage:",
1407 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1411 "name": "Local_login",
1412 "group": "Authentication",
1427 "field": "password",
1433 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1435 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/authLocal/index.js",
1436 "groupTitle": "Authentication"
1440 "url": "/api/automations",
1441 "title": "Creates a new Automation",
1444 "title": "Example usage:",
1445 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1449 "name": "CreateAutomations",
1450 "group": "Automations",
1472 "field": "description",
1492 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1494 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1495 "groupTitle": "Automations"
1499 "url": "/api/automations/{id}",
1500 "title": "Deletes a Automation",
1503 "title": "Example usage:",
1504 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1508 "name": "DeleteAutomations",
1509 "group": "Automations",
1510 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1512 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1513 "groupTitle": "Automations"
1517 "url": "/api/automations",
1518 "title": "Gets a list of Automations",
1521 "title": "Example usage:",
1522 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1526 "name": "GetAutomations",
1527 "group": "Automations",
1528 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1530 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1531 "groupTitle": "Automations"
1535 "url": "/api/automations/{id}",
1536 "title": "Gets a single Automation",
1539 "title": "Example usage:",
1540 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1544 "name": "ShowAutomations",
1545 "group": "Automations",
1546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1548 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1549 "groupTitle": "Automations"
1553 "url": "/api/automations/{id}/actions",
1554 "title": "Creates new actions",
1557 "title": "Example usage:",
1558 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1562 "name": "addActions",
1563 "group": "Automations",
1579 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1586 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1593 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1600 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1633 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1635 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1636 "groupTitle": "Automations"
1640 "url": "/api/automations/{id}/conditions",
1641 "title": "Creates new conditions",
1644 "title": "Example usage:",
1645 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1649 "name": "addConditions",
1650 "group": "Automations",
1672 "field": "operator",
1685 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1687 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1688 "groupTitle": "Automations"
1692 "url": "/api/automations/{id}/actions",
1693 "title": "Gets Automation Actions",
1696 "title": "Example usage:",
1697 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1701 "name": "getActions",
1702 "group": "Automations",
1703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1705 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1706 "groupTitle": "Automations"
1710 "url": "/api/automations/{id}/conditions",
1711 "title": "Gets Automation Conditions",
1714 "title": "Example usage:",
1715 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1719 "name": "getConditions",
1720 "group": "Automations",
1721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1723 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1724 "groupTitle": "Automations"
1728 "url": "/api/automations/{id}",
1729 "title": "Update an existing Automation",
1732 "title": "Example usage:",
1733 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1737 "name": "updateAutomations",
1738 "group": "Automations",
1739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1741 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/automation/index.js",
1742 "groupTitle": "Automations"
1746 "url": "/api/canned_answers",
1747 "title": "Create a new canned answer",
1750 "title": "Example usage:",
1751 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1756 "group": "Canned_Answers",
1757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1759 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cannedAnswer/index.js",
1760 "groupTitle": "Canned_Answers"
1764 "url": "/api/canned_answers/{id}",
1765 "title": "Deletes a Canned Answer",
1768 "title": "Example usage:",
1769 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1773 "name": "DeleteCanned_Answers",
1774 "group": "Canned_Answers",
1775 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1777 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cannedAnswer/index.js",
1778 "groupTitle": "Canned_Answers"
1782 "url": "/api/canned_answers",
1783 "title": "Gets a list of Canned Answers",
1786 "title": "Example usage:",
1787 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1791 "name": "GetCanned_Answers",
1792 "group": "Canned_Answers",
1793 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1795 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cannedAnswer/index.js",
1796 "groupTitle": "Canned_Answers"
1800 "url": "/api/canned_answers/{id}",
1801 "title": "Gets a single Canned Answer",
1804 "title": "Example usage:",
1805 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1809 "name": "ShowCanned_Answers",
1810 "group": "Canned_Answers",
1811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1813 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cannedAnswer/index.js",
1814 "groupTitle": "Canned_Answers"
1818 "url": "/api/canned_answers/{id}",
1819 "title": "Update an existing Canned Answer",
1822 "title": "Example usage:",
1823 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1827 "name": "updateCanned_Answers",
1828 "group": "Canned_Answers",
1829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1831 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cannedAnswer/index.js",
1832 "groupTitle": "Canned_Answers"
1836 "url": "/chat/internal/users",
1837 "title": "Gets Users Last Messages",
1840 "title": "Example usage:",
1841 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1845 "name": "getLastUsersMessages",
1846 "group": "ChatInternalMessage",
1847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1849 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
1850 "groupTitle": "ChatInternalMessage"
1854 "url": "/api/chat/applications/{id}",
1855 "title": "Deletes a Application",
1858 "title": "Example usage:",
1859 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1863 "name": "DeleteApplications",
1864 "group": "Chat_Applications",
1865 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1867 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatApplication/index.js",
1868 "groupTitle": "Chat_Applications"
1872 "url": "/api/chat/applications/{id}",
1873 "title": "Gets a single Application",
1876 "title": "Example usage:",
1877 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1881 "name": "ShowApplications",
1882 "group": "Chat_Applications",
1883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1885 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatApplication/index.js",
1886 "groupTitle": "Chat_Applications"
1890 "url": "/api/chat/applications/{id}",
1891 "title": "Update an existing Application",
1894 "title": "Example usage:",
1895 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1899 "name": "updateApplications",
1900 "group": "Chat_Applications",
1901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1903 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatApplication/index.js",
1904 "groupTitle": "Chat_Applications"
1908 "url": "/api/chat/groups",
1909 "title": "Creates a new Group",
1912 "title": "Example usage:",
1913 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1917 "name": "CreateGroups",
1918 "group": "Chat_Groups",
1933 "field": "description",
1946 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1948 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
1949 "groupTitle": "Chat_Groups"
1953 "url": "/api/chat/groups/{id}",
1954 "title": "Deletes a Group",
1957 "title": "Example usage:",
1958 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1962 "name": "DeleteGroups",
1963 "group": "Chat_Groups",
1964 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1966 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
1967 "groupTitle": "Chat_Groups"
1971 "url": "/api/chat/groups/describe",
1972 "title": "Gets table info about Groups",
1975 "title": "Example usage:",
1976 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1980 "name": "DescribeGroups",
1981 "group": "Chat_Groups",
1982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1984 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
1985 "groupTitle": "Chat_Groups"
1989 "url": "/api/chat/groups",
1990 "title": "Gets a list of Groups",
1993 "title": "Example usage:",
1994 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1998 "name": "GetGroups",
1999 "group": "Chat_Groups",
2000 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2002 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2003 "groupTitle": "Chat_Groups"
2007 "url": "/api/chat/groups/{id}/members",
2008 "title": "Removes members from a group",
2011 "title": "Example usage:",
2012 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2016 "name": "RemoveMembers",
2017 "group": "Chat_Groups",
2018 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2020 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2021 "groupTitle": "Chat_Groups"
2025 "url": "/api/chat/groups/{id}",
2026 "title": "Gets a single Group",
2029 "title": "Example usage:",
2030 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2034 "name": "ShowGroups",
2035 "group": "Chat_Groups",
2036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2038 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2039 "groupTitle": "Chat_Groups"
2043 "url": "/api/chat/groups/{id}/members",
2044 "title": "Add members to chat group",
2047 "title": "Example usage:",
2048 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2052 "name": "addMembers",
2053 "group": "Chat_Groups",
2054 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2056 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2057 "groupTitle": "Chat_Groups"
2061 "url": "/api/chat/groups/{id}/messages",
2062 "title": "Creates a new group message",
2065 "title": "Example usage:",
2066 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2070 "name": "addMessage",
2071 "group": "Chat_Groups",
2072 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2074 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2075 "groupTitle": "Chat_Groups"
2079 "url": "/api/chat/groups/{id}/members",
2080 "title": "Gets Members",
2083 "title": "Example usage:",
2084 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2088 "name": "getMembers",
2089 "group": "Chat_Groups",
2090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2092 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2093 "groupTitle": "Chat_Groups"
2097 "url": "/api/chat/groups/{id}/messages",
2098 "title": "Gets Messages",
2101 "title": "Example usage:",
2102 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2106 "name": "getMessages",
2107 "group": "Chat_Groups",
2108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2110 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2111 "groupTitle": "Chat_Groups"
2115 "url": "/api/chat/groups/{id}/unread",
2116 "title": "Get unread chat group messages",
2119 "title": "Example usage:",
2120 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2125 "group": "Chat_Groups",
2126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2128 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2129 "groupTitle": "Chat_Groups"
2133 "url": "/api/chat/groups/{id}",
2134 "title": "Update an existing Group",
2137 "title": "Example usage:",
2138 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2142 "name": "updateGroups",
2143 "group": "Chat_Groups",
2144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2146 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatGroup/index.js",
2147 "groupTitle": "Chat_Groups"
2151 "url": "/api/chat/interactions/{id}/tags",
2152 "title": "Add tags to the interaction",
2155 "title": "Example usage:",
2156 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2161 "group": "Chat_Interactions",
2162 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2164 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2165 "groupTitle": "Chat_Interactions"
2169 "url": "/AddTagsToChatInteraction",
2170 "title": "Add Tags to Chat interaction",
2171 "name": "AddTagsToChatInteraction",
2172 "group": "Chat_Interactions",
2180 "field": "options.attributes",
2187 "field": "options.where",
2194 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/chatInteraction.rpc.js",
2195 "groupTitle": "Chat_Interactions"
2199 "url": "/api/chat/interactions",
2200 "title": "Creates a new Interaction",
2203 "title": "Example usage:",
2204 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2208 "name": "CreateInteractions",
2209 "group": "Chat_Interactions",
2224 "field": "ratingValue",
2235 "field": "ratingType",
2242 "field": "ratingMessage",
2249 "field": "pathTranscript",
2256 "field": "mailTranscript",
2263 "field": "closedAt",
2270 "field": "disposition",
2277 "field": "secondDisposition",
2284 "field": "thirdDisposition",
2298 "field": "browserName",
2305 "field": "browserVersion",
2319 "field": "osVersion",
2326 "field": "deviceModel",
2333 "field": "deviceVendor",
2340 "field": "deviceType",
2354 "field": "customerIp",
2361 "field": "formData",
2368 "field": "read1stAt",
2375 "field": "lastMsgAt",
2386 "field": "lastMsgDirection",
2393 "field": "closeReason",
2400 "field": "customerPort",
2407 "field": "vidaooSessionId",
2413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2415 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2416 "groupTitle": "Chat_Interactions"
2420 "url": "/api/chat/interactions/{id}",
2421 "title": "Deletes a Interaction",
2424 "title": "Example usage:",
2425 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2429 "name": "DeleteInteractions",
2430 "group": "Chat_Interactions",
2431 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2433 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2434 "groupTitle": "Chat_Interactions"
2438 "url": "/api/chat/interactions/describe",
2439 "title": "Gets table info about Interactions",
2442 "title": "Example usage:",
2443 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2447 "name": "DescribeInteractions",
2448 "group": "Chat_Interactions",
2449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2451 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2452 "groupTitle": "Chat_Interactions"
2456 "url": "/api/chat/interactions",
2457 "title": "Gets a list of Interactions",
2460 "title": "Example usage:",
2461 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2465 "name": "GetInteractions",
2466 "group": "Chat_Interactions",
2467 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2469 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2470 "groupTitle": "Chat_Interactions"
2474 "url": "/api/chat/interactions/{id}/tags",
2475 "title": "Removes tags from interaction",
2478 "title": "Example usage:",
2479 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2483 "name": "RemoveTags",
2484 "group": "Chat_Interactions",
2485 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2487 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2488 "groupTitle": "Chat_Interactions"
2492 "url": "/api/chat/interactions/{id}",
2493 "title": "Gets a single Interaction",
2496 "title": "Example usage:",
2497 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2501 "name": "ShowInteractions",
2502 "group": "Chat_Interactions",
2503 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2505 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2506 "groupTitle": "Chat_Interactions"
2510 "url": "/UpdateChatInteraction",
2511 "title": "Updates a new Interaction",
2512 "name": "UpdateChatInteraction",
2513 "group": "Chat_Interactions",
2521 "field": "options.attributes",
2528 "field": "options.where",
2535 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/chatInteraction.rpc.js",
2536 "groupTitle": "Chat_Interactions"
2540 "url": "/api/chat/interactions/{id}/abandon",
2541 "title": "Abandon interaction",
2544 "title": "Example usage:",
2545 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2550 "group": "Chat_Interactions",
2551 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2553 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2554 "groupTitle": "Chat_Interactions"
2558 "url": "/api/chat/interactions/{id}/messages",
2559 "title": "Creates new messages",
2562 "title": "Example usage:",
2563 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2567 "name": "addMessage",
2568 "group": "Chat_Interactions",
2601 "field": "direction",
2615 "field": "providerName",
2622 "field": "providerResponse",
2628 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2630 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2631 "groupTitle": "Chat_Interactions"
2635 "url": "/api/chat/interactions/{id}/close",
2636 "title": "Close Interaction",
2639 "title": "Example usage:",
2640 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2644 "name": "addMessage",
2645 "group": "Chat_Interactions",
2646 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2648 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2649 "groupTitle": "Chat_Interactions"
2653 "url": "/api/chat/interactions/{id}/attachment_upload",
2654 "title": "Add attachment",
2657 "title": "Example usage:",
2658 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2662 "name": "attachmentUpload",
2663 "group": "Chat_Interactions",
2664 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2666 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2667 "groupTitle": "Chat_Interactions"
2671 "url": "/api/chat/interactions/{id}/vidaoo",
2672 "title": "Create Vidaoo Session",
2675 "title": "Example usage:",
2676 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2680 "name": "createVidaooSession",
2681 "group": "Chat_Interactions",
2682 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2684 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2685 "groupTitle": "Chat_Interactions"
2689 "url": "/api/chat/interactions/{id}/custom_update",
2690 "title": "Update interaction",
2693 "title": "Example usage:",
2694 "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2698 "name": "customUpdate",
2699 "group": "Chat_Interactions",
2700 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2702 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2703 "groupTitle": "Chat_Interactions"
2707 "url": "/api/chat/interactions/{id}/download",
2708 "title": "Gets interaction",
2711 "title": "Example usage:",
2712 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2717 "group": "Chat_Interactions",
2718 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2720 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2721 "groupTitle": "Chat_Interactions"
2725 "url": "/api/chat/interactions/{id}/messages",
2726 "title": "Gets interaction messages",
2729 "title": "Example usage:",
2730 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2734 "name": "getMessages",
2735 "group": "Chat_Interactions",
2736 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2738 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2739 "groupTitle": "Chat_Interactions"
2743 "url": "/api/chat/interactions/{id}/my_messages",
2744 "title": "Gets interaction messages",
2747 "title": "Example usage:",
2748 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2752 "name": "getMyMessages",
2753 "group": "Chat_Interactions",
2754 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2756 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2757 "groupTitle": "Chat_Interactions"
2761 "url": "/api/chat/interactions/{id}",
2762 "title": "Update an existing Interaction",
2765 "title": "Example usage:",
2766 "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2770 "name": "updateInteractions",
2771 "group": "Chat_Interactions",
2772 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2774 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInteraction/index.js",
2775 "groupTitle": "Chat_Interactions"
2779 "url": "/api/chat/internal/messages",
2780 "title": "Creates a new Message",
2783 "title": "Example usage:",
2784 "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2788 "name": "CreateMessages",
2789 "group": "Chat_Internal_Messages",
2811 "field": "ChatInternalMessageId",
2817 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2819 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
2820 "groupTitle": "Chat_Internal_Messages"
2824 "url": "/api/chat/internal/messages/{id}",
2825 "title": "Deletes a Message",
2828 "title": "Example usage:",
2829 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2833 "name": "DeleteMessages",
2834 "group": "Chat_Internal_Messages",
2835 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2837 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
2838 "groupTitle": "Chat_Internal_Messages"
2842 "url": "/api/chat/internal/messages/describe",
2843 "title": "Gets table info about Messages",
2846 "title": "Example usage:",
2847 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2851 "name": "DescribeMessages",
2852 "group": "Chat_Internal_Messages",
2853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2855 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
2856 "groupTitle": "Chat_Internal_Messages"
2860 "url": "/api/chat/internal/messages",
2861 "title": "Gets a list of Messages",
2864 "title": "Example usage:",
2865 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2869 "name": "GetMessages",
2870 "group": "Chat_Internal_Messages",
2871 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2873 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
2874 "groupTitle": "Chat_Internal_Messages"
2878 "url": "/api/chat/internal/messages/{id}",
2879 "title": "Gets a single Message",
2882 "title": "Example usage:",
2883 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2887 "name": "ShowMessages",
2888 "group": "Chat_Internal_Messages",
2889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2891 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
2892 "groupTitle": "Chat_Internal_Messages"
2896 "url": "/api/chat/internal/messages/{id}",
2897 "title": "Update an existing Message",
2900 "title": "Example usage:",
2901 "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2905 "name": "updateMessages",
2906 "group": "Chat_Internal_Messages",
2907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2909 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatInternalMessage/index.js",
2910 "groupTitle": "Chat_Internal_Messages"
2914 "url": "/CreateChatMessage",
2915 "title": "Creates a new Message",
2916 "name": "CreateChatMessage",
2917 "group": "Chat_Messages",
2919 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/chatMessage.rpc.js",
2920 "groupTitle": "Chat_Messages"
2924 "url": "/api/chat/messages",
2925 "title": "Creates a new Message",
2928 "title": "Example usage:",
2929 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2933 "name": "CreateMessages",
2934 "group": "Chat_Messages",
2967 "field": "direction",
2981 "field": "providerName",
2988 "field": "providerResponse",
2994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2996 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
2997 "groupTitle": "Chat_Messages"
3001 "url": "/api/chat/messages/{id}",
3002 "title": "Deletes a Message",
3005 "title": "Example usage:",
3006 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
3010 "name": "DeleteMessages",
3011 "group": "Chat_Messages",
3012 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3014 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
3015 "groupTitle": "Chat_Messages"
3019 "url": "/api/chat/messages/describe",
3020 "title": "Gets table info about Messages",
3023 "title": "Example usage:",
3024 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
3028 "name": "DescribeMessages",
3029 "group": "Chat_Messages",
3030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3032 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
3033 "groupTitle": "Chat_Messages"
3037 "url": "/api/chat/messages",
3038 "title": "Gets a list of Messages",
3041 "title": "Example usage:",
3042 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
3046 "name": "GetMessages",
3047 "group": "Chat_Messages",
3048 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3050 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
3051 "groupTitle": "Chat_Messages"
3055 "url": "/api/chat/messages/{id}",
3056 "title": "Gets a single Message",
3059 "title": "Example usage:",
3060 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
3064 "name": "ShowMessages",
3065 "group": "Chat_Messages",
3066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3068 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
3069 "groupTitle": "Chat_Messages"
3073 "url": "/api/chat/messages/{id}",
3074 "title": "Update an existing Message",
3077 "title": "Example usage:",
3078 "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3082 "name": "updateMessages",
3083 "group": "Chat_Messages",
3084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3086 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
3087 "groupTitle": "Chat_Messages"
3091 "url": "/api/chat/offline_messages",
3092 "title": "Creates a new OfflineMessage",
3095 "title": "Example usage:",
3096 "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3100 "name": "CreateOfflineMessages",
3101 "group": "Chat_Offline_Messages",
3115 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3117 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatOfflineMessage/index.js",
3118 "groupTitle": "Chat_Offline_Messages"
3122 "url": "/api/chat/offline_messages/{id}",
3123 "title": "Deletes a OfflineMessage",
3126 "title": "Example usage:",
3127 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3131 "name": "DeleteOfflineMessages",
3132 "group": "Chat_Offline_Messages",
3133 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3135 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatOfflineMessage/index.js",
3136 "groupTitle": "Chat_Offline_Messages"
3140 "url": "/api/chat/offline_messages/describe",
3141 "title": "Gets table info about OfflineMessages",
3144 "title": "Example usage:",
3145 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3149 "name": "DescribeOfflineMessages",
3150 "group": "Chat_Offline_Messages",
3151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3153 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatOfflineMessage/index.js",
3154 "groupTitle": "Chat_Offline_Messages"
3158 "url": "/api/chat/offline_messages",
3159 "title": "Gets a list of OfflineMessages",
3162 "title": "Example usage:",
3163 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3167 "name": "GetOfflineMessages",
3168 "group": "Chat_Offline_Messages",
3169 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3171 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatOfflineMessage/index.js",
3172 "groupTitle": "Chat_Offline_Messages"
3176 "url": "/api/chat/offline_messages/{id}",
3177 "title": "Gets a single OfflineMessage",
3180 "title": "Example usage:",
3181 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3185 "name": "ShowOfflineMessages",
3186 "group": "Chat_Offline_Messages",
3187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3189 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatOfflineMessage/index.js",
3190 "groupTitle": "Chat_Offline_Messages"
3194 "url": "/api/chat/offline_messages/{id}",
3195 "title": "Update an existing OfflineMessage",
3198 "title": "Example usage:",
3199 "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3203 "name": "updateOfflineMessages",
3204 "group": "Chat_Offline_Messages",
3205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3207 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatOfflineMessage/index.js",
3208 "groupTitle": "Chat_Offline_Messages"
3212 "url": "/api/chat/proactive_actions",
3213 "title": "Creates a new Proactive Action",
3216 "title": "Example usage:",
3217 "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3221 "name": "CreateProactive_Actions",
3222 "group": "Chat_Proactive_Actions",
3248 "field": "selector",
3261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3263 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatProactiveAction/index.js",
3264 "groupTitle": "Chat_Proactive_Actions"
3268 "url": "/api/chat/proactive_actions/{id}",
3269 "title": "Deletes a Proactive Action",
3272 "title": "Example usage:",
3273 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3277 "name": "DeleteProactive_Actions",
3278 "group": "Chat_Proactive_Actions",
3279 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3281 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatProactiveAction/index.js",
3282 "groupTitle": "Chat_Proactive_Actions"
3286 "url": "/api/chat/proactive_actions/{id}",
3287 "title": "Gets a single Proactive Action",
3290 "title": "Example usage:",
3291 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3295 "name": "ShowProactive_Actions",
3296 "group": "Chat_Proactive_Actions",
3297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3299 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatProactiveAction/index.js",
3300 "groupTitle": "Chat_Proactive_Actions"
3304 "url": "/api/chat/proactive_actions/{id}",
3305 "title": "Update an existing Proactive Action",
3308 "title": "Example usage:",
3309 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3313 "name": "updateProactive_Actions",
3314 "group": "Chat_Proactive_Actions",
3315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3317 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatProactiveAction/index.js",
3318 "groupTitle": "Chat_Proactive_Actions"
3322 "url": "/CreateChatQueueReport",
3323 "title": "Creates a new Chat Queue Report",
3324 "name": "CreateChatQueueReport",
3325 "group": "Chat_Queue_Reports",
3327 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/chatQueueReport.rpc.js",
3328 "groupTitle": "Chat_Queue_Reports"
3332 "url": "/api/chat/reports/queue",
3333 "title": "Creates a new Chat Queue Report",
3336 "title": "Example usage:",
3337 "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3341 "name": "CreateChat_Queue_Reports",
3342 "group": "Chat_Queue_Reports",
3350 "field": "uniqueid",
3378 "field": "acceptAt",
3398 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3400 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/index.js",
3401 "groupTitle": "Chat_Queue_Reports"
3405 "url": "/api/chat/reports/queue/{id}",
3406 "title": "Deletes a Chat Queue Report",
3409 "title": "Example usage:",
3410 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3414 "name": "DeleteChat_Queue_Reports",
3415 "group": "Chat_Queue_Reports",
3416 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3418 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/index.js",
3419 "groupTitle": "Chat_Queue_Reports"
3423 "url": "/api/chat/reports/queue/describe",
3424 "title": "Gets table info about Chat Queue Reports",
3427 "title": "Example usage:",
3428 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3432 "name": "DescribeChat_Queue_Reports",
3433 "group": "Chat_Queue_Reports",
3434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3436 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/index.js",
3437 "groupTitle": "Chat_Queue_Reports"
3441 "url": "/api/chat/reports/queue",
3442 "title": "Gets a list of Chat Queue Reports",
3445 "title": "Example usage:",
3446 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3450 "name": "GetChat_Queue_Reports",
3451 "group": "Chat_Queue_Reports",
3452 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3454 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/index.js",
3455 "groupTitle": "Chat_Queue_Reports"
3459 "url": "/api/chat/reports/queue/{id}",
3460 "title": "Gets a single Chat Queue Report",
3463 "title": "Example usage:",
3464 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3468 "name": "ShowChat_Queue_Reports",
3469 "group": "Chat_Queue_Reports",
3470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3472 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/index.js",
3473 "groupTitle": "Chat_Queue_Reports"
3477 "url": "/UpdateChatQueueReport",
3478 "title": "Updates a new Chat Queue Report",
3479 "name": "UpdateChatQueueReport",
3480 "group": "Chat_Queue_Reports",
3488 "field": "options.attributes",
3495 "field": "options.where",
3502 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/chatQueueReport.rpc.js",
3503 "groupTitle": "Chat_Queue_Reports"
3507 "url": "/api/chat/reports/queue/{id}",
3508 "title": "Update an existing Chat Queue Report",
3511 "title": "Example usage:",
3512 "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3516 "name": "updateChat_Queue_Reports",
3517 "group": "Chat_Queue_Reports",
3518 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3520 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueueReport/index.js",
3521 "groupTitle": "Chat_Queue_Reports"
3525 "url": "/api/chat/queues/{id}/users",
3526 "title": "Add agents to a queue",
3529 "title": "Example usage:",
3530 "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3534 "name": "AddAgents",
3535 "group": "Chat_Queues",
3536 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3538 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3539 "groupTitle": "Chat_Queues"
3543 "url": "/api/chat/queues/{id}/teams",
3544 "title": "Add teams to a queue",
3547 "title": "Example usage:",
3548 "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3553 "group": "Chat_Queues",
3554 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3556 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3557 "groupTitle": "Chat_Queues"
3561 "url": "/api/chat/queues",
3562 "title": "Creates a new Queue",
3565 "title": "Example usage:",
3566 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3570 "name": "CreateQueues",
3571 "group": "Chat_Queues",
3586 "field": "description",
3605 "field": "strategy",
3611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3613 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3614 "groupTitle": "Chat_Queues"
3618 "url": "/api/chat/queues/{id}",
3619 "title": "Deletes a Queue",
3622 "title": "Example usage:",
3623 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3627 "name": "DeleteQueues",
3628 "group": "Chat_Queues",
3629 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3631 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3632 "groupTitle": "Chat_Queues"
3636 "url": "/api/chat/queues/describe",
3637 "title": "Gets table info about Queues",
3640 "title": "Example usage:",
3641 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3645 "name": "DescribeQueues",
3646 "group": "Chat_Queues",
3647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3649 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3650 "groupTitle": "Chat_Queues"
3654 "url": "/api/chat/queues/{id}/users",
3655 "title": "Gets queue agents",
3658 "title": "Example usage:",
3659 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3663 "name": "GetAgents",
3664 "group": "Chat_Queues",
3665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3667 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3668 "groupTitle": "Chat_Queues"
3672 "url": "/GetChatQueue",
3673 "title": "Gets a list of Queues",
3674 "name": "GetChatQueue",
3675 "group": "Chat_Queues",
3683 "field": "options.attributes",
3690 "field": "options.where",
3697 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/chatQueue.rpc.js",
3698 "groupTitle": "Chat_Queues"
3702 "url": "/api/chat/queues/{id}/members",
3703 "title": "GetMembers",
3706 "title": "Example usage:",
3707 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3711 "name": "GetMembers",
3712 "group": "Chat_Queues",
3713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3715 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3716 "groupTitle": "Chat_Queues"
3720 "url": "/api/chat/queues",
3721 "title": "Gets a list of Queues",
3724 "title": "Example usage:",
3725 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3729 "name": "GetQueues",
3730 "group": "Chat_Queues",
3731 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3733 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3734 "groupTitle": "Chat_Queues"
3738 "url": "/api/chat/queues/{id}/teams",
3739 "title": "Gets queues list",
3742 "title": "Example usage:",
3743 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3748 "group": "Chat_Queues",
3749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3751 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3752 "groupTitle": "Chat_Queues"
3756 "url": "/api/chat/queues/{id}/users",
3757 "title": "Removes agents from a queue",
3760 "title": "Example usage:",
3761 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3765 "name": "RemoveAgents",
3766 "group": "Chat_Queues",
3767 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3769 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3770 "groupTitle": "Chat_Queues"
3774 "url": "/ShowChatQueue",
3775 "title": "Gets a single Queue",
3776 "name": "ShowChatQueue",
3777 "group": "Chat_Queues",
3785 "field": "options.attributes",
3792 "field": "options.where",
3799 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/chatQueue.rpc.js",
3800 "groupTitle": "Chat_Queues"
3804 "url": "/api/chat/queues/{id}",
3805 "title": "Gets a single Queue",
3808 "title": "Example usage:",
3809 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3813 "name": "ShowQueues",
3814 "group": "Chat_Queues",
3815 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3817 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3818 "groupTitle": "Chat_Queues"
3822 "url": "/api/chat/queues/{id}",
3823 "title": "Update an existing Queue",
3826 "title": "Example usage:",
3827 "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3831 "name": "updateQueues",
3832 "group": "Chat_Queues",
3833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3835 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
3836 "groupTitle": "Chat_Queues"
3840 "url": "/api/chat/reports/transfer",
3841 "title": "Creates a new Chat Transfer Report",
3844 "title": "Example usage:",
3845 "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3849 "name": "CreateChat_Transfer_Reports",
3850 "group": "Chat_Transfer_Reports",
3858 "field": "uniqueid",
3877 "field": "transferredAt",
3883 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3885 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatTransferReport/index.js",
3886 "groupTitle": "Chat_Transfer_Reports"
3890 "url": "/api/chat/reports/transfer/{id}",
3891 "title": "Deletes a Chat Transfer Report",
3894 "title": "Example usage:",
3895 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3899 "name": "DeleteChat_Transfer_Reports",
3900 "group": "Chat_Transfer_Reports",
3901 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3903 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatTransferReport/index.js",
3904 "groupTitle": "Chat_Transfer_Reports"
3908 "url": "/api/chat/reports/transfer/describe",
3909 "title": "Gets table info about Chat Transfer Reports",
3912 "title": "Example usage:",
3913 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3917 "name": "DescribeChat_Transfer_Reports",
3918 "group": "Chat_Transfer_Reports",
3919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3921 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatTransferReport/index.js",
3922 "groupTitle": "Chat_Transfer_Reports"
3926 "url": "/api/chat/reports/transfer",
3927 "title": "Gets a list of Chat Transfer Reports",
3930 "title": "Example usage:",
3931 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3935 "name": "GetChat_Transfer_Reports",
3936 "group": "Chat_Transfer_Reports",
3937 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3939 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatTransferReport/index.js",
3940 "groupTitle": "Chat_Transfer_Reports"
3944 "url": "/api/chat/reports/transfer/{id}",
3945 "title": "Gets a single Chat Transfer Report",
3948 "title": "Example usage:",
3949 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3953 "name": "ShowChat_Transfer_Reports",
3954 "group": "Chat_Transfer_Reports",
3955 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3957 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatTransferReport/index.js",
3958 "groupTitle": "Chat_Transfer_Reports"
3962 "url": "/api/chat/reports/transfer/{id}",
3963 "title": "Update an existing Chat Transfer Report",
3966 "title": "Example usage:",
3967 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3971 "name": "updateChat_Transfer_Reports",
3972 "group": "Chat_Transfer_Reports",
3973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3975 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatTransferReport/index.js",
3976 "groupTitle": "Chat_Transfer_Reports"
3980 "url": "/api/chat/websites/{id}/users",
3981 "title": "Add agents to a website",
3984 "title": "Example usage:",
3985 "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3989 "name": "AddAgents",
3990 "group": "Chat_Websites",
3991 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3993 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
3994 "groupTitle": "Chat_Websites"
3998 "url": "/api/chat/websites",
3999 "title": "Creates a new Website",
4002 "title": "Example usage:",
4003 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
4007 "name": "CreateWebsites",
4008 "group": "Chat_Websites",
4030 "field": "description",
4044 "field": "mapKeyOffline",
4058 "field": "agentAlias",
4065 "field": "customerAlias",
4079 "field": "color_button",
4086 "field": "textColor",
4093 "field": "fontSize",
4107 "field": "animation",
4118 "field": "header_shape",
4125 "field": "header_online",
4132 "field": "start_chat_button",
4139 "field": "offline_chat_button",
4146 "field": "header_offline",
4153 "field": "download_transcript",
4167 "field": "whiteLabel",
4174 "field": "defaultWhiteLabel",
4188 "field": "closingQuestion",
4195 "field": "formSubmitSuccessMessage",
4202 "field": "formSubmitFailureMessage",
4209 "field": "noteTitle",
4216 "field": "placeholderMessage",
4223 "field": "closingMessage",
4230 "field": "closingMessageButton",
4237 "field": "skipMessageButton",
4244 "field": "conditionAgreement",
4251 "field": "enableRating",
4258 "field": "enableFeedback",
4265 "field": "enableSendButton",
4272 "field": "feedbackTitle",
4283 "field": "ratingType",
4290 "field": "ratingStarsNumber",
4297 "field": "onlineForm",
4304 "field": "offlineForm",
4318 "field": "autoclose",
4325 "field": "enableCustomerWriting",
4332 "field": "forwardTranscript",
4339 "field": "forwardTranscriptMessage",
4346 "field": "forwardOffline",
4353 "field": "forwardOfflineAddress",
4360 "field": "waitingTitle",
4367 "field": "waitingMessage",
4374 "field": "offlineMessageSubject",
4381 "field": "offlineMessageBody",
4388 "field": "enableUnmanagedNote",
4395 "field": "unmanagedMessage",
4402 "field": "skipUnmanaged",
4409 "field": "sendUnmanaged",
4416 "field": "enableCustomerAttachment",
4423 "field": "enableCustomerCheckmarks",
4430 "field": "agentAvatar",
4437 "field": "showAgentAvatar",
4444 "field": "timezone",
4451 "field": "notificationTemplate",
4458 "field": "notificationSound",
4465 "field": "notificationShake",
4472 "field": "hideWhenOffline",
4479 "field": "agentIdentifier",
4486 "field": "waitForTheAssignedAgent",
4493 "field": "alignment",
4500 "field": "verticalAlignment",
4507 "field": "messagesAlignment",
4514 "field": "defaultTitle",
4521 "field": "customerAvatar",
4528 "field": "showCustomerAvatar",
4535 "field": "messageFontSize",
4542 "field": "backgroundColor",
4549 "field": "queueTransfer",
4556 "field": "queueTransferTimeout",
4563 "field": "agentTransfer",
4570 "field": "agentTransferTimeout",
4577 "field": "systemAlias",
4584 "field": "systemAvatar",
4591 "field": "mandatoryDispositionPauseId",
4592 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4598 "field": "mandatoryDisposition",
4599 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4605 "field": "vidaooEscalation",
4612 "field": "vidaooApiKey",
4618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4620 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4621 "groupTitle": "Chat_Websites"
4625 "url": "/api/chat/websites/{id}",
4626 "title": "Deletes a Website",
4629 "title": "Example usage:",
4630 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4634 "name": "DeleteWebsites",
4635 "group": "Chat_Websites",
4636 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4638 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4639 "groupTitle": "Chat_Websites"
4643 "url": "/api/chat/websites/describe",
4644 "title": "Gets table info about Websites",
4647 "title": "Example usage:",
4648 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4652 "name": "DescribeWebsites",
4653 "group": "Chat_Websites",
4654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4656 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4657 "groupTitle": "Chat_Websites"
4661 "url": "/api/chat/websites/{id}/users",
4662 "title": "Gets agents from website",
4665 "title": "Example usage:",
4666 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4670 "name": "GetAgents",
4671 "group": "Chat_Websites",
4672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4674 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4675 "groupTitle": "Chat_Websites"
4679 "url": "/api/chat/websites",
4680 "title": "Gets a list of Websites",
4683 "title": "Example usage:",
4684 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4688 "name": "GetWebsites",
4689 "group": "Chat_Websites",
4690 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/websites?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/websites?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/websites?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/websites?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/websites?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4692 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4693 "groupTitle": "Chat_Websites"
4697 "url": "/api/chat/websites/{id}/users",
4698 "title": "Removes agents from a website",
4701 "title": "Example usage:",
4702 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4706 "name": "RemoveAgents",
4707 "group": "Chat_Websites",
4708 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4710 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4711 "groupTitle": "Chat_Websites"
4715 "url": "/api/chat/websites/{id}/canned_answers",
4716 "title": "Removes canned answers from account",
4719 "title": "Example usage:",
4720 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4724 "name": "RemoveAnswers",
4725 "group": "Chat_Websites",
4726 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4728 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4729 "groupTitle": "Chat_Websites"
4733 "url": "/api/chat/websites/{id}/dispositions",
4734 "title": "Removes canned answers from account",
4737 "title": "Example usage:",
4738 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4742 "name": "RemoveDispositions",
4743 "group": "Chat_Websites",
4744 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4746 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4747 "groupTitle": "Chat_Websites"
4751 "url": "/api/chat/websites/{id}",
4752 "title": "Gets a single Website",
4755 "title": "Example usage:",
4756 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4760 "name": "ShowWebsites",
4761 "group": "Chat_Websites",
4762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4764 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4765 "groupTitle": "Chat_Websites"
4769 "url": "/api/chat/messages/{id}/accept",
4770 "title": "Accepts message",
4773 "title": "Example usage:",
4774 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4778 "name": "acceptMessage",
4779 "group": "Chat_Websites",
4780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4782 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
4783 "groupTitle": "Chat_Websites"
4787 "url": "/api/chat/websites/{id}/canned_answers",
4788 "title": "Creates new canned answer",
4791 "title": "Example usage:",
4792 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4796 "name": "addAnswer",
4797 "group": "Chat_Websites",
4819 "field": "description",
4832 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4834 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4835 "groupTitle": "Chat_Websites"
4839 "url": "/api/chat/websites/{id}/applications",
4840 "title": "Creates new applications",
4843 "title": "Example usage:",
4844 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4848 "name": "addApplications",
4849 "group": "Chat_Websites",
4857 "field": "priority",
4878 "field": "description",
4885 "field": "interval",
4891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4893 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4894 "groupTitle": "Chat_Websites"
4898 "url": "/api/chat/websites/{id}/avatar",
4899 "title": "Add avatar",
4902 "title": "Example usage:",
4903 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4907 "name": "addAvatar",
4908 "group": "Chat_Websites",
4909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4911 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4912 "groupTitle": "Chat_Websites"
4916 "url": "/api/chat/websites/{id}/customer_avatar",
4917 "title": "Add customer avatar",
4920 "title": "Example usage:",
4921 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4925 "name": "addCustomerAvatar",
4926 "group": "Chat_Websites",
4927 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4929 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4930 "groupTitle": "Chat_Websites"
4934 "url": "/api/chat/websites/{id}/dispositions",
4935 "title": "Creates new disposition",
4938 "title": "Example usage:",
4939 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4943 "name": "addDisposition",
4944 "group": "Chat_Websites",
4971 "field": "description",
4977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4979 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
4980 "groupTitle": "Chat_Websites"
4984 "url": "/api/chat/websites/{id}/dispositions",
4985 "title": "Creates new disposition",
4988 "title": "Example usage:",
4989 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4993 "name": "addDisposition",
4994 "group": "Chat_Websites",
5008 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5010 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5011 "groupTitle": "Chat_Websites"
5015 "url": "/api/chat/accounts/{id}/interactions",
5016 "title": "Creates new interactions",
5019 "title": "Example usage:",
5020 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5024 "name": "addInteraction",
5025 "group": "Chat_Websites",
5040 "field": "ratingValue",
5051 "field": "ratingType",
5058 "field": "ratingMessage",
5065 "field": "pathTranscript",
5072 "field": "mailTranscript",
5079 "field": "closedAt",
5086 "field": "disposition",
5093 "field": "secondDisposition",
5100 "field": "thirdDisposition",
5114 "field": "browserName",
5121 "field": "browserVersion",
5135 "field": "osVersion",
5142 "field": "deviceModel",
5149 "field": "deviceVendor",
5156 "field": "deviceType",
5170 "field": "customerIp",
5177 "field": "formData",
5184 "field": "read1stAt",
5191 "field": "lastMsgAt",
5202 "field": "lastMsgDirection",
5209 "field": "closeReason",
5216 "field": "customerPort",
5223 "field": "vidaooSessionId",
5229 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5231 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5232 "groupTitle": "Chat_Websites"
5236 "url": "/api/chat/websites/{id}/logo",
5237 "title": "Add logo",
5240 "title": "Example usage:",
5241 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5246 "group": "Chat_Websites",
5247 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5249 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5250 "groupTitle": "Chat_Websites"
5254 "url": "/api/chat/websites/{id}/proactive_actions",
5255 "title": "Creates new Proactive Actions",
5258 "title": "Example usage:",
5259 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5263 "name": "addProactiveActions",
5264 "group": "Chat_Websites",
5290 "field": "selector",
5303 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5305 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5306 "groupTitle": "Chat_Websites"
5310 "url": "/api/chat/websites/{id}/system_avatar",
5311 "title": "Add system avatar",
5314 "title": "Example usage:",
5315 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5319 "name": "addSystemAvatar",
5320 "group": "Chat_Websites",
5321 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5323 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5324 "groupTitle": "Chat_Websites"
5328 "url": "/api/chat/websites/{id}/canned_answers",
5329 "title": "Gets account canned answers",
5332 "title": "Example usage:",
5333 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5337 "name": "getAnswers",
5338 "group": "Chat_Websites",
5339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5341 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5342 "groupTitle": "Chat_Websites"
5346 "url": "/api/chat/websites/{id}/applications",
5347 "title": "Gets Website Applications",
5350 "title": "Example usage:",
5351 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5355 "name": "getApplications",
5356 "group": "Chat_Websites",
5357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5359 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5360 "groupTitle": "Chat_Websites"
5364 "url": "/api/chat/websites/{id}/avatar",
5365 "title": "Get avatar",
5368 "title": "Example usage:",
5369 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5373 "name": "getAvatar",
5374 "group": "Chat_Websites",
5375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5377 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5378 "groupTitle": "Chat_Websites"
5382 "url": "/api/chat/websites/{id}/customer_avatar",
5383 "title": "Get Customer Avatar",
5386 "title": "Example usage:",
5387 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5391 "name": "getCustomerAvatar",
5392 "group": "Chat_Websites",
5393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5395 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5396 "groupTitle": "Chat_Websites"
5400 "url": "/api/chat/websites/{id}/fields",
5401 "title": "Gets Website Fields",
5404 "title": "Example usage:",
5405 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5409 "name": "getFields",
5410 "group": "Chat_Websites",
5411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5413 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5414 "groupTitle": "Chat_Websites"
5418 "url": "/api/chat/websites/{id}/interactions",
5419 "title": "Gets Website Interactions",
5422 "title": "Example usage:",
5423 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5427 "name": "getInteraction",
5428 "group": "Chat_Websites",
5429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5431 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5432 "groupTitle": "Chat_Websites"
5436 "url": "/api/chat/websites/{id}/logo",
5437 "title": "Get logo",
5440 "title": "Example usage:",
5441 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5446 "group": "Chat_Websites",
5447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5449 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5450 "groupTitle": "Chat_Websites"
5454 "url": "/api/chat/websites/{id}/offline_messages",
5455 "title": "Gets Website Offline Messages",
5458 "title": "Example usage:",
5459 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5463 "name": "getOfflineMessages",
5464 "group": "Chat_Websites",
5465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5467 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5468 "groupTitle": "Chat_Websites"
5472 "url": "/api/chat/websites/{id}/proactive_actions",
5473 "title": "Gets Website Proactive Actions",
5476 "title": "Example usage:",
5477 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5481 "name": "getProactiveActions",
5482 "group": "Chat_Websites",
5483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5485 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5486 "groupTitle": "Chat_Websites"
5490 "url": "/api/chat/websites/{id}/snippet",
5491 "title": "Gets Website Snippet",
5494 "title": "Example usage:",
5495 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5499 "name": "getSnippet",
5500 "group": "Chat_Websites",
5501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5503 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5504 "groupTitle": "Chat_Websites"
5508 "url": "/api/chat/websites/{id}/system_avatar",
5509 "title": "Get System Avatar",
5512 "title": "Example usage:",
5513 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5517 "name": "getSystemAvatar",
5518 "group": "Chat_Websites",
5519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5521 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5522 "groupTitle": "Chat_Websites"
5526 "url": "/api/chat/websites/{id}/notify",
5527 "title": "Notify new message",
5530 "title": "Example usage:",
5531 "content": "curl https://{domain}/api/chat/websites/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5536 "group": "Chat_Websites",
5537 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5539 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5540 "groupTitle": "Chat_Websites"
5544 "url": "/api/chat/websites/{id}/offline",
5545 "title": "Offline message",
5548 "title": "Example usage:",
5549 "content": "curl https://{domain}/api/chat/websites/{id}/offline -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5554 "group": "Chat_Websites",
5555 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5557 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5558 "groupTitle": "Chat_Websites"
5562 "url": "/api/chat/messages/{id}/reject",
5563 "title": "Rejects message",
5566 "title": "Example usage:",
5567 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5571 "name": "rejectMessage",
5572 "group": "Chat_Websites",
5573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5575 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatMessage/index.js",
5576 "groupTitle": "Chat_Websites"
5580 "url": "/api/chat/websites/{id}",
5581 "title": "Update an existing Website",
5584 "title": "Example usage:",
5585 "content": "curl https://{domain}/api/chat/websites/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5589 "name": "updateWebsites",
5590 "group": "Chat_Websites",
5591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5593 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatWebsite/index.js",
5594 "groupTitle": "Chat_Websites"
5598 "url": "/api/cloudProviders",
5599 "title": "Creates a new CloudProvider",
5602 "title": "Example usage:",
5603 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5607 "name": "CreateCloudProviders",
5608 "group": "CloudProviders",
5647 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5649 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cloudProvider/index.js",
5650 "groupTitle": "CloudProviders"
5654 "url": "/api/cloudProviders/{id}",
5655 "title": "Deletes a CloudProvider",
5658 "title": "Example usage:",
5659 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5663 "name": "DeleteCloudProviders",
5664 "group": "CloudProviders",
5665 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5667 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cloudProvider/index.js",
5668 "groupTitle": "CloudProviders"
5672 "url": "/api/cloudProviders",
5673 "title": "Gets a list of CloudProviders",
5676 "title": "Example usage:",
5677 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5681 "name": "GetCloudProviders",
5682 "group": "CloudProviders",
5683 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5685 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cloudProvider/index.js",
5686 "groupTitle": "CloudProviders"
5690 "url": "/api/cloudProviders/{id}",
5691 "title": "Gets a single CloudProvider",
5694 "title": "Example usage:",
5695 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5699 "name": "ShowCloudProviders",
5700 "group": "CloudProviders",
5701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5703 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cloudProvider/index.js",
5704 "groupTitle": "CloudProviders"
5708 "url": "/api/cloudProviders/{id}",
5709 "title": "Update an existing CloudProvider",
5712 "title": "Example usage:",
5713 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5717 "name": "updateCloudProviders",
5718 "group": "CloudProviders",
5719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5721 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cloudProvider/index.js",
5722 "groupTitle": "CloudProviders"
5726 "url": "/api/cm/companies",
5727 "title": "Creates a new Company",
5730 "title": "Example usage:",
5731 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5735 "name": "CreateCompanies",
5736 "group": "Cm_Companies",
5758 "field": "companyId",
5800 "field": "postalCode",
5828 "field": "emailDomain",
5842 "field": "sPostalCode",
5856 "field": "sCountry",
5863 "field": "description",
5869 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5871 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
5872 "groupTitle": "Cm_Companies"
5876 "url": "/api/cm/companies/{id}",
5877 "title": "Deletes a Company",
5880 "title": "Example usage:",
5881 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5885 "name": "DeleteCompanies",
5886 "group": "Cm_Companies",
5887 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5889 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
5890 "groupTitle": "Cm_Companies"
5894 "url": "/api/cm/companies/describe",
5895 "title": "Gets table info about Companies",
5898 "title": "Example usage:",
5899 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5903 "name": "DescribeCompanies",
5904 "group": "Cm_Companies",
5905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5907 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
5908 "groupTitle": "Cm_Companies"
5912 "url": "/api/cm/companies",
5913 "title": "Gets a list of Companies",
5916 "title": "Example usage:",
5917 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5921 "name": "GetCompanies",
5922 "group": "Cm_Companies",
5923 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/companies?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/companies?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/companies?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/companies?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/companies?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5925 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
5926 "groupTitle": "Cm_Companies"
5930 "url": "/api/cm/companies/{id}",
5931 "title": "Gets a single Company",
5934 "title": "Example usage:",
5935 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5939 "name": "ShowCompanies",
5940 "group": "Cm_Companies",
5941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5943 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
5944 "groupTitle": "Cm_Companies"
5948 "url": "/api/cm/companies/{id}/contacts",
5949 "title": "Creates new contacts",
5952 "title": "Example usage:",
5953 "content": "curl https://{domain}/api/cm/companies/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5957 "name": "addContacts",
5958 "group": "Cm_Companies",
5966 "field": "firstName",
5973 "field": "lastName",
5987 "field": "postalCode",
6008 "field": "dateOfBirth",
6015 "field": "description",
6057 "field": "facebook",
6113 "field": "telegram",
6127 "field": "priority",
6134 "field": "scheduledat",
6140 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6142 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
6143 "groupTitle": "Cm_Companies"
6147 "url": "/api/cm/companies/{id}/contacts",
6148 "title": "Gets List Contacts",
6151 "title": "Example usage:",
6152 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6156 "name": "getContacts",
6157 "group": "Cm_Companies",
6158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6160 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
6161 "groupTitle": "Cm_Companies"
6165 "url": "/api/cm/companies/{id}",
6166 "title": "Update an existing Company",
6169 "title": "Example usage:",
6170 "content": "curl https://{domain}/api/cm/companies/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6174 "name": "updateCompanies",
6175 "group": "Cm_Companies",
6176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6178 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCompany/index.js",
6179 "groupTitle": "Cm_Companies"
6183 "url": "/CreateCmContact",
6184 "title": "Creates a new Contact",
6185 "name": "CreateCmContact",
6186 "group": "Cm_Contacts",
6188 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/cmContact.rpc.js",
6189 "groupTitle": "Cm_Contacts"
6193 "url": "/api/cm/contacts/{id}",
6194 "title": "Deletes a Contact",
6197 "title": "Example usage:",
6198 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6202 "name": "DeleteContacts",
6203 "group": "Cm_Contacts",
6204 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6206 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6207 "groupTitle": "Cm_Contacts"
6211 "url": "/api/cm/contacts/describe",
6212 "title": "Gets table info about Contacts",
6215 "title": "Example usage:",
6216 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6220 "name": "DescribeContacts",
6221 "group": "Cm_Contacts",
6222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6224 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6225 "groupTitle": "Cm_Contacts"
6229 "url": "/GetCmContact",
6230 "title": "Gets a list of Contacts",
6231 "name": "GetCmContact",
6232 "group": "Cm_Contacts",
6240 "field": "options.attributes",
6247 "field": "options.where",
6254 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/cmContact.rpc.js",
6255 "groupTitle": "Cm_Contacts"
6259 "url": "/api/cm/contacts",
6260 "title": "Gets a list of Contacts",
6263 "title": "Example usage:",
6264 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6268 "name": "GetContacts",
6269 "group": "Cm_Contacts",
6270 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/contacts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/contacts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/contacts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/contacts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/contacts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6272 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6273 "groupTitle": "Cm_Contacts"
6277 "url": "/api/cm/contacts/{id}/finals",
6278 "title": "Gets contact hopper finals",
6281 "title": "Example usage:",
6282 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6286 "name": "GetHopperFinals",
6287 "group": "Cm_Contacts",
6288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6290 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6291 "groupTitle": "Cm_Contacts"
6295 "url": "/api/cm/contacts/{id}/hopper_histories",
6296 "title": "Gets contact hopper histories",
6299 "title": "Example usage:",
6300 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6304 "name": "GetHopperHistories",
6305 "group": "Cm_Contacts",
6306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6308 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6309 "groupTitle": "Cm_Contacts"
6313 "url": "/api/cm/contacts/{id}/hoppers",
6314 "title": "Gets contact hoppers",
6317 "title": "Example usage:",
6318 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6322 "name": "GetHoppers",
6323 "group": "Cm_Contacts",
6324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6326 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6327 "groupTitle": "Cm_Contacts"
6331 "url": "/api/cm/contacts/create_many",
6332 "title": "Create Contacts",
6335 "title": "Example usage:",
6336 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6340 "name": "bulkCreate",
6341 "group": "Cm_Contacts",
6342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6344 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6345 "groupTitle": "Cm_Contacts"
6349 "url": "/api/cm/contacts",
6350 "title": "Create Contact",
6353 "title": "Example usage:",
6354 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6359 "group": "Cm_Contacts",
6360 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6362 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6363 "groupTitle": "Cm_Contacts"
6367 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6368 "title": "Gets contact hopper blacks",
6371 "title": "Example usage:",
6372 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6376 "name": "getJscriptySessions",
6377 "group": "Cm_Contacts",
6378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6380 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6381 "groupTitle": "Cm_Contacts"
6385 "url": "/api/cm/contacts/{id}/tags",
6386 "title": "Gets configurations tags",
6389 "title": "Example usage:",
6390 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6395 "group": "Cm_Contacts",
6396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6398 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6399 "groupTitle": "Cm_Contacts"
6403 "url": "/api/cm/contacts/merge",
6404 "title": "Merge Contact",
6407 "title": "Example usage:",
6408 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6413 "group": "Cm_Contacts",
6414 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6416 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6417 "groupTitle": "Cm_Contacts"
6421 "url": "/api/cm/contacts/{id}/tags",
6422 "title": "Sets new tags",
6425 "title": "Example usage:",
6426 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6431 "group": "Cm_Contacts",
6432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6434 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6435 "groupTitle": "Cm_Contacts"
6439 "url": "/api/cm/contacts/{id}",
6440 "title": "Gets a single Contact",
6443 "title": "Example usage:",
6444 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6449 "group": "Cm_Contacts",
6450 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6452 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6453 "groupTitle": "Cm_Contacts"
6457 "url": "/api/cm/contacts/{id}",
6458 "title": "Update a single Contact",
6461 "title": "Example usage:",
6462 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6467 "group": "Cm_Contacts",
6468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6470 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
6471 "groupTitle": "Cm_Contacts"
6475 "url": "/api/cm/custom_fields/{id}",
6476 "title": "Deletes a Custom Field",
6479 "title": "Example usage:",
6480 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6484 "name": "DeleteCustom_Fields",
6485 "group": "Cm_Custom_Fields",
6486 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6488 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCustomField/index.js",
6489 "groupTitle": "Cm_Custom_Fields"
6493 "url": "/api/cm/custom_fields",
6494 "title": "Gets a list of Custom Fields",
6497 "title": "Example usage:",
6498 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6502 "name": "GetCustom_Fields",
6503 "group": "Cm_Custom_Fields",
6504 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/custom_fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/custom_fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/custom_fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/custom_fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/custom_fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6506 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCustomField/index.js",
6507 "groupTitle": "Cm_Custom_Fields"
6511 "url": "/api/cm/custom_fields/{id}",
6512 "title": "Gets a single Custom Field",
6515 "title": "Example usage:",
6516 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6520 "name": "ShowCustom_Fields",
6521 "group": "Cm_Custom_Fields",
6522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6524 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCustomField/index.js",
6525 "groupTitle": "Cm_Custom_Fields"
6529 "url": "/api/cm/custom_fields/{id}",
6530 "title": "Update an existing Custom Field",
6533 "title": "Example usage:",
6534 "content": "curl https://{domain}/api/cm/custom_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6538 "name": "updateCustom_Fields",
6539 "group": "Cm_Custom_Fields",
6540 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6542 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCustomField/index.js",
6543 "groupTitle": "Cm_Custom_Fields"
6547 "url": "/CreateCmHopper",
6548 "title": "Creates a new Hopper",
6549 "name": "CreateCmHopper",
6550 "group": "Cm_Hopper",
6552 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6553 "groupTitle": "Cm_Hopper"
6557 "url": "/api/cm/hopper",
6558 "title": "Creates a new Hopper",
6561 "title": "Example usage:",
6562 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6566 "name": "CreateHopper",
6567 "group": "Cm_Hopper",
6589 "field": "scheduledat",
6596 "field": "countbusyretry",
6603 "field": "countcongestionretry",
6610 "field": "countnoanswerretry",
6617 "field": "callback",
6624 "field": "callbackuniqueid",
6631 "field": "callbackat",
6638 "field": "priority",
6645 "field": "recallme",
6652 "field": "ContactId",
6673 "field": "VoiceQueueId",
6680 "field": "CampaignId",
6687 "field": "countnosuchnumberretry",
6694 "field": "countdropretry",
6701 "field": "countabandonedretry",
6708 "field": "countmachineretry",
6715 "field": "countagentrejectretry",
6721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6723 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
6724 "groupTitle": "Cm_Hopper"
6728 "url": "/api/cm/hopper/describe",
6729 "title": "Gets table info about Hopper",
6732 "title": "Example usage:",
6733 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6737 "name": "DescribeHopper",
6738 "group": "Cm_Hopper",
6739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6741 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
6742 "groupTitle": "Cm_Hopper"
6746 "url": "/DestroyCmHopper",
6747 "title": "Destroy a new Hopper",
6748 "name": "DestroyCmHopper",
6749 "group": "Cm_Hopper",
6757 "field": "options.attributes",
6764 "field": "options.where",
6771 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6772 "groupTitle": "Cm_Hopper"
6776 "url": "/GetCmHopper",
6777 "title": "Gets a list of Hopper",
6778 "name": "GetCmHopper",
6779 "group": "Cm_Hopper",
6787 "field": "options.attributes",
6794 "field": "options.where",
6801 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6802 "groupTitle": "Cm_Hopper"
6806 "url": "/GetCmHopperPreview",
6808 "name": "GetCmHopperPreview",
6809 "group": "Cm_Hopper",
6811 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6812 "groupTitle": "Cm_Hopper"
6816 "url": "/GetContactDialer",
6817 "title": "Get a contact for dialer",
6818 "name": "GetContactDialer",
6819 "group": "Cm_Hopper",
6821 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6822 "groupTitle": "Cm_Hopper"
6826 "url": "/GetContactRecallMe",
6827 "title": "Get a contact for preview recallme",
6828 "name": "GetContactRecallMe",
6829 "group": "Cm_Hopper",
6831 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6832 "groupTitle": "Cm_Hopper"
6836 "url": "/api/cm/hopper",
6837 "title": "Gets a list of Hopper",
6840 "title": "Example usage:",
6841 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6845 "name": "GetHopper",
6846 "group": "Cm_Hopper",
6847 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6849 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
6850 "groupTitle": "Cm_Hopper"
6854 "url": "/MoveContactManagedDialer",
6855 "title": "move a contact for dialer",
6856 "name": "MoveContactManagedDialer",
6857 "group": "Cm_Hopper",
6859 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6860 "groupTitle": "Cm_Hopper"
6864 "url": "/ShowCmHopper",
6865 "title": "Gets a single Hopper",
6866 "name": "ShowCmHopper",
6867 "group": "Cm_Hopper",
6875 "field": "options.attributes",
6882 "field": "options.where",
6889 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6890 "groupTitle": "Cm_Hopper"
6894 "url": "/api/cm/hopper/{id}",
6895 "title": "Gets a single Hopper",
6898 "title": "Example usage:",
6899 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6903 "name": "ShowHopper",
6904 "group": "Cm_Hopper",
6905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6907 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
6908 "groupTitle": "Cm_Hopper"
6912 "url": "/UpdateCmHopper",
6913 "title": "Updates a new Hopper",
6914 "name": "UpdateCmHopper",
6915 "group": "Cm_Hopper",
6923 "field": "options.attributes",
6930 "field": "options.where",
6937 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
6938 "groupTitle": "Cm_Hopper"
6942 "url": "/api/cm/hopper_black/{id}",
6943 "title": "Deletes a Hopper Black",
6946 "title": "Example usage:",
6947 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6951 "name": "DeleteHopper_Black",
6952 "group": "Cm_Hopper_Black",
6953 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6955 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/index.js",
6956 "groupTitle": "Cm_Hopper_Black"
6960 "url": "/api/cm/hopper_black/describe",
6961 "title": "Gets table info about Hopper Black",
6964 "title": "Example usage:",
6965 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6969 "name": "DescribeHopper_Black",
6970 "group": "Cm_Hopper_Black",
6971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6973 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/index.js",
6974 "groupTitle": "Cm_Hopper_Black"
6978 "url": "/DestroyCmHopperBlack",
6979 "title": "Destroy a new Hopper Black",
6980 "name": "DestroyCmHopperBlack",
6981 "group": "Cm_Hopper_Black",
6989 "field": "options.attributes",
6996 "field": "options.where",
7003 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/cmHopperBlack.rpc.js",
7004 "groupTitle": "Cm_Hopper_Black"
7008 "url": "/GetCmHopperBlack",
7009 "title": "Gets a list of Hopper Black",
7010 "name": "GetCmHopperBlack",
7011 "group": "Cm_Hopper_Black",
7019 "field": "options.attributes",
7026 "field": "options.where",
7033 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/cmHopperBlack.rpc.js",
7034 "groupTitle": "Cm_Hopper_Black"
7038 "url": "/api/cm/hopper_black",
7039 "title": "Gets a list of Hopper Black",
7042 "title": "Example usage:",
7043 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7047 "name": "GetHopper_Black",
7048 "group": "Cm_Hopper_Black",
7049 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_black?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_black?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_black?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_black?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_black?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7051 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/index.js",
7052 "groupTitle": "Cm_Hopper_Black"
7056 "url": "/api/cm/hopper_black/{id}",
7057 "title": "Gets a single Hopper Black",
7060 "title": "Example usage:",
7061 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7065 "name": "ShowHopper_Black",
7066 "group": "Cm_Hopper_Black",
7067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7069 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/index.js",
7070 "groupTitle": "Cm_Hopper_Black"
7074 "url": "/UpdateCmHopperBlack",
7075 "title": "Updates a new Hopper Black",
7076 "name": "UpdateCmHopperBlack",
7077 "group": "Cm_Hopper_Black",
7085 "field": "options.attributes",
7092 "field": "options.where",
7099 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/cmHopperBlack.rpc.js",
7100 "groupTitle": "Cm_Hopper_Black"
7104 "url": "/api/cm/hopper_black/{id}",
7105 "title": "Update an existing Hopper Black",
7108 "title": "Example usage:",
7109 "content": "curl https://{domain}/api/cm/hopper_black/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7113 "name": "updateHopper_Black",
7114 "group": "Cm_Hopper_Black",
7115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7117 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperBlack/index.js",
7118 "groupTitle": "Cm_Hopper_Black"
7122 "url": "/api/cm/hopper_final/checkContactHopper",
7123 "title": "Check if contact is in hopper",
7126 "title": "Example usage:",
7127 "content": "curl https://{domain}/api/hopper_final/checkContactHopper -d '{\"VoiceQueueId\": \"VoiceQueueId\", \"CampaignId\": \"CampaignId\", \"ContactId\": \"ContactId\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7131 "name": "/checkContactHopper",
7132 "group": "Cm_Hopper_Final",
7133 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7135 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7136 "groupTitle": "Cm_Hopper_Final"
7140 "url": "/CreateCmHopperFinal",
7141 "title": "Creates a new HopperFinal",
7142 "name": "CreateCmHopperFinal",
7143 "group": "Cm_Hopper_Final",
7145 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/cmHopperFinal.rpc.js",
7146 "groupTitle": "Cm_Hopper_Final"
7150 "url": "/api/cm/hopper_final/describe",
7151 "title": "Gets table info about HopperFinal",
7154 "title": "Example usage:",
7155 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7159 "name": "DescribeHopperFinal",
7160 "group": "Cm_Hopper_Final",
7161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7163 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7164 "groupTitle": "Cm_Hopper_Final"
7168 "url": "/api/cm/hopper_final",
7169 "title": "Gets a list of HopperFinal",
7172 "title": "Example usage:",
7173 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7177 "name": "GetHopperFinal",
7178 "group": "Cm_Hopper_Final",
7179 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_final?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_final?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_final?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_final?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_final?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7181 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7182 "groupTitle": "Cm_Hopper_Final"
7186 "url": "/api/cm/hopper_final/{id}",
7187 "title": "Gets a single HopperFinal",
7190 "title": "Example usage:",
7191 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7195 "name": "ShowHopperFinal",
7196 "group": "Cm_Hopper_Final",
7197 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7199 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7200 "groupTitle": "Cm_Hopper_Final"
7204 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7205 "title": "Return number contacts for attributes",
7208 "title": "Example usage:",
7209 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7213 "name": "countContactsIvrCampaignHopperFinal",
7214 "group": "Cm_Hopper_Final",
7215 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7217 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7218 "groupTitle": "Cm_Hopper_Final"
7222 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7223 "title": "Return number contacts for attributes",
7226 "title": "Example usage:",
7227 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7231 "name": "countContactsQueueCampaignHopperFinal",
7232 "group": "Cm_Hopper_Final",
7233 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7235 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7236 "groupTitle": "Cm_Hopper_Final"
7240 "url": "/api/cm/hopper_final/campaign/{id}",
7241 "title": "Move contacts in hopper",
7244 "title": "Example usage:",
7245 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7249 "name": "moveContactsIvrCampaignHopperFinal",
7250 "group": "Cm_Hopper_Final",
7251 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7253 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7254 "groupTitle": "Cm_Hopper_Final"
7258 "url": "/api/cm/hopper_final/voice/queue/{id}",
7259 "title": "Move contacts in hopper",
7262 "title": "Example usage:",
7263 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7267 "name": "moveContactsQueueCampaignHopperFinal",
7268 "group": "Cm_Hopper_Final",
7269 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7271 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7272 "groupTitle": "Cm_Hopper_Final"
7276 "url": "/api/cm/hopper_final/{id}",
7277 "title": "Update a single hopper final",
7280 "title": "Example usage:",
7281 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7286 "group": "Cm_Hopper_Final",
7287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7289 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperFinal/index.js",
7290 "groupTitle": "Cm_Hopper_Final"
7294 "url": "/CreateCmHopperHistory",
7295 "title": "Creates a new HopperHistory",
7296 "name": "CreateCmHopperHistory",
7297 "group": "Cm_Hopper_History",
7299 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/cmHopperHistory.rpc.js",
7300 "groupTitle": "Cm_Hopper_History"
7304 "url": "/api/cm/hopper_history",
7305 "title": "Creates a new HopperHistory",
7308 "title": "Example usage:",
7309 "content": "curl https://{domain}/api/cm/hopper_history -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7313 "name": "CreateHopperHistory",
7314 "group": "Cm_Hopper_History",
7329 "field": "statedesc",
7336 "field": "scheduledat",
7343 "field": "countbusyretry",
7350 "field": "countcongestionretry",
7357 "field": "countnoanswerretry",
7364 "field": "countglobal",
7371 "field": "uniqueid",
7378 "field": "originatecalleridnum",
7385 "field": "originatecalleridname",
7392 "field": "calleridnum",
7399 "field": "calleridname",
7406 "field": "starttime",
7413 "field": "responsetime",
7420 "field": "answertime",
7427 "field": "droptime",
7441 "field": "ringtime",
7448 "field": "holdtime",
7455 "field": "talktime",
7462 "field": "followuptime",
7469 "field": "dropreason",
7476 "field": "campaign",
7483 "field": "campaigntype",
7490 "field": "membername",
7518 "field": "callback",
7525 "field": "callbackuniqueid",
7532 "field": "callbackat",
7539 "field": "recallme",
7546 "field": "editedat",
7560 "field": "countnosuchnumberretry",
7567 "field": "countdropretry",
7574 "field": "countabandonedretry",
7581 "field": "countmachineretry",
7588 "field": "countagentrejectretry",
7594 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7596 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/index.js",
7597 "groupTitle": "Cm_Hopper_History"
7601 "url": "/api/cm/hopper_history/describe",
7602 "title": "Gets table info about HopperHistory",
7605 "title": "Example usage:",
7606 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7610 "name": "DescribeHopperHistory",
7611 "group": "Cm_Hopper_History",
7612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7614 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/index.js",
7615 "groupTitle": "Cm_Hopper_History"
7619 "url": "/countReschedule",
7620 "title": "Count rescheduled contacts",
7621 "name": "GetCmHopperHistory",
7622 "group": "Cm_Hopper_History",
7630 "field": "options.attributes",
7637 "field": "options.where",
7644 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/cmHopper.rpc.js",
7645 "groupTitle": "Cm_Hopper_History"
7649 "url": "/AvgHandleTime",
7650 "title": "Gets a avg of talktime and holdtime",
7651 "name": "GetCmHopperHistory",
7652 "group": "Cm_Hopper_History",
7660 "field": "options.attributes",
7667 "field": "options.where",
7674 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/cmHopperHistory.rpc.js",
7675 "groupTitle": "Cm_Hopper_History"
7679 "url": "/getVoiceQueueHopperHistory",
7680 "title": "Counts no succes calls",
7681 "name": "GetCmHopperHistory",
7682 "group": "Cm_Hopper_History",
7690 "field": "options.attributes",
7697 "field": "options.where",
7704 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/cmHopperHistory.rpc.js",
7705 "groupTitle": "Cm_Hopper_History"
7709 "url": "/getCampaignHopperHistory",
7710 "title": "Counts no succes calls",
7711 "name": "GetCmHopperHistory",
7712 "group": "Cm_Hopper_History",
7720 "field": "options.attributes",
7727 "field": "options.where",
7734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/cmHopperHistory.rpc.js",
7735 "groupTitle": "Cm_Hopper_History"
7739 "url": "/api/cm/hopper_history",
7740 "title": "Gets a list of HopperHistory",
7743 "title": "Example usage:",
7744 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7748 "name": "GetHopperHistory",
7749 "group": "Cm_Hopper_History",
7750 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_history?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_history?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_history?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_history?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_history?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7752 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/index.js",
7753 "groupTitle": "Cm_Hopper_History"
7757 "url": "/api/cm/hopper_history/{id}",
7758 "title": "Gets a single HopperHistory",
7761 "title": "Example usage:",
7762 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7766 "name": "ShowHopperHistory",
7767 "group": "Cm_Hopper_History",
7768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7770 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/index.js",
7771 "groupTitle": "Cm_Hopper_History"
7775 "url": "/api/cm/hopper_history/{id}",
7776 "title": "Update a single hopper history",
7779 "title": "Example usage:",
7780 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7785 "group": "Cm_Hopper_History",
7786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7788 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopperHistory/index.js",
7789 "groupTitle": "Cm_Hopper_History"
7793 "url": "/api/cm/hopper/{id}",
7794 "title": "Delete Hopper",
7797 "title": "Example usage:",
7798 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7803 "group": "Cm_Hopper",
7804 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7806 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
7807 "groupTitle": "Cm_Hopper"
7811 "url": "/api/cm/hopper/opencontacts",
7812 "title": "Gets Open Contacts",
7815 "title": "Example usage:",
7816 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7820 "name": "getOpenContacts",
7821 "group": "Cm_Hopper",
7822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7824 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
7825 "groupTitle": "Cm_Hopper"
7829 "url": "/api/cm/hopper/preview",
7830 "title": "Gets Preview Dialer Contacts",
7833 "title": "Example usage:",
7834 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7838 "name": "getPreview",
7839 "group": "Cm_Hopper",
7840 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7842 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
7843 "groupTitle": "Cm_Hopper"
7847 "url": "/api/cm/hopper/{id}",
7848 "title": "Update an existing Hopper",
7851 "title": "Example usage:",
7852 "content": "curl https://{domain}/api/cm/hopper/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7856 "name": "updateHopper",
7857 "group": "Cm_Hopper",
7858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7860 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmHopper/index.js",
7861 "groupTitle": "Cm_Hopper"
7865 "url": "/api/cm/lists",
7866 "title": "Creates a new List",
7869 "title": "Example usage:",
7870 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7874 "name": "CreateLists",
7875 "group": "Cm_Lists",
7890 "field": "description",
7897 "field": "dialPrefix",
7903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7905 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
7906 "groupTitle": "Cm_Lists"
7910 "url": "/api/cm/lists/{id}",
7911 "title": "Deletes a List",
7914 "title": "Example usage:",
7915 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7919 "name": "DeleteLists",
7920 "group": "Cm_Lists",
7921 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7923 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
7924 "groupTitle": "Cm_Lists"
7928 "url": "/api/cm/lists/describe",
7929 "title": "Gets table info about Lists",
7932 "title": "Example usage:",
7933 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7937 "name": "DescribeLists",
7938 "group": "Cm_Lists",
7939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7941 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
7942 "groupTitle": "Cm_Lists"
7946 "url": "/api/cm/lists/{id}/users",
7947 "title": "Gets agents from list",
7950 "title": "Example usage:",
7951 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7955 "name": "GetAgents",
7956 "group": "Cm_Lists",
7957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7959 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
7960 "groupTitle": "Cm_Lists"
7964 "url": "/api/cm/lists",
7965 "title": "Gets a list of Lists",
7968 "title": "Example usage:",
7969 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7974 "group": "Cm_Lists",
7975 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/lists?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/lists?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/lists?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/lists?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/lists?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7977 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
7978 "groupTitle": "Cm_Lists"
7982 "url": "/api/cm/lists/{id}/users",
7983 "title": "Removes agents from a list",
7986 "title": "Example usage:",
7987 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7991 "name": "RemoveAgents",
7992 "group": "Cm_Lists",
7993 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7995 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
7996 "groupTitle": "Cm_Lists"
8000 "url": "/api/cm/lists/{id}/dispositions",
8001 "title": "Removes dispositions from account",
8004 "title": "Example usage:",
8005 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
8009 "name": "RemoveDispositions",
8010 "group": "Cm_Lists",
8011 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8013 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8014 "groupTitle": "Cm_Lists"
8018 "url": "/api/cm/lists/{id}",
8019 "title": "Gets a single List",
8022 "title": "Example usage:",
8023 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
8027 "name": "ShowLists",
8028 "group": "Cm_Lists",
8029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8031 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8032 "groupTitle": "Cm_Lists"
8036 "url": "/api/cm/lists/{id}/users",
8037 "title": "Adds agents to a list",
8040 "title": "Example usage:",
8041 "content": "curl https://{domain}/api/cm/lists/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8045 "name": "addAgents",
8046 "group": "Cm_Lists",
8047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8049 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8050 "groupTitle": "Cm_Lists"
8054 "url": "/api/cm/lists/{id}/contacts",
8055 "title": "Creates new contacts",
8058 "title": "Example usage:",
8059 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8063 "name": "addContacts",
8064 "group": "Cm_Lists",
8072 "field": "firstName",
8079 "field": "lastName",
8093 "field": "postalCode",
8114 "field": "dateOfBirth",
8121 "field": "description",
8163 "field": "facebook",
8219 "field": "telegram",
8233 "field": "priority",
8240 "field": "scheduledat",
8246 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8248 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8249 "groupTitle": "Cm_Lists"
8253 "url": "/api/cm/lists/{id}/fields",
8254 "title": "Creates a new custom field",
8257 "title": "Example usage:",
8258 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8262 "name": "addCustomField",
8263 "group": "Cm_Lists",
8264 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8266 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8267 "groupTitle": "Cm_Lists"
8271 "url": "/api/cm/lists/{id}/dispositions",
8272 "title": "Creates new disposition",
8275 "title": "Example usage:",
8276 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8280 "name": "addDisposition",
8281 "group": "Cm_Lists",
8308 "field": "description",
8314 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8316 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8317 "groupTitle": "Cm_Lists"
8321 "url": "/api/cm/lists/{id}/contacts",
8322 "title": "Gets List Contacts",
8325 "title": "Example usage:",
8326 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8330 "name": "getContacts",
8331 "group": "Cm_Lists",
8332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8334 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8335 "groupTitle": "Cm_Lists"
8339 "url": "/api/cm/lists/{id}/fields",
8340 "title": "Gets Custom Fields",
8343 "title": "Example usage:",
8344 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8348 "name": "getCustomFields",
8349 "group": "Cm_Lists",
8350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8352 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8353 "groupTitle": "Cm_Lists"
8357 "url": "/api/cm/lists/{id}/dispositions",
8358 "title": "Gets list dispositions",
8361 "title": "Example usage:",
8362 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8366 "name": "getDispositions",
8367 "group": "Cm_Lists",
8368 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8370 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8371 "groupTitle": "Cm_Lists"
8375 "url": "/api/cm/lists/{id}/contacts/csv",
8376 "title": "Gets CSV List Contacts",
8379 "title": "Example usage:",
8380 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8385 "group": "Cm_Lists",
8386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8388 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8389 "groupTitle": "Cm_Lists"
8393 "url": "/api/cm/lists/{id}",
8394 "title": "Update an existing List",
8397 "title": "Example usage:",
8398 "content": "curl https://{domain}/api/cm/lists/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8402 "name": "updateLists",
8403 "group": "Cm_Lists",
8404 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8406 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmList/index.js",
8407 "groupTitle": "Cm_Lists"
8411 "url": "/api/cm/contacts/upload/:id",
8412 "title": "Import new contacts by csv",
8415 "title": "Example usage:",
8416 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8421 "group": "Cm_contacts",
8422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8424 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
8425 "groupTitle": "Cm_contacts"
8429 "url": "/api/cm/contacts/upload",
8430 "title": "Upload csv",
8433 "title": "Example usage:",
8434 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8439 "group": "Cm_contacts",
8440 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8442 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
8443 "groupTitle": "Cm_contacts"
8447 "url": "/api/cm/contacts/csv",
8448 "title": "Create new contacts by csv",
8451 "title": "Example usage:",
8452 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8456 "name": "uploadCsv",
8457 "group": "Cm_contacts",
8458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8460 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmContact/index.js",
8461 "groupTitle": "Cm_contacts"
8465 "url": "/api/conditions/{id}",
8466 "title": "Deletes a Condition",
8469 "title": "Example usage:",
8470 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8474 "name": "DeleteConditions",
8475 "group": "Conditions",
8476 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8478 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/condition/index.js",
8479 "groupTitle": "Conditions"
8483 "url": "/api/conditions/{id}",
8484 "title": "Update an existing Condition",
8487 "title": "Example usage:",
8488 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8492 "name": "updateConditions",
8493 "group": "Conditions",
8494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8496 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/condition/index.js",
8497 "groupTitle": "Conditions"
8501 "url": "/api/cm/custom_field",
8502 "title": "Create a new custom field",
8505 "title": "Example usage:",
8506 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8510 "name": "CreateCustomField",
8511 "group": "Custom_Fields",
8512 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8514 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cmCustomField/index.js",
8515 "groupTitle": "Custom_Fields"
8519 "url": "/api/dashboards/items",
8520 "title": "Create dasboard item",
8523 "title": "Example usage:",
8524 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8529 "group": "Dashboard_Items",
8530 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8532 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboardItem/index.js",
8533 "groupTitle": "Dashboard_Items"
8537 "url": "/api/dashboards/items/{id}",
8538 "title": "Deletes a Dashboard Item",
8541 "title": "Example usage:",
8542 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8546 "name": "DeleteDashboard_Items",
8547 "group": "Dashboard_Items",
8548 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8550 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboardItem/index.js",
8551 "groupTitle": "Dashboard_Items"
8555 "url": "/api/dashboards/items/{id}",
8556 "title": "Gets a single Dashboard Item",
8559 "title": "Example usage:",
8560 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8564 "name": "ShowDashboard_Items",
8565 "group": "Dashboard_Items",
8566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8568 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboardItem/index.js",
8569 "groupTitle": "Dashboard_Items"
8573 "url": "/api/dashboards/items/{id}",
8574 "title": "Update an existing item",
8577 "title": "Example usage:",
8578 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8583 "group": "Dashboard_Items",
8584 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8586 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboardItem/index.js",
8587 "groupTitle": "Dashboard_Items"
8591 "url": "/api/dashboards/clone",
8592 "title": "Clone an existing Dashboard",
8595 "title": "Example usage:",
8596 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8600 "name": "CloneDashboards",
8601 "group": "Dashboards",
8602 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8604 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8605 "groupTitle": "Dashboards"
8609 "url": "/api/dashboards",
8610 "title": "Creates a new Dashboard",
8613 "title": "Example usage:",
8614 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8618 "name": "CreateDashboards",
8619 "group": "Dashboards",
8634 "field": "description",
8640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8642 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8643 "groupTitle": "Dashboards"
8647 "url": "/api/dashboards/{id}",
8648 "title": "Deletes a Dashboard",
8651 "title": "Example usage:",
8652 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8656 "name": "DeleteDashboards",
8657 "group": "Dashboards",
8658 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8660 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8661 "groupTitle": "Dashboards"
8665 "url": "/api/dashboards",
8666 "title": "Gets a list of Dashboards",
8669 "title": "Example usage:",
8670 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8674 "name": "GetDashboards",
8675 "group": "Dashboards",
8676 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dashboards?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dashboards?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dashboards?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dashboards?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dashboards?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8678 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8679 "groupTitle": "Dashboards"
8683 "url": "/api/dashboards/{id}",
8684 "title": "Gets a single Dashboard",
8687 "title": "Example usage:",
8688 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8692 "name": "ShowDashboards",
8693 "group": "Dashboards",
8694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8696 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8697 "groupTitle": "Dashboards"
8701 "url": "/api/dashboards/{id}/items",
8702 "title": "Creates new item",
8705 "title": "Example usage:",
8706 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8711 "group": "Dashboards",
8712 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8714 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8715 "groupTitle": "Dashboards"
8719 "url": "/api/dashboards/{id}/items",
8720 "title": "Gets items",
8723 "title": "Example usage:",
8724 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8729 "group": "Dashboards",
8730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8732 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8733 "groupTitle": "Dashboards"
8737 "url": "/api/dashboards/{id}",
8738 "title": "Update an existing Dashboard",
8741 "title": "Example usage:",
8742 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8746 "name": "updateDashboards",
8747 "group": "Dashboards",
8748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8750 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/dashboard/index.js",
8751 "groupTitle": "Dashboards"
8755 "url": "/api/integrations/desk/accounts",
8756 "title": "Creates a new Desk Account",
8759 "title": "Example usage:",
8760 "content": "curl https://{domain}/api/integrations/desk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8764 "name": "CreateDesk_Accounts",
8765 "group": "Desk_Accounts",
8780 "field": "description",
8787 "field": "username",
8794 "field": "remoteUri",
8804 "field": "authType",
8811 "field": "password",
8818 "field": "consumerKey",
8825 "field": "consumerSecret",
8839 "field": "tokenSecret",
8846 "field": "serverUrl",
8853 "\"integrationTab\"",
8863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8865 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
8866 "groupTitle": "Desk_Accounts"
8870 "url": "/api/integrations/desk/accounts/{id}",
8871 "title": "Deletes a Desk Account",
8874 "title": "Example usage:",
8875 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8879 "name": "DeleteDesk_Accounts",
8880 "group": "Desk_Accounts",
8881 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8883 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
8884 "groupTitle": "Desk_Accounts"
8888 "url": "/GetDeskAccount",
8889 "title": "Gets a list of Desk Accounts",
8890 "name": "GetDeskAccount",
8891 "group": "Desk_Accounts",
8899 "field": "options.attributes",
8906 "field": "options.where",
8913 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/intDeskAccount.rpc.js",
8914 "groupTitle": "Desk_Accounts"
8918 "url": "/api/integrations/desk/accounts",
8919 "title": "Gets a list of Desk Accounts",
8922 "title": "Example usage:",
8923 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8927 "name": "GetDesk_Accounts",
8928 "group": "Desk_Accounts",
8929 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8931 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
8932 "groupTitle": "Desk_Accounts"
8936 "url": "/ShowDeskAccount",
8937 "title": "Gets a single Desk Account",
8938 "name": "ShowDeskAccount",
8939 "group": "Desk_Accounts",
8947 "field": "options.attributes",
8954 "field": "options.where",
8961 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/intDeskAccount.rpc.js",
8962 "groupTitle": "Desk_Accounts"
8966 "url": "/api/integrations/desk/accounts/{id}",
8967 "title": "Gets a single Desk Account",
8970 "title": "Example usage:",
8971 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8975 "name": "ShowDesk_Accounts",
8976 "group": "Desk_Accounts",
8977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8979 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
8980 "groupTitle": "Desk_Accounts"
8984 "url": "/api/integrations/desk/accounts/{id}/configurations",
8985 "title": "Creates new configuration",
8988 "title": "Example usage:",
8989 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8993 "name": "addConfiguration",
8994 "group": "Desk_Accounts",
8995 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8997 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
8998 "groupTitle": "Desk_Accounts"
9002 "url": "/api/integrations/desk/accounts/{id}/configurations",
9003 "title": "Gets account configurations",
9006 "title": "Example usage:",
9007 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9011 "name": "getConfigurations",
9012 "group": "Desk_Accounts",
9013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9015 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
9016 "groupTitle": "Desk_Accounts"
9020 "url": "/api/integrations/desk/accounts/{id}/fields",
9021 "title": "Gets account fields",
9024 "title": "Example usage:",
9025 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
9029 "name": "getFields",
9030 "group": "Desk_Accounts",
9031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9033 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
9034 "groupTitle": "Desk_Accounts"
9038 "url": "/api/integrations/desk/accounts/{id}",
9039 "title": "Update an existing Desk Account",
9042 "title": "Example usage:",
9043 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9047 "name": "updateDesk_Accounts",
9048 "group": "Desk_Accounts",
9049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9051 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskAccount/index.js",
9052 "groupTitle": "Desk_Accounts"
9056 "url": "/api/integrations/desk/configurations",
9057 "title": "Creates a new Desk Configuration",
9060 "title": "Example usage:",
9061 "content": "curl https://{domain}/api/integrations/desk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9065 "name": "CreateDesk_Configurations",
9066 "group": "Desk_Configurations",
9081 "field": "description",
9087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9089 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9090 "groupTitle": "Desk_Configurations"
9094 "url": "/api/integrations/desk/configurations/{id}",
9095 "title": "Deletes a Desk Configuration",
9098 "title": "Example usage:",
9099 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
9103 "name": "DeleteDesk_Configurations",
9104 "group": "Desk_Configurations",
9105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9107 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9108 "groupTitle": "Desk_Configurations"
9112 "url": "/api/integrations/desk/configurations",
9113 "title": "Gets a list of Desk Configurations",
9116 "title": "Example usage:",
9117 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
9121 "name": "GetDesk_Configurations",
9122 "group": "Desk_Configurations",
9123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9125 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9126 "groupTitle": "Desk_Configurations"
9130 "url": "/api/integrations/desk/configurations/{id}",
9131 "title": "Gets a single Desk Configuration",
9134 "title": "Example usage:",
9135 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
9139 "name": "ShowDesk_Configurations",
9140 "group": "Desk_Configurations",
9141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9143 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9144 "groupTitle": "Desk_Configurations"
9148 "url": "/api/integrations/desk/configurations/{id}/descriptions",
9149 "title": "Gets configurations descriptions",
9152 "title": "Example usage:",
9153 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9157 "name": "getDescriptions",
9158 "group": "Desk_Configurations",
9159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9161 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9162 "groupTitle": "Desk_Configurations"
9166 "url": "/api/integrations/desk/configurations/{id}/fields",
9167 "title": "Gets configurations fields",
9170 "title": "Example usage:",
9171 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9175 "name": "getFields",
9176 "group": "Desk_Configurations",
9177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9179 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9180 "groupTitle": "Desk_Configurations"
9184 "url": "/api/integrations/desk/configurations/{id}/subjects",
9185 "title": "Gets configurations subjects",
9188 "title": "Example usage:",
9189 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9193 "name": "getSubjects",
9194 "group": "Desk_Configurations",
9195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9197 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9198 "groupTitle": "Desk_Configurations"
9202 "url": "/api/integrations/desk/configurations/{id}/tags",
9203 "title": "Gets configurations tags",
9206 "title": "Example usage:",
9207 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9212 "group": "Desk_Configurations",
9213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9215 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9216 "groupTitle": "Desk_Configurations"
9220 "url": "/api/integrations/desk/configurations/{id}/tags",
9221 "title": "Sets new tags",
9224 "title": "Example usage:",
9225 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9230 "group": "Desk_Configurations",
9231 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9233 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9234 "groupTitle": "Desk_Configurations"
9238 "url": "/api/integrations/desk/configurations/{id}",
9239 "title": "Update an existing Desk Configuration",
9242 "title": "Example usage:",
9243 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9247 "name": "updateDesk_Configurations",
9248 "group": "Desk_Configurations",
9249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9251 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskConfiguration/index.js",
9252 "groupTitle": "Desk_Configurations"
9256 "url": "/api/integrations/desk/fields",
9257 "title": "Creates a new Desk Field",
9260 "title": "Example usage:",
9261 "content": "curl https://{domain}/api/integrations/desk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9265 "name": "CreateDesk_Fields",
9266 "group": "Desk_Fields",
9276 "\"customVariable\"",
9303 "\"customVariable\""
9313 "field": "keyContent",
9327 "field": "nameField",
9334 "field": "customField",
9341 "field": "variableName",
9347 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9349 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskField/index.js",
9350 "groupTitle": "Desk_Fields"
9354 "url": "/api/integrations/desk/fields/{id}",
9355 "title": "Deletes a Desk Field",
9358 "title": "Example usage:",
9359 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9363 "name": "DeleteDesk_Fields",
9364 "group": "Desk_Fields",
9365 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9367 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskField/index.js",
9368 "groupTitle": "Desk_Fields"
9372 "url": "/api/integrations/desk/fields",
9373 "title": "Gets a list of Desk Fields",
9376 "title": "Example usage:",
9377 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9381 "name": "GetDesk_Fields",
9382 "group": "Desk_Fields",
9383 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9385 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskField/index.js",
9386 "groupTitle": "Desk_Fields"
9390 "url": "/api/integrations/desk/fields/{id}",
9391 "title": "Gets a single Desk Field",
9394 "title": "Example usage:",
9395 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9399 "name": "ShowDesk_Fields",
9400 "group": "Desk_Fields",
9401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9403 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskField/index.js",
9404 "groupTitle": "Desk_Fields"
9408 "url": "/api/integrations/desk/fields/{id}",
9409 "title": "Update an existing Desk Field",
9412 "title": "Example usage:",
9413 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9417 "name": "updateDesk_Fields",
9418 "group": "Desk_Fields",
9419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9421 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDeskField/index.js",
9422 "groupTitle": "Desk_Fields"
9426 "url": "/api/dispositions",
9427 "title": "Creates a new Disposition",
9430 "title": "Example usage:",
9431 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9435 "name": "CreateDispositions",
9436 "group": "Dispositions",
9463 "field": "description",
9469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9471 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/disposition/index.js",
9472 "groupTitle": "Dispositions"
9476 "url": "/api/dispositions/{id}",
9477 "title": "Deletes a Disposition",
9480 "title": "Example usage:",
9481 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9485 "name": "DeleteDispositions",
9486 "group": "Dispositions",
9487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9489 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/disposition/index.js",
9490 "groupTitle": "Dispositions"
9494 "url": "/api/dispositions",
9495 "title": "Gets a list of Dispositions",
9498 "title": "Example usage:",
9499 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9503 "name": "GetDispositions",
9504 "group": "Dispositions",
9505 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dispositions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dispositions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dispositions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dispositions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dispositions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9507 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/disposition/index.js",
9508 "groupTitle": "Dispositions"
9512 "url": "/api/dispositions/{id}",
9513 "title": "Gets a single Disposition",
9516 "title": "Example usage:",
9517 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9521 "name": "ShowDispositions",
9522 "group": "Dispositions",
9523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9525 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/disposition/index.js",
9526 "groupTitle": "Dispositions"
9530 "url": "/api/dispositions/{id}",
9531 "title": "Update an existing Disposition",
9534 "title": "Example usage:",
9535 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9539 "name": "updateDispositions",
9540 "group": "Dispositions",
9541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9543 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/disposition/index.js",
9544 "groupTitle": "Dispositions"
9548 "url": "/api/integrations/dynamics365/accounts",
9549 "title": "Creates a new Dynamics365 Account",
9552 "title": "Example usage:",
9553 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9557 "name": "CreateDynamics365_Accounts",
9558 "group": "Dynamics365_Accounts",
9573 "field": "username",
9580 "field": "password",
9587 "field": "remoteUri",
9594 "field": "tenantId",
9601 "field": "clientId",
9608 "field": "clientSecret",
9615 "field": "serverUrl",
9622 "field": "description",
9628 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9630 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9631 "groupTitle": "Dynamics365_Accounts"
9635 "url": "/api/integrations/dynamics365/accounts/{id}",
9636 "title": "Deletes a Dynamics365 Account",
9639 "title": "Example usage:",
9640 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9644 "name": "DeleteDynamics365_Accounts",
9645 "group": "Dynamics365_Accounts",
9646 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9648 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9649 "groupTitle": "Dynamics365_Accounts"
9653 "url": "/GetDynamics365Account",
9654 "title": "Gets a list of Dynamics365 Accounts",
9655 "name": "GetDynamics365Account",
9656 "group": "Dynamics365_Accounts",
9664 "field": "options.attributes",
9671 "field": "options.where",
9678 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/intDynamics365Account.rpc.js",
9679 "groupTitle": "Dynamics365_Accounts"
9683 "url": "/api/integrations/dynamics365/accounts",
9684 "title": "Gets a list of Dynamics365 Accounts",
9687 "title": "Example usage:",
9688 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9692 "name": "GetDynamics365_Accounts",
9693 "group": "Dynamics365_Accounts",
9694 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9696 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9697 "groupTitle": "Dynamics365_Accounts"
9701 "url": "/ShowDynamics365Account",
9702 "title": "Gets a single Dynamics365 Account",
9703 "name": "ShowDynamics365Account",
9704 "group": "Dynamics365_Accounts",
9712 "field": "options.attributes",
9719 "field": "options.where",
9726 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/intDynamics365Account.rpc.js",
9727 "groupTitle": "Dynamics365_Accounts"
9731 "url": "/api/integrations/dynamics365/accounts/{id}",
9732 "title": "Gets a single Dynamics365 Account",
9735 "title": "Example usage:",
9736 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9740 "name": "ShowDynamics365_Accounts",
9741 "group": "Dynamics365_Accounts",
9742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9744 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9745 "groupTitle": "Dynamics365_Accounts"
9749 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9750 "title": "Creates new configuration",
9753 "title": "Example usage:",
9754 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9758 "name": "addConfiguration",
9759 "group": "Dynamics365_Accounts",
9760 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9762 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9763 "groupTitle": "Dynamics365_Accounts"
9767 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9768 "title": "Gets account configurations",
9771 "title": "Example usage:",
9772 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9776 "name": "getConfigurations",
9777 "group": "Dynamics365_Accounts",
9778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9780 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9781 "groupTitle": "Dynamics365_Accounts"
9785 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9786 "title": "Gets account fields",
9789 "title": "Example usage:",
9790 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9794 "name": "getFields",
9795 "group": "Dynamics365_Accounts",
9796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9798 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9799 "groupTitle": "Dynamics365_Accounts"
9803 "url": "/api/integrations/dynamics365/accounts/{id}",
9804 "title": "Update an existing Dynamics365 Account",
9807 "title": "Example usage:",
9808 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9812 "name": "updateDynamics365_Accounts",
9813 "group": "Dynamics365_Accounts",
9814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9816 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Account/index.js",
9817 "groupTitle": "Dynamics365_Accounts"
9821 "url": "/api/integrations/dynamics365/configurations",
9822 "title": "Creates a new Dynamics365 Configuration",
9825 "title": "Example usage:",
9826 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9830 "name": "CreateDynamics365_Configurations",
9831 "group": "Dynamics365_Configurations",
9846 "field": "description",
9857 "field": "ticketType",
9863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9865 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9866 "groupTitle": "Dynamics365_Configurations"
9870 "url": "/api/integrations/dynamics365/configurations/{id}",
9871 "title": "Deletes a Dynamics365 Configuration",
9874 "title": "Example usage:",
9875 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9879 "name": "DeleteDynamics365_Configurations",
9880 "group": "Dynamics365_Configurations",
9881 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9883 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9884 "groupTitle": "Dynamics365_Configurations"
9888 "url": "/api/integrations/dynamics365/configurations",
9889 "title": "Gets a list of Dynamics365 Configurations",
9892 "title": "Example usage:",
9893 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9897 "name": "GetDynamics365_Configurations",
9898 "group": "Dynamics365_Configurations",
9899 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9901 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9902 "groupTitle": "Dynamics365_Configurations"
9906 "url": "/api/integrations/dynamics365/configurations/{id}",
9907 "title": "Gets a single Dynamics365 Configuration",
9910 "title": "Example usage:",
9911 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9915 "name": "ShowDynamics365_Configurations",
9916 "group": "Dynamics365_Configurations",
9917 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9919 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9920 "groupTitle": "Dynamics365_Configurations"
9924 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9925 "title": "Gets configurations descriptions",
9928 "title": "Example usage:",
9929 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9933 "name": "getDescriptions",
9934 "group": "Dynamics365_Configurations",
9935 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9937 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9938 "groupTitle": "Dynamics365_Configurations"
9942 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9943 "title": "Gets configurations fields",
9946 "title": "Example usage:",
9947 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9951 "name": "getFields",
9952 "group": "Dynamics365_Configurations",
9953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9955 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9956 "groupTitle": "Dynamics365_Configurations"
9960 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9961 "title": "Gets configurations subjects",
9964 "title": "Example usage:",
9965 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9969 "name": "getSubjects",
9970 "group": "Dynamics365_Configurations",
9971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9973 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9974 "groupTitle": "Dynamics365_Configurations"
9978 "url": "/api/integrations/dynamics365/configurations/{id}",
9979 "title": "Update an existing Dynamics365 Configuration",
9982 "title": "Example usage:",
9983 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9987 "name": "updateDynamics365_Configurations",
9988 "group": "Dynamics365_Configurations",
9989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9991 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Configuration/index.js",
9992 "groupTitle": "Dynamics365_Configurations"
9996 "url": "/api/integrations/dynamics365/fields",
9997 "title": "Creates a new Dynamics365 Field",
10000 "title": "Example usage:",
10001 "content": "curl https://{domain}/api/integrations/dynamics365/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10005 "name": "CreateDynamics365_Fields",
10006 "group": "Dynamics365_Fields",
10016 "\"customVariable\"",
10027 "field": "content",
10043 "\"customVariable\""
10046 "field": "keyType",
10053 "field": "keyContent",
10060 "field": "idField",
10067 "field": "nameField",
10074 "field": "customField",
10081 "field": "variableName",
10087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10088 "version": "0.0.0",
10089 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Field/index.js",
10090 "groupTitle": "Dynamics365_Fields"
10094 "url": "/api/integrations/dynamics365/fields/{id}",
10095 "title": "Deletes a Dynamics365 Field",
10098 "title": "Example usage:",
10099 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
10103 "name": "DeleteDynamics365_Fields",
10104 "group": "Dynamics365_Fields",
10105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10106 "version": "0.0.0",
10107 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Field/index.js",
10108 "groupTitle": "Dynamics365_Fields"
10112 "url": "/api/integrations/dynamics365/fields",
10113 "title": "Gets a list of Dynamics365 Fields",
10116 "title": "Example usage:",
10117 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
10121 "name": "GetDynamics365_Fields",
10122 "group": "Dynamics365_Fields",
10123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10124 "version": "0.0.0",
10125 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Field/index.js",
10126 "groupTitle": "Dynamics365_Fields"
10130 "url": "/api/integrations/dynamics365/fields/{id}",
10131 "title": "Gets a single Dynamics365 Field",
10134 "title": "Example usage:",
10135 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
10139 "name": "ShowDynamics365_Fields",
10140 "group": "Dynamics365_Fields",
10141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10142 "version": "0.0.0",
10143 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Field/index.js",
10144 "groupTitle": "Dynamics365_Fields"
10148 "url": "/api/integrations/dynamics365/fields/{id}",
10149 "title": "Update an existing Dynamics365 Field",
10152 "title": "Example usage:",
10153 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10157 "name": "updateDynamics365_Fields",
10158 "group": "Dynamics365_Fields",
10159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10160 "version": "0.0.0",
10161 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intDynamics365Field/index.js",
10162 "groupTitle": "Dynamics365_Fields"
10166 "url": "/api/fax/accounts/{id}/users",
10167 "title": "Add agents to a fax account",
10170 "title": "Example usage:",
10171 "content": "curl https://{domain}/api/fax/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10175 "name": "AddAgents",
10176 "group": "Fax_Accounts",
10177 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10178 "version": "0.0.0",
10179 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10180 "groupTitle": "Fax_Accounts"
10184 "url": "/api/fax/accounts",
10185 "title": "Creates a new Account",
10188 "title": "Example usage:",
10189 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10193 "name": "CreateAccounts",
10194 "group": "Fax_Accounts",
10209 "field": "description",
10227 "field": "headerinfo",
10234 "field": "localstationid",
10249 "field": "minrate",
10264 "field": "maxrate",
10278 "field": "gateway",
10285 "field": "faxdetect",
10292 "field": "t38timeout",
10319 "field": "notificationTemplate",
10326 "field": "notificationSound",
10333 "field": "notificationShake",
10340 "field": "waitForTheAssignedAgent",
10347 "field": "queueTransfer",
10354 "field": "queueTransferTimeout",
10361 "field": "agentTransfer",
10368 "field": "agentTransferTimeout",
10375 "field": "mandatoryDispositionPauseId",
10376 "description": "<p>Status to put when mandatory disposition is enabled</p>"
10382 "field": "mandatoryDisposition",
10383 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10389 "version": "0.0.0",
10390 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10391 "groupTitle": "Fax_Accounts"
10395 "url": "/api/fax/accounts/{id}",
10396 "title": "Deletes a Account",
10399 "title": "Example usage:",
10400 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10404 "name": "DeleteAccounts",
10405 "group": "Fax_Accounts",
10406 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10407 "version": "0.0.0",
10408 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10409 "groupTitle": "Fax_Accounts"
10413 "url": "/api/fax/accounts/describe",
10414 "title": "Gets table info about Accounts",
10417 "title": "Example usage:",
10418 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10422 "name": "DescribeAccounts",
10423 "group": "Fax_Accounts",
10424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10425 "version": "0.0.0",
10426 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10427 "groupTitle": "Fax_Accounts"
10431 "url": "/api/fax/accounts",
10432 "title": "Gets a list of Accounts",
10435 "title": "Example usage:",
10436 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10440 "name": "GetAccounts",
10441 "group": "Fax_Accounts",
10442 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10443 "version": "0.0.0",
10444 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10445 "groupTitle": "Fax_Accounts"
10449 "url": "/api/fax/accounts/{id}/users",
10450 "title": "Gets agents from fax account",
10453 "title": "Example usage:",
10454 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10458 "name": "GetAgents",
10459 "group": "Fax_Accounts",
10460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10461 "version": "0.0.0",
10462 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10463 "groupTitle": "Fax_Accounts"
10467 "url": "/GetFaxAccount",
10468 "title": "Gets a list of Accounts",
10469 "name": "GetFaxAccount",
10470 "group": "Fax_Accounts",
10478 "field": "options.attributes",
10485 "field": "options.where",
10491 "version": "0.0.0",
10492 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/faxAccount.rpc.js",
10493 "groupTitle": "Fax_Accounts"
10497 "url": "/api/fax/accounts/{id}/users",
10498 "title": "Removes agents from a fax account",
10501 "title": "Example usage:",
10502 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10506 "name": "RemoveAgents",
10507 "group": "Fax_Accounts",
10508 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10509 "version": "0.0.0",
10510 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10511 "groupTitle": "Fax_Accounts"
10515 "url": "/api/fax/accounts/{id}/canned_answers",
10516 "title": "Removes canned answers from account",
10519 "title": "Example usage:",
10520 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10524 "name": "RemoveAnswers",
10525 "group": "Fax_Accounts",
10526 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10527 "version": "0.0.0",
10528 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10529 "groupTitle": "Fax_Accounts"
10533 "url": "/api/fax/accounts/{id}/dispositions",
10534 "title": "Removes dispositions from account",
10537 "title": "Example usage:",
10538 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10542 "name": "RemoveDispositions",
10543 "group": "Fax_Accounts",
10544 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10545 "version": "0.0.0",
10546 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10547 "groupTitle": "Fax_Accounts"
10551 "url": "/api/fax/accounts/{id}",
10552 "title": "Gets a single Account",
10555 "title": "Example usage:",
10556 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10560 "name": "ShowAccounts",
10561 "group": "Fax_Accounts",
10562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10563 "version": "0.0.0",
10564 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10565 "groupTitle": "Fax_Accounts"
10569 "url": "/api/fax/accounts/{id}/canned_answers",
10570 "title": "Creates new canned answer",
10573 "title": "Example usage:",
10574 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10578 "name": "addAnswer",
10579 "group": "Fax_Accounts",
10601 "field": "description",
10614 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10615 "version": "0.0.0",
10616 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10617 "groupTitle": "Fax_Accounts"
10621 "url": "/api/fax/accounts/{id}/applications",
10622 "title": "Creates new applications",
10625 "title": "Example usage:",
10626 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10630 "name": "addApplications",
10631 "group": "Fax_Accounts",
10639 "field": "priority",
10653 "field": "appdata",
10660 "field": "description",
10667 "field": "interval",
10673 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10674 "version": "0.0.0",
10675 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10676 "groupTitle": "Fax_Accounts"
10680 "url": "/api/fax/accounts/addaccountapplications",
10681 "title": "Creates new account and applications",
10684 "title": "Example usage:",
10685 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10689 "name": "addApplications",
10690 "group": "Fax_Accounts",
10698 "field": "priority",
10712 "field": "appdata",
10719 "field": "description",
10726 "field": "interval",
10732 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10733 "version": "0.0.0",
10734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10735 "groupTitle": "Fax_Accounts"
10739 "url": "/api/fax/accounts/{id}/dispositions",
10740 "title": "Creates new disposition",
10743 "title": "Example usage:",
10744 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10748 "name": "addDisposition",
10749 "group": "Fax_Accounts",
10776 "field": "description",
10782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10783 "version": "0.0.0",
10784 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10785 "groupTitle": "Fax_Accounts"
10789 "url": "/api/fax/accounts/{id}/interactions",
10790 "title": "Creates new interactions",
10793 "title": "Example usage:",
10794 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10798 "name": "addInteraction",
10799 "group": "Fax_Accounts",
10814 "field": "closedAt",
10821 "field": "disposition",
10828 "field": "secondDisposition",
10835 "field": "thirdDisposition",
10849 "field": "read1stAt",
10867 "field": "firstMsgDirection",
10874 "field": "lastMsgAt",
10885 "field": "lastMsgDirection",
10891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10892 "version": "0.0.0",
10893 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10894 "groupTitle": "Fax_Accounts"
10898 "url": "/api/fax/accounts/{id}/canned_answers",
10899 "title": "Gets account canned answers",
10902 "title": "Example usage:",
10903 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10907 "name": "getAnswers",
10908 "group": "Fax_Accounts",
10909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10910 "version": "0.0.0",
10911 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10912 "groupTitle": "Fax_Accounts"
10916 "url": "/api/fax/accounts/{id}/applications",
10917 "title": "Gets account pplications",
10920 "title": "Example usage:",
10921 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10925 "name": "getApplications",
10926 "group": "Fax_Accounts",
10927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10928 "version": "0.0.0",
10929 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10930 "groupTitle": "Fax_Accounts"
10934 "url": "/api/fax/accounts/{id}/dispositions",
10935 "title": "Gets account dispositions",
10938 "title": "Example usage:",
10939 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10943 "name": "getDispositions",
10944 "group": "Fax_Accounts",
10945 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10946 "version": "0.0.0",
10947 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10948 "groupTitle": "Fax_Accounts"
10952 "url": "/api/fax/accounts/{id}/interactions",
10953 "title": "Gets account interactions",
10956 "title": "Example usage:",
10957 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10961 "name": "getInteraction",
10962 "group": "Fax_Accounts",
10963 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10964 "version": "0.0.0",
10965 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10966 "groupTitle": "Fax_Accounts"
10970 "url": "/api/fax/accounts/{id}/messages",
10971 "title": "Gets account messages",
10974 "title": "Example usage:",
10975 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10979 "name": "getMessages",
10980 "group": "Fax_Accounts",
10981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10982 "version": "0.0.0",
10983 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
10984 "groupTitle": "Fax_Accounts"
10988 "url": "/api/fax/accounts/{id}/send",
10989 "title": "Send new fax",
10992 "title": "Example usage:",
10993 "content": "curl https://{domain}/api/fax/accounts/{id}/send -d '{from: '\"John Doe\" <123456>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10998 "group": "Fax_Accounts",
10999 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11000 "version": "0.0.0",
11001 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
11002 "groupTitle": "Fax_Accounts"
11006 "url": "/api/fax/accounts/{id}",
11007 "title": "Update an existing Account",
11010 "title": "Example usage:",
11011 "content": "curl https://{domain}/api/fax/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11015 "name": "updateAccounts",
11016 "group": "Fax_Accounts",
11017 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11018 "version": "0.0.0",
11019 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
11020 "groupTitle": "Fax_Accounts"
11024 "url": "/api/fax/accounts/updateaccountapplications",
11025 "title": "Update account and applications",
11028 "title": "Example usage:",
11029 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11033 "name": "updateApplications",
11034 "group": "Fax_Accounts",
11042 "field": "priority",
11056 "field": "appdata",
11063 "field": "description",
11070 "field": "interval",
11076 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11077 "version": "0.0.0",
11078 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxAccount/index.js",
11079 "groupTitle": "Fax_Accounts"
11083 "url": "/api/fax/applications",
11084 "title": "Creates a new Application",
11087 "title": "Example usage:",
11088 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11092 "name": "CreateApplications",
11093 "group": "Fax_Applications",
11101 "field": "priority",
11115 "field": "appdata",
11122 "field": "description",
11129 "field": "interval",
11135 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11136 "version": "0.0.0",
11137 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxApplication/index.js",
11138 "groupTitle": "Fax_Applications"
11142 "url": "/api/fax/applications/{id}",
11143 "title": "Deletes a Application",
11146 "title": "Example usage:",
11147 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
11151 "name": "DeleteApplications",
11152 "group": "Fax_Applications",
11153 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11154 "version": "0.0.0",
11155 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxApplication/index.js",
11156 "groupTitle": "Fax_Applications"
11160 "url": "/api/fax/applications",
11161 "title": "Gets a list of Applications",
11164 "title": "Example usage:",
11165 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
11169 "name": "GetApplications",
11170 "group": "Fax_Applications",
11171 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11172 "version": "0.0.0",
11173 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxApplication/index.js",
11174 "groupTitle": "Fax_Applications"
11178 "url": "/api/fax/applications/{id}",
11179 "title": "Gets a single Application",
11182 "title": "Example usage:",
11183 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
11187 "name": "ShowApplications",
11188 "group": "Fax_Applications",
11189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11190 "version": "0.0.0",
11191 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxApplication/index.js",
11192 "groupTitle": "Fax_Applications"
11196 "url": "/UpdateFaxApplication",
11197 "title": "Updates a new Application",
11198 "name": "UpdateFaxApplication",
11199 "group": "Fax_Applications",
11207 "field": "options.attributes",
11214 "field": "options.where",
11220 "version": "0.0.0",
11221 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxApplication/faxApplication.rpc.js",
11222 "groupTitle": "Fax_Applications"
11226 "url": "/api/fax/applications/{id}",
11227 "title": "Update an existing Application",
11230 "title": "Example usage:",
11231 "content": "curl https://{domain}/api/fax/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11235 "name": "updateApplications",
11236 "group": "Fax_Applications",
11237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11238 "version": "0.0.0",
11239 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxApplication/index.js",
11240 "groupTitle": "Fax_Applications"
11244 "url": "/api/fax/interactions/{id}/tags",
11245 "title": "Add tags to the interaction",
11248 "title": "Example usage:",
11249 "content": "curl https://{domain}/api/fax/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11254 "group": "Fax_Interactions",
11255 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11256 "version": "0.0.0",
11257 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11258 "groupTitle": "Fax_Interactions"
11262 "url": "/AddTagsToFaxInteraction",
11263 "title": "Add Tags to Fax interaction",
11264 "name": "AddTagsToFaxInteraction",
11265 "group": "Fax_Interactions",
11273 "field": "options.attributes",
11280 "field": "options.where",
11286 "version": "0.0.0",
11287 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/faxInteraction.rpc.js",
11288 "groupTitle": "Fax_Interactions"
11292 "url": "/api/fax/interactions",
11293 "title": "Creates a new Interaction",
11296 "title": "Example usage:",
11297 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11301 "name": "CreateInteractions",
11302 "group": "Fax_Interactions",
11317 "field": "closedAt",
11324 "field": "disposition",
11331 "field": "secondDisposition",
11338 "field": "thirdDisposition",
11352 "field": "read1stAt",
11370 "field": "firstMsgDirection",
11377 "field": "lastMsgAt",
11388 "field": "lastMsgDirection",
11394 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11395 "version": "0.0.0",
11396 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11397 "groupTitle": "Fax_Interactions"
11401 "url": "/api/fax/interactions/{id}",
11402 "title": "Deletes a Interaction",
11405 "title": "Example usage:",
11406 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11410 "name": "DeleteInteractions",
11411 "group": "Fax_Interactions",
11412 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11413 "version": "0.0.0",
11414 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11415 "groupTitle": "Fax_Interactions"
11419 "url": "/api/fax/interactions/describe",
11420 "title": "Gets table info about Interactions",
11423 "title": "Example usage:",
11424 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11428 "name": "DescribeInteractions",
11429 "group": "Fax_Interactions",
11430 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11431 "version": "0.0.0",
11432 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11433 "groupTitle": "Fax_Interactions"
11437 "url": "/api/fax/interactions",
11438 "title": "Gets a list of Interactions",
11441 "title": "Example usage:",
11442 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11446 "name": "GetInteractions",
11447 "group": "Fax_Interactions",
11448 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11449 "version": "0.0.0",
11450 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11451 "groupTitle": "Fax_Interactions"
11455 "url": "/api/fax/interactions/{id}/tags",
11456 "title": "Removes tags from interaction",
11459 "title": "Example usage:",
11460 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11464 "name": "RemoveTags",
11465 "group": "Fax_Interactions",
11466 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11467 "version": "0.0.0",
11468 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11469 "groupTitle": "Fax_Interactions"
11473 "url": "/api/fax/interactions/{id}",
11474 "title": "Gets a single Interaction",
11477 "title": "Example usage:",
11478 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11482 "name": "ShowInteractions",
11483 "group": "Fax_Interactions",
11484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11485 "version": "0.0.0",
11486 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11487 "groupTitle": "Fax_Interactions"
11491 "url": "/UpdateFaxInteraction",
11492 "title": "Updates a new Interaction",
11493 "name": "UpdateFaxInteraction",
11494 "group": "Fax_Interactions",
11502 "field": "options.attributes",
11509 "field": "options.where",
11515 "version": "0.0.0",
11516 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/faxInteraction.rpc.js",
11517 "groupTitle": "Fax_Interactions"
11521 "url": "/api/fax/interactions/{id}/messages",
11522 "title": "Creates new messages",
11525 "title": "Example usage:",
11526 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11530 "name": "addMessage",
11531 "group": "Fax_Interactions",
11557 "field": "direction",
11564 "field": "failMessage",
11577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11578 "version": "0.0.0",
11579 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11580 "groupTitle": "Fax_Interactions"
11584 "url": "/api/fax/interactions/{id}/download",
11585 "title": "Get interactions",
11588 "title": "Example usage:",
11589 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11593 "name": "download",
11594 "group": "Fax_Interactions",
11595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11596 "version": "0.0.0",
11597 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11598 "groupTitle": "Fax_Interactions"
11602 "url": "/api/fax/interactions/{id}/messages",
11603 "title": "Gets interaction messages",
11606 "title": "Example usage:",
11607 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11611 "name": "getMessages",
11612 "group": "Fax_Interactions",
11613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11614 "version": "0.0.0",
11615 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11616 "groupTitle": "Fax_Interactions"
11620 "url": "/api/fax/interactions/{id}",
11621 "title": "Update an existing Interaction",
11624 "title": "Example usage:",
11625 "content": "curl https://{domain}/api/fax/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11629 "name": "updateInteractions",
11630 "group": "Fax_Interactions",
11631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11632 "version": "0.0.0",
11633 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxInteraction/index.js",
11634 "groupTitle": "Fax_Interactions"
11638 "url": "/api/fax/messages/{id}/download",
11639 "title": "Get message",
11642 "title": "Example usage:",
11643 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11647 "name": "download",
11648 "group": "Fax_Message",
11649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11650 "version": "0.0.0",
11651 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11652 "groupTitle": "Fax_Message"
11656 "url": "/CreateFaxMessage",
11657 "title": "Creates a new Message",
11658 "name": "CreateFaxMessage",
11659 "group": "Fax_Messages",
11660 "version": "0.0.0",
11661 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/faxMessage.rpc.js",
11662 "groupTitle": "Fax_Messages"
11666 "url": "/api/fax/messages/{id}",
11667 "title": "Deletes a Message",
11670 "title": "Example usage:",
11671 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11675 "name": "DeleteMessages",
11676 "group": "Fax_Messages",
11677 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11678 "version": "0.0.0",
11679 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11680 "groupTitle": "Fax_Messages"
11684 "url": "/api/fax/messages/describe",
11685 "title": "Gets table info about Messages",
11688 "title": "Example usage:",
11689 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11693 "name": "DescribeMessages",
11694 "group": "Fax_Messages",
11695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11696 "version": "0.0.0",
11697 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11698 "groupTitle": "Fax_Messages"
11702 "url": "/api/fax/messages",
11703 "title": "Gets a list of Messages",
11706 "title": "Example usage:",
11707 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11711 "name": "GetMessages",
11712 "group": "Fax_Messages",
11713 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11714 "version": "0.0.0",
11715 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11716 "groupTitle": "Fax_Messages"
11720 "url": "/api/fax/messages/{id}",
11721 "title": "Gets a single Message",
11724 "title": "Example usage:",
11725 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11729 "name": "ShowMessages",
11730 "group": "Fax_Messages",
11731 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11732 "version": "0.0.0",
11733 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11734 "groupTitle": "Fax_Messages"
11738 "url": "/UpdateFaxMessage",
11739 "title": "Updates a new Message",
11740 "name": "UpdateFaxMessage",
11741 "group": "Fax_Messages",
11749 "field": "options.attributes",
11756 "field": "options.where",
11762 "version": "0.0.0",
11763 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/faxMessage.rpc.js",
11764 "groupTitle": "Fax_Messages"
11768 "url": "/api/fax/messages/{id}/accept",
11769 "title": "Accepts message",
11772 "title": "Example usage:",
11773 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11777 "name": "acceptMessage",
11778 "group": "Fax_Messages",
11779 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11780 "version": "0.0.0",
11781 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11782 "groupTitle": "Fax_Messages"
11786 "url": "/api/fax/messages",
11787 "title": "Create message and send Fax",
11790 "title": "Example usage:",
11791 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11795 "name": "rejectMessage",
11796 "group": "Fax_Messages",
11797 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11798 "version": "0.0.0",
11799 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11800 "groupTitle": "Fax_Messages"
11804 "url": "/api/fax/messages/{id}/reject",
11805 "title": "Rejects message",
11808 "title": "Example usage:",
11809 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11813 "name": "rejectMessage",
11814 "group": "Fax_Messages",
11815 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11816 "version": "0.0.0",
11817 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11818 "groupTitle": "Fax_Messages"
11822 "url": "/api/fax/messages/{id}",
11823 "title": "Update an existing Message",
11826 "title": "Example usage:",
11827 "content": "curl https://{domain}/api/fax/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11831 "name": "updateMessages",
11832 "group": "Fax_Messages",
11833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11834 "version": "0.0.0",
11835 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxMessage/index.js",
11836 "groupTitle": "Fax_Messages"
11840 "url": "/CreateFaxQueueReport",
11841 "title": "Creates a new Fax Queue Report",
11842 "name": "CreateFaxQueueReport",
11843 "group": "Fax_Queue_Reports",
11844 "version": "0.0.0",
11845 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/faxQueueReport.rpc.js",
11846 "groupTitle": "Fax_Queue_Reports"
11850 "url": "/api/fax/reports/queue",
11851 "title": "Creates a new Fax Queue Report",
11854 "title": "Example usage:",
11855 "content": "curl https://{domain}/api/fax/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11859 "name": "CreateFax_Queue_Reports",
11860 "group": "Fax_Queue_Reports",
11868 "field": "uniqueid",
11889 "field": "leaveAt",
11896 "field": "acceptAt",
11916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11917 "version": "0.0.0",
11918 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/index.js",
11919 "groupTitle": "Fax_Queue_Reports"
11923 "url": "/api/fax/reports/queue/{id}",
11924 "title": "Deletes a Fax Queue Report",
11927 "title": "Example usage:",
11928 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11932 "name": "DeleteFax_Queue_Reports",
11933 "group": "Fax_Queue_Reports",
11934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11935 "version": "0.0.0",
11936 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/index.js",
11937 "groupTitle": "Fax_Queue_Reports"
11941 "url": "/api/fax/reports/queue/describe",
11942 "title": "Gets table info about Fax Queue Reports",
11945 "title": "Example usage:",
11946 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11950 "name": "DescribeFax_Queue_Reports",
11951 "group": "Fax_Queue_Reports",
11952 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11953 "version": "0.0.0",
11954 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/index.js",
11955 "groupTitle": "Fax_Queue_Reports"
11959 "url": "/api/fax/reports/queue",
11960 "title": "Gets a list of Fax Queue Reports",
11963 "title": "Example usage:",
11964 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11968 "name": "GetFax_Queue_Reports",
11969 "group": "Fax_Queue_Reports",
11970 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11971 "version": "0.0.0",
11972 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/index.js",
11973 "groupTitle": "Fax_Queue_Reports"
11977 "url": "/api/fax/reports/queue/{id}",
11978 "title": "Gets a single Fax Queue Report",
11981 "title": "Example usage:",
11982 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11986 "name": "ShowFax_Queue_Reports",
11987 "group": "Fax_Queue_Reports",
11988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11989 "version": "0.0.0",
11990 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/index.js",
11991 "groupTitle": "Fax_Queue_Reports"
11995 "url": "/UpdateFaxQueueReport",
11996 "title": "Updates a new Fax Queue Report",
11997 "name": "UpdateFaxQueueReport",
11998 "group": "Fax_Queue_Reports",
12006 "field": "options.attributes",
12013 "field": "options.where",
12019 "version": "0.0.0",
12020 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/faxQueueReport.rpc.js",
12021 "groupTitle": "Fax_Queue_Reports"
12025 "url": "/api/fax/reports/queue/{id}",
12026 "title": "Update an existing Fax Queue Report",
12029 "title": "Example usage:",
12030 "content": "curl https://{domain}/api/fax/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12034 "name": "updateFax_Queue_Reports",
12035 "group": "Fax_Queue_Reports",
12036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12037 "version": "0.0.0",
12038 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueueReport/index.js",
12039 "groupTitle": "Fax_Queue_Reports"
12043 "url": "/api/fax/queues/{id}/users",
12044 "title": "Add agents to a queue",
12047 "title": "Example usage:",
12048 "content": "curl https://{domain}/api/fax/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12052 "name": "AddAgents",
12053 "group": "Fax_Queues",
12054 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12055 "version": "0.0.0",
12056 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12057 "groupTitle": "Fax_Queues"
12061 "url": "/api/fax/queues/{id}/teams",
12062 "title": "Add teams to a queue",
12065 "title": "Example usage:",
12066 "content": "curl https://{domain}/api/fax/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12070 "name": "AddTeams",
12071 "group": "Fax_Queues",
12072 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12073 "version": "0.0.0",
12074 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12075 "groupTitle": "Fax_Queues"
12079 "url": "/api/fax/queues",
12080 "title": "Creates a new Queue",
12083 "title": "Example usage:",
12084 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12088 "name": "CreateQueues",
12089 "group": "Fax_Queues",
12104 "field": "description",
12111 "field": "timeout",
12123 "field": "strategy",
12130 "field": "lastAgent",
12136 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12137 "version": "0.0.0",
12138 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12139 "groupTitle": "Fax_Queues"
12143 "url": "/api/fax/queues/{id}",
12144 "title": "Deletes a Queue",
12147 "title": "Example usage:",
12148 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
12152 "name": "DeleteQueues",
12153 "group": "Fax_Queues",
12154 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12155 "version": "0.0.0",
12156 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12157 "groupTitle": "Fax_Queues"
12161 "url": "/api/fax/queues/describe",
12162 "title": "Gets table info about Queues",
12165 "title": "Example usage:",
12166 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
12170 "name": "DescribeQueues",
12171 "group": "Fax_Queues",
12172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12173 "version": "0.0.0",
12174 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12175 "groupTitle": "Fax_Queues"
12179 "url": "/api/fax/queues/{id}/users",
12180 "title": "Gets queue agents",
12183 "title": "Example usage:",
12184 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
12188 "name": "GetAgents",
12189 "group": "Fax_Queues",
12190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12191 "version": "0.0.0",
12192 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12193 "groupTitle": "Fax_Queues"
12197 "url": "/GetFaxQueue",
12198 "title": "Gets a list of Queues",
12199 "name": "GetFaxQueue",
12200 "group": "Fax_Queues",
12208 "field": "options.attributes",
12215 "field": "options.where",
12221 "version": "0.0.0",
12222 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/faxQueue.rpc.js",
12223 "groupTitle": "Fax_Queues"
12227 "url": "/api/fax/queues/{id}/members",
12228 "title": "GetMembers",
12231 "title": "Example usage:",
12232 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
12236 "name": "GetMembers",
12237 "group": "Fax_Queues",
12238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12239 "version": "0.0.0",
12240 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12241 "groupTitle": "Fax_Queues"
12245 "url": "/api/fax/queues",
12246 "title": "Gets a list of Queues",
12249 "title": "Example usage:",
12250 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
12254 "name": "GetQueues",
12255 "group": "Fax_Queues",
12256 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12257 "version": "0.0.0",
12258 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12259 "groupTitle": "Fax_Queues"
12263 "url": "/api/fax/queues/{id}/teams",
12264 "title": "Gets queues list",
12267 "title": "Example usage:",
12268 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
12272 "name": "GetTeams",
12273 "group": "Fax_Queues",
12274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12275 "version": "0.0.0",
12276 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12277 "groupTitle": "Fax_Queues"
12281 "url": "/api/fax/queues/{id}/users",
12282 "title": "Removes agents from a queue",
12285 "title": "Example usage:",
12286 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12290 "name": "RemoveAgents",
12291 "group": "Fax_Queues",
12292 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12293 "version": "0.0.0",
12294 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12295 "groupTitle": "Fax_Queues"
12299 "url": "/ShowFaxQueue",
12300 "title": "Gets a single Queue",
12301 "name": "ShowFaxQueue",
12302 "group": "Fax_Queues",
12310 "field": "options.attributes",
12317 "field": "options.where",
12323 "version": "0.0.0",
12324 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/faxQueue.rpc.js",
12325 "groupTitle": "Fax_Queues"
12329 "url": "/api/fax/queues/{id}",
12330 "title": "Gets a single Queue",
12333 "title": "Example usage:",
12334 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
12338 "name": "ShowQueues",
12339 "group": "Fax_Queues",
12340 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12341 "version": "0.0.0",
12342 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12343 "groupTitle": "Fax_Queues"
12347 "url": "/api/fax/queues/{id}",
12348 "title": "Update an existing Queue",
12351 "title": "Example usage:",
12352 "content": "curl https://{domain}/api/fax/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12356 "name": "updateQueues",
12357 "group": "Fax_Queues",
12358 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12359 "version": "0.0.0",
12360 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
12361 "groupTitle": "Fax_Queues"
12365 "url": "/api/fax/reports/transfer",
12366 "title": "Creates a new Fax Transfer Report",
12369 "title": "Example usage:",
12370 "content": "curl https://{domain}/api/fax/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12374 "name": "CreateFax_Transfer_Reports",
12375 "group": "Fax_Transfer_Reports",
12383 "field": "uniqueid",
12402 "field": "transferredAt",
12408 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12409 "version": "0.0.0",
12410 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxTransferReport/index.js",
12411 "groupTitle": "Fax_Transfer_Reports"
12415 "url": "/api/fax/reports/transfer/{id}",
12416 "title": "Deletes a Fax Transfer Report",
12419 "title": "Example usage:",
12420 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
12424 "name": "DeleteFax_Transfer_Reports",
12425 "group": "Fax_Transfer_Reports",
12426 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12427 "version": "0.0.0",
12428 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxTransferReport/index.js",
12429 "groupTitle": "Fax_Transfer_Reports"
12433 "url": "/api/fax/reports/transfer/describe",
12434 "title": "Gets table info about Fax Transfer Reports",
12437 "title": "Example usage:",
12438 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
12442 "name": "DescribeFax_Transfer_Reports",
12443 "group": "Fax_Transfer_Reports",
12444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12445 "version": "0.0.0",
12446 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxTransferReport/index.js",
12447 "groupTitle": "Fax_Transfer_Reports"
12451 "url": "/api/fax/reports/transfer",
12452 "title": "Gets a list of Fax Transfer Reports",
12455 "title": "Example usage:",
12456 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
12460 "name": "GetFax_Transfer_Reports",
12461 "group": "Fax_Transfer_Reports",
12462 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12463 "version": "0.0.0",
12464 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxTransferReport/index.js",
12465 "groupTitle": "Fax_Transfer_Reports"
12469 "url": "/api/fax/reports/transfer/{id}",
12470 "title": "Gets a single Fax Transfer Report",
12473 "title": "Example usage:",
12474 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12478 "name": "ShowFax_Transfer_Reports",
12479 "group": "Fax_Transfer_Reports",
12480 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12481 "version": "0.0.0",
12482 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxTransferReport/index.js",
12483 "groupTitle": "Fax_Transfer_Reports"
12487 "url": "/api/fax/reports/transfer/{id}",
12488 "title": "Update an existing Fax Transfer Report",
12491 "title": "Example usage:",
12492 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12496 "name": "updateFax_Transfer_Reports",
12497 "group": "Fax_Transfer_Reports",
12498 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12499 "version": "0.0.0",
12500 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxTransferReport/index.js",
12501 "groupTitle": "Fax_Transfer_Reports"
12505 "url": "/api/integrations/freshdesk/accounts",
12506 "title": "Creates a new Freshdesk Account",
12509 "title": "Example usage:",
12510 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12514 "name": "CreateFreshdesk_Accounts",
12515 "group": "Freshdesk_Accounts",
12530 "field": "description",
12537 "field": "username",
12551 "field": "remoteUri",
12558 "field": "serverUrl",
12564 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12565 "version": "0.0.0",
12566 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12567 "groupTitle": "Freshdesk_Accounts"
12571 "url": "/api/integrations/freshdesk/accounts/{id}",
12572 "title": "Deletes a Freshdesk Account",
12575 "title": "Example usage:",
12576 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12580 "name": "DeleteFreshdesk_Accounts",
12581 "group": "Freshdesk_Accounts",
12582 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12583 "version": "0.0.0",
12584 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12585 "groupTitle": "Freshdesk_Accounts"
12589 "url": "/GetFreshdeskAccount",
12590 "title": "Gets a list of Freshdesk Accounts",
12591 "name": "GetFreshdeskAccount",
12592 "group": "Freshdesk_Accounts",
12600 "field": "options.attributes",
12607 "field": "options.where",
12613 "version": "0.0.0",
12614 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/intFreshdeskAccount.rpc.js",
12615 "groupTitle": "Freshdesk_Accounts"
12619 "url": "/api/integrations/freshdesk/accounts",
12620 "title": "Gets a list of Freshdesk Accounts",
12623 "title": "Example usage:",
12624 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12628 "name": "GetFreshdesk_Accounts",
12629 "group": "Freshdesk_Accounts",
12630 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12631 "version": "0.0.0",
12632 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12633 "groupTitle": "Freshdesk_Accounts"
12637 "url": "/ShowFreshdeskAccount",
12638 "title": "Gets a single Freshdesk Account",
12639 "name": "ShowFreshdeskAccount",
12640 "group": "Freshdesk_Accounts",
12648 "field": "options.attributes",
12655 "field": "options.where",
12661 "version": "0.0.0",
12662 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/intFreshdeskAccount.rpc.js",
12663 "groupTitle": "Freshdesk_Accounts"
12667 "url": "/api/integrations/freshdesk/accounts/{id}",
12668 "title": "Gets a single Freshdesk Account",
12671 "title": "Example usage:",
12672 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12676 "name": "ShowFreshdesk_Accounts",
12677 "group": "Freshdesk_Accounts",
12678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12679 "version": "0.0.0",
12680 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12681 "groupTitle": "Freshdesk_Accounts"
12685 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12686 "title": "Creates new configuration",
12689 "title": "Example usage:",
12690 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12694 "name": "addConfiguration",
12695 "group": "Freshdesk_Accounts",
12696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12697 "version": "0.0.0",
12698 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12699 "groupTitle": "Freshdesk_Accounts"
12703 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12704 "title": "Gets account configurations",
12707 "title": "Example usage:",
12708 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12712 "name": "getConfigurations",
12713 "group": "Freshdesk_Accounts",
12714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12715 "version": "0.0.0",
12716 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12717 "groupTitle": "Freshdesk_Accounts"
12721 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12722 "title": "Gets account fields",
12725 "title": "Example usage:",
12726 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12730 "name": "getFields",
12731 "group": "Freshdesk_Accounts",
12732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12733 "version": "0.0.0",
12734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12735 "groupTitle": "Freshdesk_Accounts"
12739 "url": "/api/integrations/freshdesk/accounts/{id}",
12740 "title": "Update an existing Freshdesk Account",
12743 "title": "Example usage:",
12744 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12748 "name": "updateFreshdesk_Accounts",
12749 "group": "Freshdesk_Accounts",
12750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12751 "version": "0.0.0",
12752 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskAccount/index.js",
12753 "groupTitle": "Freshdesk_Accounts"
12757 "url": "/api/integrations/freshdesk/configurations",
12758 "title": "Creates a new Freshdesk Configuration",
12761 "title": "Example usage:",
12762 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12766 "name": "CreateFreshdesk_Configurations",
12767 "group": "Freshdesk_Configurations",
12782 "field": "description",
12788 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12789 "version": "0.0.0",
12790 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12791 "groupTitle": "Freshdesk_Configurations"
12795 "url": "/api/integrations/freshdesk/configurations/{id}",
12796 "title": "Deletes a Freshdesk Configuration",
12799 "title": "Example usage:",
12800 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12804 "name": "DeleteFreshdesk_Configurations",
12805 "group": "Freshdesk_Configurations",
12806 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12807 "version": "0.0.0",
12808 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12809 "groupTitle": "Freshdesk_Configurations"
12813 "url": "/api/integrations/freshdesk/configurations",
12814 "title": "Gets a list of Freshdesk Configurations",
12817 "title": "Example usage:",
12818 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12822 "name": "GetFreshdesk_Configurations",
12823 "group": "Freshdesk_Configurations",
12824 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12825 "version": "0.0.0",
12826 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12827 "groupTitle": "Freshdesk_Configurations"
12831 "url": "/api/integrations/freshdesk/configurations/{id}",
12832 "title": "Gets a single Freshdesk Configuration",
12835 "title": "Example usage:",
12836 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12840 "name": "ShowFreshdesk_Configurations",
12841 "group": "Freshdesk_Configurations",
12842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12843 "version": "0.0.0",
12844 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12845 "groupTitle": "Freshdesk_Configurations"
12849 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12850 "title": "Gets configurations descriptions",
12853 "title": "Example usage:",
12854 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12858 "name": "getDescriptions",
12859 "group": "Freshdesk_Configurations",
12860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12861 "version": "0.0.0",
12862 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12863 "groupTitle": "Freshdesk_Configurations"
12867 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12868 "title": "Gets configurations fields",
12871 "title": "Example usage:",
12872 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12876 "name": "getFields",
12877 "group": "Freshdesk_Configurations",
12878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12879 "version": "0.0.0",
12880 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12881 "groupTitle": "Freshdesk_Configurations"
12885 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12886 "title": "Gets configurations subjects",
12889 "title": "Example usage:",
12890 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12894 "name": "getSubjects",
12895 "group": "Freshdesk_Configurations",
12896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12897 "version": "0.0.0",
12898 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12899 "groupTitle": "Freshdesk_Configurations"
12903 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12904 "title": "Gets configurations tags",
12907 "title": "Example usage:",
12908 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12913 "group": "Freshdesk_Configurations",
12914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12915 "version": "0.0.0",
12916 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12917 "groupTitle": "Freshdesk_Configurations"
12921 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12922 "title": "Sets new tags",
12925 "title": "Example usage:",
12926 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12931 "group": "Freshdesk_Configurations",
12932 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12933 "version": "0.0.0",
12934 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12935 "groupTitle": "Freshdesk_Configurations"
12939 "url": "/api/integrations/freshdesk/configurations/{id}",
12940 "title": "Update an existing Freshdesk Configuration",
12943 "title": "Example usage:",
12944 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12948 "name": "updateFreshdesk_Configurations",
12949 "group": "Freshdesk_Configurations",
12950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12951 "version": "0.0.0",
12952 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskConfiguration/index.js",
12953 "groupTitle": "Freshdesk_Configurations"
12957 "url": "/api/integrations/freshdesk/fields",
12958 "title": "Creates a new Freshdesk Field",
12961 "title": "Example usage:",
12962 "content": "curl https://{domain}/api/integrations/freshdesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12966 "name": "CreateFreshdesk_Fields",
12967 "group": "Freshdesk_Fields",
12977 "\"customVariable\"",
12988 "field": "content",
13004 "\"customVariable\""
13007 "field": "keyType",
13014 "field": "keyContent",
13021 "field": "idField",
13028 "field": "nameField",
13035 "field": "customField",
13042 "field": "variableName",
13048 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13049 "version": "0.0.0",
13050 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskField/index.js",
13051 "groupTitle": "Freshdesk_Fields"
13055 "url": "/api/integrations/freshdesk/fields/{id}",
13056 "title": "Deletes a Freshdesk Field",
13059 "title": "Example usage:",
13060 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
13064 "name": "DeleteFreshdesk_Fields",
13065 "group": "Freshdesk_Fields",
13066 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13067 "version": "0.0.0",
13068 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskField/index.js",
13069 "groupTitle": "Freshdesk_Fields"
13073 "url": "/api/integrations/freshdesk/fields",
13074 "title": "Gets a list of Freshdesk Fields",
13077 "title": "Example usage:",
13078 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
13082 "name": "GetFreshdesk_Fields",
13083 "group": "Freshdesk_Fields",
13084 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13085 "version": "0.0.0",
13086 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskField/index.js",
13087 "groupTitle": "Freshdesk_Fields"
13091 "url": "/api/integrations/freshdesk/fields/{id}",
13092 "title": "Gets a single Freshdesk Field",
13095 "title": "Example usage:",
13096 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
13100 "name": "ShowFreshdesk_Fields",
13101 "group": "Freshdesk_Fields",
13102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13103 "version": "0.0.0",
13104 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskField/index.js",
13105 "groupTitle": "Freshdesk_Fields"
13109 "url": "/api/integrations/freshdesk/fields/{id}",
13110 "title": "Update an existing Freshdesk Field",
13113 "title": "Example usage:",
13114 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13118 "name": "updateFreshdesk_Fields",
13119 "group": "Freshdesk_Fields",
13120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13121 "version": "0.0.0",
13122 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshdeskField/index.js",
13123 "groupTitle": "Freshdesk_Fields"
13127 "url": "/api/integrations/freshsales/accounts",
13128 "title": "Creates a new Freshsales Account",
13131 "title": "Example usage:",
13132 "content": "curl https://{domain}/api/integrations/freshsales/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13136 "name": "CreateFreshsales_Accounts",
13137 "group": "Freshsales_Accounts",
13152 "field": "description",
13159 "field": "username",
13173 "field": "remoteUri",
13180 "field": "serverUrl",
13186 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13187 "version": "0.0.0",
13188 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13189 "groupTitle": "Freshsales_Accounts"
13193 "url": "/api/integrations/freshsales/accounts/{id}",
13194 "title": "Deletes a Freshsales Account",
13197 "title": "Example usage:",
13198 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
13202 "name": "DeleteFreshsales_Accounts",
13203 "group": "Freshsales_Accounts",
13204 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13205 "version": "0.0.0",
13206 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13207 "groupTitle": "Freshsales_Accounts"
13211 "url": "/GetFreshsalesAccount",
13212 "title": "Gets a list of Freshsales Accounts",
13213 "name": "GetFreshsalesAccount",
13214 "group": "Freshsales_Accounts",
13222 "field": "options.attributes",
13229 "field": "options.where",
13235 "version": "0.0.0",
13236 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/intFreshsalesAccount.rpc.js",
13237 "groupTitle": "Freshsales_Accounts"
13241 "url": "/api/integrations/freshsales/accounts",
13242 "title": "Gets a list of Freshsales Accounts",
13245 "title": "Example usage:",
13246 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
13250 "name": "GetFreshsales_Accounts",
13251 "group": "Freshsales_Accounts",
13252 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13253 "version": "0.0.0",
13254 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13255 "groupTitle": "Freshsales_Accounts"
13259 "url": "/ShowFreshsalesAccount",
13260 "title": "Gets a single Freshsales Account",
13261 "name": "ShowFreshsalesAccount",
13262 "group": "Freshsales_Accounts",
13270 "field": "options.attributes",
13277 "field": "options.where",
13283 "version": "0.0.0",
13284 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/intFreshsalesAccount.rpc.js",
13285 "groupTitle": "Freshsales_Accounts"
13289 "url": "/api/integrations/freshsales/accounts/{id}",
13290 "title": "Gets a single Freshsales Account",
13293 "title": "Example usage:",
13294 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
13298 "name": "ShowFreshsales_Accounts",
13299 "group": "Freshsales_Accounts",
13300 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13301 "version": "0.0.0",
13302 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13303 "groupTitle": "Freshsales_Accounts"
13307 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
13308 "title": "Creates new configuration",
13311 "title": "Example usage:",
13312 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13316 "name": "addConfiguration",
13317 "group": "Freshsales_Accounts",
13318 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13319 "version": "0.0.0",
13320 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13321 "groupTitle": "Freshsales_Accounts"
13325 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
13326 "title": "Gets account configurations",
13329 "title": "Example usage:",
13330 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
13334 "name": "getConfigurations",
13335 "group": "Freshsales_Accounts",
13336 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13337 "version": "0.0.0",
13338 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13339 "groupTitle": "Freshsales_Accounts"
13343 "url": "/api/integrations/freshsales/accounts/{id}/fields",
13344 "title": "Gets account fields",
13347 "title": "Example usage:",
13348 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
13352 "name": "getFields",
13353 "group": "Freshsales_Accounts",
13354 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13355 "version": "0.0.0",
13356 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13357 "groupTitle": "Freshsales_Accounts"
13361 "url": "/api/integrations/freshsales/accounts/{id}",
13362 "title": "Update an existing Freshsales Account",
13365 "title": "Example usage:",
13366 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13370 "name": "updateFreshsales_Accounts",
13371 "group": "Freshsales_Accounts",
13372 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13373 "version": "0.0.0",
13374 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesAccount/index.js",
13375 "groupTitle": "Freshsales_Accounts"
13379 "url": "/api/integrations/freshsales/configurations",
13380 "title": "Creates a new Freshsales Configuration",
13383 "title": "Example usage:",
13384 "content": "curl https://{domain}/api/integrations/freshsales/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13388 "name": "CreateFreshsales_Configurations",
13389 "group": "Freshsales_Configurations",
13404 "field": "description",
13410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13411 "version": "0.0.0",
13412 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13413 "groupTitle": "Freshsales_Configurations"
13417 "url": "/api/integrations/freshsales/configurations/{id}",
13418 "title": "Deletes a Freshsales Configuration",
13421 "title": "Example usage:",
13422 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
13426 "name": "DeleteFreshsales_Configurations",
13427 "group": "Freshsales_Configurations",
13428 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13429 "version": "0.0.0",
13430 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13431 "groupTitle": "Freshsales_Configurations"
13435 "url": "/api/integrations/freshsales/configurations",
13436 "title": "Gets a list of Freshsales Configurations",
13439 "title": "Example usage:",
13440 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
13444 "name": "GetFreshsales_Configurations",
13445 "group": "Freshsales_Configurations",
13446 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13447 "version": "0.0.0",
13448 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13449 "groupTitle": "Freshsales_Configurations"
13453 "url": "/api/integrations/freshsales/configurations/{id}",
13454 "title": "Gets a single Freshsales Configuration",
13457 "title": "Example usage:",
13458 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
13462 "name": "ShowFreshsales_Configurations",
13463 "group": "Freshsales_Configurations",
13464 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13465 "version": "0.0.0",
13466 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13467 "groupTitle": "Freshsales_Configurations"
13471 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
13472 "title": "Gets configurations descriptions",
13475 "title": "Example usage:",
13476 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
13480 "name": "getDescriptions",
13481 "group": "Freshsales_Configurations",
13482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13483 "version": "0.0.0",
13484 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13485 "groupTitle": "Freshsales_Configurations"
13489 "url": "/api/integrations/freshsales/configurations/{id}/fields",
13490 "title": "Gets configurations fields",
13493 "title": "Example usage:",
13494 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
13498 "name": "getFields",
13499 "group": "Freshsales_Configurations",
13500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13501 "version": "0.0.0",
13502 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13503 "groupTitle": "Freshsales_Configurations"
13507 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
13508 "title": "Gets configurations subjects",
13511 "title": "Example usage:",
13512 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
13516 "name": "getSubjects",
13517 "group": "Freshsales_Configurations",
13518 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13519 "version": "0.0.0",
13520 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13521 "groupTitle": "Freshsales_Configurations"
13525 "url": "/api/integrations/freshsales/configurations/{id}",
13526 "title": "Update an existing Freshsales Configuration",
13529 "title": "Example usage:",
13530 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13534 "name": "updateFreshsales_Configurations",
13535 "group": "Freshsales_Configurations",
13536 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13537 "version": "0.0.0",
13538 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesConfiguration/index.js",
13539 "groupTitle": "Freshsales_Configurations"
13543 "url": "/api/integrations/freshsales/fields",
13544 "title": "Creates a new Freshsales Field",
13547 "title": "Example usage:",
13548 "content": "curl https://{domain}/api/integrations/freshsales/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13552 "name": "CreateFreshsales_Fields",
13553 "group": "Freshsales_Fields",
13563 "\"customVariable\"",
13574 "field": "content",
13590 "\"customVariable\""
13593 "field": "keyType",
13600 "field": "keyContent",
13607 "field": "idField",
13614 "field": "nameField",
13621 "field": "customField",
13628 "field": "variableName",
13634 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13635 "version": "0.0.0",
13636 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesField/index.js",
13637 "groupTitle": "Freshsales_Fields"
13641 "url": "/api/integrations/freshsales/fields/{id}",
13642 "title": "Deletes a Freshsales Field",
13645 "title": "Example usage:",
13646 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13650 "name": "DeleteFreshsales_Fields",
13651 "group": "Freshsales_Fields",
13652 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13653 "version": "0.0.0",
13654 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesField/index.js",
13655 "groupTitle": "Freshsales_Fields"
13659 "url": "/api/integrations/freshsales/fields",
13660 "title": "Gets a list of Freshsales Fields",
13663 "title": "Example usage:",
13664 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13668 "name": "GetFreshsales_Fields",
13669 "group": "Freshsales_Fields",
13670 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13671 "version": "0.0.0",
13672 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesField/index.js",
13673 "groupTitle": "Freshsales_Fields"
13677 "url": "/api/integrations/freshsales/fields/{id}",
13678 "title": "Gets a single Freshsales Field",
13681 "title": "Example usage:",
13682 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13686 "name": "ShowFreshsales_Fields",
13687 "group": "Freshsales_Fields",
13688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13689 "version": "0.0.0",
13690 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesField/index.js",
13691 "groupTitle": "Freshsales_Fields"
13695 "url": "/api/integrations/freshsales/fields/{id}",
13696 "title": "Update an existing Freshsales Field",
13699 "title": "Example usage:",
13700 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13704 "name": "updateFreshsales_Fields",
13705 "group": "Freshsales_Fields",
13706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13707 "version": "0.0.0",
13708 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intFreshsalesField/index.js",
13709 "groupTitle": "Freshsales_Fields"
13713 "url": "/api/campaigns/{id}/blacklists",
13714 "title": "Add blacklists to an IVR campaign",
13717 "title": "Example usage:",
13718 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13722 "name": "AddBlackLists",
13723 "group": "IVR_Campaigns",
13724 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13725 "version": "0.0.0",
13726 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
13727 "groupTitle": "IVR_Campaigns"
13731 "url": "/api/campaigns/{id}/lists",
13732 "title": "Add lists to an IVR campaign",
13735 "title": "Example usage:",
13736 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13740 "name": "AddLists",
13741 "group": "IVR_Campaigns",
13742 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13743 "version": "0.0.0",
13744 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
13745 "groupTitle": "IVR_Campaigns"
13749 "url": "/api/campaigns/clone",
13750 "title": "Clone an existing IVR Campaign",
13753 "title": "Example usage:",
13754 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13758 "name": "CloneIVR_Campaigns",
13759 "group": "IVR_Campaigns",
13760 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13761 "version": "0.0.0",
13762 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
13763 "groupTitle": "IVR_Campaigns"
13767 "url": "/api/campaigns",
13768 "title": "Creates a new IVR Campaign",
13771 "title": "Example usage:",
13772 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13776 "name": "CreateIVR_Campaigns",
13777 "group": "IVR_Campaigns",
13802 "field": "description",
13810 "description": "<p>Active/Disactive Campaign</p>"
13816 "field": "limitCalls",
13817 "description": "<p>Max 200 calls.</p>"
13823 "field": "dialOriginateCallerIdName",
13830 "field": "dialOriginateCallerIdNumber",
13837 "field": "dialOriginateTimeout",
13838 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13844 "field": "dialCongestionMaxRetry",
13845 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13851 "field": "dialCongestionRetryFrequency",
13852 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13858 "field": "dialBusyMaxRetry",
13859 "description": "<p>#Busy Retry (min:1, max:999)</p>"
13865 "field": "dialBusyRetryFrequency",
13866 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13872 "field": "dialNoAnswerMaxRetry",
13873 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13879 "field": "dialNoAnswerRetryFrequency",
13880 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13886 "field": "dialGlobalMaxRetry",
13887 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13893 "field": "dialTimezone",
13900 "field": "dialGlobalInterval",
13912 "field": "dialCheckDuplicateType",
13919 "field": "dialAMDActive",
13920 "description": "<p>Active/Disactive AMD</p>"
13926 "field": "dialAMDInitialSilence",
13927 "description": "<p>#AMD Initial Silence</p>"
13933 "field": "dialAMDGreeting",
13934 "description": "<p>#AMD Greeting</p>"
13940 "field": "dialAMDAfterGreetingSilence",
13941 "description": "<p>#AMD After Greeting Silence</p>"
13947 "field": "dialAMDTotalAnalysisTime",
13948 "description": "<p>#AMD Total Analysis Time</p>"
13954 "field": "dialAMDMinWordLength",
13955 "description": "<p>#AMD Min Word Length</p>"
13961 "field": "dialAMDBetweenWordsSilence",
13962 "description": "<p>#AMD Between Words Silence</p>"
13968 "field": "dialAMDMaximumNumberOfWords",
13969 "description": "<p>#AMD Maximum Number Of Words</p>"
13975 "field": "dialAMDSilenceThreshold",
13976 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13982 "field": "dialAMDMaximumWordLength",
13983 "description": "<p>#AMD Maximum Word Length</p>"
13993 "field": "dialOrderByScheduledAt",
14000 "field": "dialPrefix",
14007 "field": "dialRandomLastDigitCallerIdNumber",
14008 "description": "<p>Random Last Digit (min:1, max:15)</p>"
14014 "field": "dialCutDigit",
14015 "description": "<p>Cut Digit (min:1, max:15)</p>"
14021 "field": "dialNoSuchNumberMaxRetry",
14022 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
14028 "field": "dialNoSuchNumberRetryFrequency",
14029 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
14035 "field": "dialDropMaxRetry",
14036 "description": "<p>#Drop Retry (min:1, max:999)</p>"
14042 "field": "dialDropRetryFrequency",
14043 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
14049 "field": "dialAbandonedMaxRetry",
14050 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
14056 "field": "dialAbandonedRetryFrequency",
14057 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
14063 "field": "dialMachineMaxRetry",
14064 "description": "<p>#Machine Retry (min:1, max:999)</p>"
14070 "field": "dialMachineRetryFrequency",
14071 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
14077 "field": "dialAgentRejectMaxRetry",
14078 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
14084 "field": "dialAgentRejectRetryFrequency",
14085 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
14090 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14091 "version": "0.0.0",
14092 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14093 "groupTitle": "IVR_Campaigns"
14097 "url": "/api/campaigns/{id}",
14098 "title": "Deletes a IVR Campaign",
14101 "title": "Example usage:",
14102 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
14106 "name": "DeleteIVR_Campaigns",
14107 "group": "IVR_Campaigns",
14108 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14109 "version": "0.0.0",
14110 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14111 "groupTitle": "IVR_Campaigns"
14115 "url": "/api/campaigns/{id}/blacklists",
14116 "title": "Get IVR campaign blacklists",
14119 "title": "Example usage:",
14120 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
14124 "name": "GetBlackLists",
14125 "group": "IVR_Campaigns",
14126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14127 "version": "0.0.0",
14128 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14129 "groupTitle": "IVR_Campaigns"
14133 "url": "/GetCampaign",
14134 "title": "Gets a list of IVR Campaigns",
14135 "name": "GetCampaign",
14136 "group": "IVR_Campaigns",
14144 "field": "options.attributes",
14151 "field": "options.where",
14157 "version": "0.0.0",
14158 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/campaign.rpc.js",
14159 "groupTitle": "IVR_Campaigns"
14163 "url": "/api/campaigns/{id}/finals",
14164 "title": "Gets IVR campaign hopper finals",
14167 "title": "Example usage:",
14168 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
14172 "name": "GetHopperFinals",
14173 "group": "IVR_Campaigns",
14174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14175 "version": "0.0.0",
14176 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14177 "groupTitle": "IVR_Campaigns"
14181 "url": "/api/campaigns/{id}/hopper_histories",
14182 "title": "Gets IVR campaign hopper histories",
14185 "title": "Example usage:",
14186 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
14190 "name": "GetHopperHistories",
14191 "group": "IVR_Campaigns",
14192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14193 "version": "0.0.0",
14194 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14195 "groupTitle": "IVR_Campaigns"
14199 "url": "/api/campaigns/{id}/hoppers",
14200 "title": "Gets IVR campaign hoppers",
14203 "title": "Example usage:",
14204 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
14208 "name": "GetHoppers",
14209 "group": "IVR_Campaigns",
14210 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14211 "version": "0.0.0",
14212 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14213 "groupTitle": "IVR_Campaigns"
14217 "url": "/api/campaigns",
14218 "title": "Gets a list of IVR Campaigns",
14221 "title": "Example usage:",
14222 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
14226 "name": "GetIVR_Campaigns",
14227 "group": "IVR_Campaigns",
14228 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/campaigns?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/campaigns?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/campaigns?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/campaigns?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/campaigns?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14229 "version": "0.0.0",
14230 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14231 "groupTitle": "IVR_Campaigns"
14235 "url": "/api/campaigns/{id}/lists",
14236 "title": "Get IVR campaign lists",
14239 "title": "Example usage:",
14240 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
14244 "name": "GetLists",
14245 "group": "IVR_Campaigns",
14246 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14247 "version": "0.0.0",
14248 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14249 "groupTitle": "IVR_Campaigns"
14253 "url": "/api/campaigns/{id}/blacklists",
14254 "title": "Remove blacklists from an IVR Campaign",
14257 "title": "Example usage:",
14258 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14262 "name": "RemoveBlackLists",
14263 "group": "IVR_Campaigns",
14264 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14265 "version": "0.0.0",
14266 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14267 "groupTitle": "IVR_Campaigns"
14271 "url": "/api/campaigns/{id}/lists",
14272 "title": "Remove lists from an IVR Campaign",
14275 "title": "Example usage:",
14276 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14280 "name": "RemoveLists",
14281 "group": "IVR_Campaigns",
14282 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14283 "version": "0.0.0",
14284 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14285 "groupTitle": "IVR_Campaigns"
14289 "url": "/api/campaigns/{id}",
14290 "title": "Gets a single IVR Campaign",
14293 "title": "Example usage:",
14294 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
14298 "name": "ShowIVR_Campaigns",
14299 "group": "IVR_Campaigns",
14300 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14301 "version": "0.0.0",
14302 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14303 "groupTitle": "IVR_Campaigns"
14307 "url": "/api/campaigns/{id}/blacks",
14308 "title": "Gets IVR campaign hopper blacks",
14311 "title": "Example usage:",
14312 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
14316 "name": "getHopperBlacks",
14317 "group": "IVR_Campaigns",
14318 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14319 "version": "0.0.0",
14320 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14321 "groupTitle": "IVR_Campaigns"
14325 "url": "/api/campaigns/{id}",
14326 "title": "Update an existing IVR Campaign",
14329 "title": "Example usage:",
14330 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14334 "name": "updateIVR_Campaigns",
14335 "group": "IVR_Campaigns",
14336 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14337 "version": "0.0.0",
14338 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/campaign/index.js",
14339 "groupTitle": "IVR_Campaigns"
14343 "url": "/api/integrations/reports",
14344 "title": "Creates a new Integration Report",
14347 "title": "Example usage:",
14348 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14352 "name": "CreateIntegration_Reports",
14353 "group": "Integration_Reports",
14361 "field": "integration",
14368 "field": "eventChannel",
14375 "field": "exitStatus",
14382 "field": "ticketId",
14389 "field": "integrationId",
14396 "field": "contacts",
14403 "field": "uniqueid",
14410 "field": "calleridnum",
14417 "field": "calleridname",
14431 "field": "interface",
14438 "field": "membername",
14445 "field": "agentcalledAt",
14452 "field": "agentconnectAt",
14459 "field": "holdtime",
14466 "field": "agentcomplete",
14473 "field": "agentcompleteAt",
14480 "field": "talktime",
14487 "field": "agentacw",
14494 "field": "acwtime",
14508 "field": "agentringnoanswer",
14515 "field": "agentringnoanswerAt",
14522 "field": "agentdump",
14529 "field": "agentdumpAt",
14536 "field": "lastevent",
14543 "field": "channel",
14550 "field": "channelstate",
14557 "field": "channelstatedesc",
14564 "field": "connectedlinenum",
14571 "field": "connectedlinename",
14578 "field": "language",
14585 "field": "accountcode",
14592 "field": "context",
14606 "field": "priority",
14613 "field": "destchannel",
14620 "field": "destchannelstate",
14627 "field": "destchannelstatedesc",
14634 "field": "destcalleridnum",
14641 "field": "destcalleridname",
14648 "field": "destconnectedlinenum",
14655 "field": "destconnectedlinename",
14662 "field": "destlanguage",
14669 "field": "destaccountcode",
14676 "field": "destcontext",
14683 "field": "destexten",
14690 "field": "destpriority",
14697 "field": "destuniqueid",
14704 "field": "messageId",
14711 "field": "inReplyTo",
14718 "field": "subject",
14746 "field": "attachment",
14794 "field": "appdata",
14801 "field": "projectId",
14807 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14808 "version": "0.0.0",
14809 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/integrationReport/index.js",
14810 "groupTitle": "Integration_Reports"
14814 "url": "/api/integrations/reports/{id}",
14815 "title": "Deletes a Integration Report",
14818 "title": "Example usage:",
14819 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14823 "name": "DeleteIntegration_Reports",
14824 "group": "Integration_Reports",
14825 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14826 "version": "0.0.0",
14827 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/integrationReport/index.js",
14828 "groupTitle": "Integration_Reports"
14832 "url": "/api/integrations/reports/describe",
14833 "title": "Gets table info about Integration Reports",
14836 "title": "Example usage:",
14837 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14841 "name": "DescribeIntegration_Reports",
14842 "group": "Integration_Reports",
14843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14844 "version": "0.0.0",
14845 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/integrationReport/index.js",
14846 "groupTitle": "Integration_Reports"
14850 "url": "/api/integrations/reports",
14851 "title": "Gets a list of Integration Reports",
14854 "title": "Example usage:",
14855 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14859 "name": "GetIntegration_Reports",
14860 "group": "Integration_Reports",
14861 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14862 "version": "0.0.0",
14863 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/integrationReport/index.js",
14864 "groupTitle": "Integration_Reports"
14868 "url": "/api/integrations/reports/{id}",
14869 "title": "Gets a single Integration Report",
14872 "title": "Example usage:",
14873 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14877 "name": "ShowIntegration_Reports",
14878 "group": "Integration_Reports",
14879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14880 "version": "0.0.0",
14881 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/integrationReport/index.js",
14882 "groupTitle": "Integration_Reports"
14886 "url": "/api/integrations/reports/{id}",
14887 "title": "Update an existing Integration Report",
14890 "title": "Example usage:",
14891 "content": "curl https://{domain}/api/integrations/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14895 "name": "updateIntegration_Reports",
14896 "group": "Integration_Reports",
14897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14898 "version": "0.0.0",
14899 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/integrationReport/index.js",
14900 "groupTitle": "Integration_Reports"
14904 "url": "/api/intervals",
14905 "title": "Creates a new Interval",
14908 "title": "Example usage:",
14909 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14913 "name": "CreateIntervals",
14914 "group": "Intervals",
14929 "field": "description",
14936 "field": "interval",
14942 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14943 "version": "0.0.0",
14944 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
14945 "groupTitle": "Intervals"
14949 "url": "/api/intervals/{id}",
14950 "title": "Deletes a Interval",
14953 "title": "Example usage:",
14954 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14958 "name": "DeleteIntervals",
14959 "group": "Intervals",
14960 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14961 "version": "0.0.0",
14962 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
14963 "groupTitle": "Intervals"
14967 "url": "/GetInterval",
14968 "title": "Gets a list of Intervals",
14969 "name": "GetInterval",
14970 "group": "Intervals",
14978 "field": "options.attributes",
14985 "field": "options.where",
14991 "version": "0.0.0",
14992 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/interval.rpc.js",
14993 "groupTitle": "Intervals"
14997 "url": "/api/intervals",
14998 "title": "Gets a list of Intervals",
15001 "title": "Example usage:",
15002 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
15006 "name": "GetIntervals",
15007 "group": "Intervals",
15008 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/intervals?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/intervals?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/intervals?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/intervals?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/intervals?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15009 "version": "0.0.0",
15010 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
15011 "groupTitle": "Intervals"
15015 "url": "/ShowInterval",
15016 "title": "Gets a single Interval",
15017 "name": "ShowInterval",
15018 "group": "Intervals",
15026 "field": "options.attributes",
15033 "field": "options.where",
15039 "version": "0.0.0",
15040 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/interval.rpc.js",
15041 "groupTitle": "Intervals"
15045 "url": "/api/intervals/{id}",
15046 "title": "Gets a single Interval",
15049 "title": "Example usage:",
15050 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
15054 "name": "ShowIntervals",
15055 "group": "Intervals",
15056 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15057 "version": "0.0.0",
15058 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
15059 "groupTitle": "Intervals"
15063 "url": "/api/intervals/{id}/sub_intervals",
15064 "title": "Creates a new sub interval",
15067 "title": "Example usage:",
15068 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -d '{\"interval\": \"00:00-08:30,mon-fri,*,*\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15072 "name": "addInterval",
15073 "group": "Intervals",
15074 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15075 "version": "0.0.0",
15076 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
15077 "groupTitle": "Intervals"
15081 "url": "/api/intervals/{id}/sub_intervals/create_many",
15082 "title": "Create new sub intervals set",
15085 "title": "Example usage:",
15086 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15090 "name": "addIntervals",
15091 "group": "Intervals",
15092 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15093 "version": "0.0.0",
15094 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
15095 "groupTitle": "Intervals"
15099 "url": "/api/intervals/{id}/sub_intervals",
15100 "title": "Get sub intervals set",
15103 "title": "Example usage:",
15104 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
15108 "name": "getIntervals",
15109 "group": "Intervals",
15110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15111 "version": "0.0.0",
15112 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
15113 "groupTitle": "Intervals"
15117 "url": "/api/intervals/{id}",
15118 "title": "Update an existing Interval",
15121 "title": "Example usage:",
15122 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15126 "name": "updateIntervals",
15127 "group": "Intervals",
15128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15129 "version": "0.0.0",
15130 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/interval/index.js",
15131 "groupTitle": "Intervals"
15135 "url": "/api/jira",
15136 "title": "Creates a new issue",
15139 "title": "Example usage:",
15140 "content": "curl https://{domain}/api/jira -d '{\"key\": \"Bug\", \"description\": \"I can't do it!\"}' \\\n -H \"Content-Type: application/json\" -X POST -v -u {name}:{password}",
15144 "name": "Creates_Issue",
15156 "field": "issuetype",
15163 "field": "summary",
15170 "field": "description",
15176 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15177 "version": "0.0.0",
15178 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jira/index.js",
15179 "groupTitle": "Issue"
15183 "url": "/api/jscripty/answers/reports",
15184 "title": "Creates a new Report",
15187 "title": "Example usage:",
15188 "content": "curl https://{domain}/api/jscripty/answers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15192 "name": "CreateReports",
15193 "group": "JscriptyAnswerReport",
15201 "field": "question",
15215 "field": "membername",
15222 "field": "projectname",
15236 "field": "uniqueid",
15243 "field": "calleridname",
15250 "field": "calleridnum",
15257 "field": "questionId",
15263 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15264 "version": "0.0.0",
15265 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyAnswerReport/index.js",
15266 "groupTitle": "JscriptyAnswerReport"
15270 "url": "/api/jscripty/answers/reports/{id}",
15271 "title": "Deletes a Report",
15274 "title": "Example usage:",
15275 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
15279 "name": "DeleteReports",
15280 "group": "JscriptyAnswerReport",
15281 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15282 "version": "0.0.0",
15283 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyAnswerReport/index.js",
15284 "groupTitle": "JscriptyAnswerReport"
15288 "url": "/api/jscripty/answers/reports/describe",
15289 "title": "Gets table info about Reports",
15292 "title": "Example usage:",
15293 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
15297 "name": "DescribeReports",
15298 "group": "JscriptyAnswerReport",
15299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15300 "version": "0.0.0",
15301 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyAnswerReport/index.js",
15302 "groupTitle": "JscriptyAnswerReport"
15306 "url": "/api/jscripty/answers/reports",
15307 "title": "Gets a list of Reports",
15310 "title": "Example usage:",
15311 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
15315 "name": "GetReports",
15316 "group": "JscriptyAnswerReport",
15317 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/answers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/answers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/answers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/answers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/answers/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15318 "version": "0.0.0",
15319 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyAnswerReport/index.js",
15320 "groupTitle": "JscriptyAnswerReport"
15324 "url": "/api/jscripty/answers/reports/{id}",
15325 "title": "Gets a single Report",
15328 "title": "Example usage:",
15329 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
15333 "name": "ShowReports",
15334 "group": "JscriptyAnswerReport",
15335 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15336 "version": "0.0.0",
15337 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyAnswerReport/index.js",
15338 "groupTitle": "JscriptyAnswerReport"
15342 "url": "/api/jscripty/answers/reports/{id}",
15343 "title": "Update an existing Report",
15346 "title": "Example usage:",
15347 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15351 "name": "updateReports",
15352 "group": "JscriptyAnswerReport",
15353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15354 "version": "0.0.0",
15355 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyAnswerReport/index.js",
15356 "groupTitle": "JscriptyAnswerReport"
15360 "url": "/api/jscripty/questions/reports",
15361 "title": "Creates a new Report",
15364 "title": "Example usage:",
15365 "content": "curl https://{domain}/api/jscripty/questions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15369 "name": "CreateReports",
15370 "group": "JscriptyQuestionReport",
15378 "field": "question",
15392 "field": "membername",
15399 "field": "projectname",
15413 "field": "uniqueid",
15420 "field": "calleridname",
15427 "field": "calleridnum",
15434 "field": "questionId",
15440 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15441 "version": "0.0.0",
15442 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyQuestionReport/index.js",
15443 "groupTitle": "JscriptyQuestionReport"
15447 "url": "/api/jscripty/questions/reports/{id}",
15448 "title": "Deletes a Report",
15451 "title": "Example usage:",
15452 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
15456 "name": "DeleteReports",
15457 "group": "JscriptyQuestionReport",
15458 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15459 "version": "0.0.0",
15460 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyQuestionReport/index.js",
15461 "groupTitle": "JscriptyQuestionReport"
15465 "url": "/api/jscripty/questions/reports/describe",
15466 "title": "Gets table info about Reports",
15469 "title": "Example usage:",
15470 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
15474 "name": "DescribeReports",
15475 "group": "JscriptyQuestionReport",
15476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15477 "version": "0.0.0",
15478 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyQuestionReport/index.js",
15479 "groupTitle": "JscriptyQuestionReport"
15483 "url": "/api/jscripty/questions/reports",
15484 "title": "Gets a list of Reports",
15487 "title": "Example usage:",
15488 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
15492 "name": "GetReports",
15493 "group": "JscriptyQuestionReport",
15494 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/questions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/questions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/questions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/questions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/questions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15495 "version": "0.0.0",
15496 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyQuestionReport/index.js",
15497 "groupTitle": "JscriptyQuestionReport"
15501 "url": "/api/jscripty/questions/reports/{id}",
15502 "title": "Gets a single Report",
15505 "title": "Example usage:",
15506 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
15510 "name": "ShowReports",
15511 "group": "JscriptyQuestionReport",
15512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15513 "version": "0.0.0",
15514 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyQuestionReport/index.js",
15515 "groupTitle": "JscriptyQuestionReport"
15519 "url": "/api/jscripty/questions/reports/{id}",
15520 "title": "Update an existing Report",
15523 "title": "Example usage:",
15524 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15528 "name": "updateReports",
15529 "group": "JscriptyQuestionReport",
15530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15531 "version": "0.0.0",
15532 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyQuestionReport/index.js",
15533 "groupTitle": "JscriptyQuestionReport"
15537 "url": "/api/jscripty/sessions/reports",
15538 "title": "Creates a new Report",
15541 "title": "Example usage:",
15542 "content": "curl https://{domain}/api/jscripty/sessions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15546 "name": "CreateReports",
15547 "group": "JscriptySessionReport",
15555 "field": "starttime",
15562 "field": "endtime",
15569 "field": "membername",
15576 "field": "projectname",
15590 "field": "uniqueid",
15597 "field": "calleridname",
15604 "field": "calleridnum",
15611 "field": "completed",
15617 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15618 "version": "0.0.0",
15619 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15620 "groupTitle": "JscriptySessionReport"
15624 "url": "/api/jscripty/sessions/reports/{id}",
15625 "title": "Deletes a Report",
15628 "title": "Example usage:",
15629 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
15633 "name": "DeleteReports",
15634 "group": "JscriptySessionReport",
15635 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15636 "version": "0.0.0",
15637 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15638 "groupTitle": "JscriptySessionReport"
15642 "url": "/api/jscripty/sessions/reports/describe",
15643 "title": "Gets table info about Reports",
15646 "title": "Example usage:",
15647 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
15651 "name": "DescribeReports",
15652 "group": "JscriptySessionReport",
15653 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15654 "version": "0.0.0",
15655 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15656 "groupTitle": "JscriptySessionReport"
15660 "url": "/api/jscripty/sessions/reports",
15661 "title": "Gets a list of Reports",
15664 "title": "Example usage:",
15665 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
15669 "name": "GetReports",
15670 "group": "JscriptySessionReport",
15671 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/sessions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/sessions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15672 "version": "0.0.0",
15673 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15674 "groupTitle": "JscriptySessionReport"
15678 "url": "/api/jscripty/sessions/reports/{id}",
15679 "title": "Gets a single Report",
15682 "title": "Example usage:",
15683 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15687 "name": "ShowReports",
15688 "group": "JscriptySessionReport",
15689 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15690 "version": "0.0.0",
15691 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15692 "groupTitle": "JscriptySessionReport"
15696 "url": "/api/jscripty/sessions/reports/{id}/questions",
15697 "title": "Gets Jscripty Session questions",
15700 "title": "Example usage:",
15701 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
15705 "name": "getQuestions",
15706 "group": "JscriptySessionReport",
15707 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15708 "version": "0.0.0",
15709 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15710 "groupTitle": "JscriptySessionReport"
15714 "url": "/api/jscripty/sessions/reports/{id}",
15715 "title": "Update an existing Report",
15718 "title": "Example usage:",
15719 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15723 "name": "updateReports",
15724 "group": "JscriptySessionReport",
15725 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15726 "version": "0.0.0",
15727 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptySessionReport/index.js",
15728 "groupTitle": "JscriptySessionReport"
15732 "url": "/api/jscripty/projects/clone",
15733 "title": "Clone an existing Project",
15736 "title": "Example usage:",
15737 "content": "curl https://{domain}/api/jscripty/projects/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15741 "name": "CloneProjects",
15742 "group": "Jscripty_Projects",
15743 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15744 "version": "0.0.0",
15745 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15746 "groupTitle": "Jscripty_Projects"
15750 "url": "/api/jscripty/projects",
15751 "title": "Creates a new Project",
15754 "title": "Example usage:",
15755 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15759 "name": "CreateProjects",
15760 "group": "Jscripty_Projects",
15775 "field": "description",
15782 "field": "formData",
15789 "field": "enableUncompleteSave",
15796 "field": "sendUnpauseOnSubmit",
15802 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15803 "version": "0.0.0",
15804 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15805 "groupTitle": "Jscripty_Projects"
15809 "url": "/api/jscripty/projects/{id}",
15810 "title": "Deletes a Project",
15813 "title": "Example usage:",
15814 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15818 "name": "DeleteProjects",
15819 "group": "Jscripty_Projects",
15820 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15821 "version": "0.0.0",
15822 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15823 "groupTitle": "Jscripty_Projects"
15827 "url": "/api/jscripty/projects",
15828 "title": "Gets a list of Projects",
15831 "title": "Example usage:",
15832 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15836 "name": "GetProjects",
15837 "group": "Jscripty_Projects",
15838 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/projects?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15839 "version": "0.0.0",
15840 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15841 "groupTitle": "Jscripty_Projects"
15845 "url": "/api/jscripty/projects/{id}",
15846 "title": "Gets a single Project",
15849 "title": "Example usage:",
15850 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15854 "name": "ShowProjects",
15855 "group": "Jscripty_Projects",
15856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15857 "version": "0.0.0",
15858 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15859 "groupTitle": "Jscripty_Projects"
15863 "url": "/api/jscripty/projects/{id}/answers",
15864 "title": "Gets jscripty project answers",
15867 "title": "Example usage:",
15868 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
15872 "name": "getAnswers",
15873 "group": "Jscripty_Projects",
15874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15875 "version": "0.0.0",
15876 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15877 "groupTitle": "Jscripty_Projects"
15881 "url": "/api/jscripty/projects/{id}/sessions",
15882 "title": "Gets jscripty project sessions",
15885 "title": "Example usage:",
15886 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
15890 "name": "getSessions",
15891 "group": "Jscripty_Projects",
15892 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15893 "version": "0.0.0",
15894 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15895 "groupTitle": "Jscripty_Projects"
15899 "url": "/api/jscripty/projects/{id}/summary",
15900 "title": "Gets jscripty project summary",
15903 "title": "Example usage:",
15904 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
15908 "name": "getSummary",
15909 "group": "Jscripty_Projects",
15910 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15911 "version": "0.0.0",
15912 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15913 "groupTitle": "Jscripty_Projects"
15917 "url": "/api/jscripty/projects/{id}",
15918 "title": "Update an existing Project",
15921 "title": "Example usage:",
15922 "content": "curl https://{domain}/api/jscripty/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15926 "name": "updateProjects",
15927 "group": "Jscripty_Projects",
15928 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15929 "version": "0.0.0",
15930 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/jscriptyProject/index.js",
15931 "groupTitle": "Jscripty_Projects"
15935 "url": "/api/license",
15936 "title": "Gets License Info",
15939 "title": "Example usage:",
15940 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15945 "group": "License",
15946 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15947 "version": "0.0.0",
15948 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/license/index.js",
15949 "groupTitle": "License"
15953 "url": "/api/license/{id}",
15954 "title": "Update License Info",
15957 "title": "Example usage:",
15958 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15963 "group": "License",
15964 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15965 "version": "0.0.0",
15966 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/license/index.js",
15967 "groupTitle": "License"
15971 "url": "/api/mail/accounts/{id}/users",
15972 "title": "Add agents to a mail account",
15975 "title": "Example usage:",
15976 "content": "curl https://{domain}/api/mail/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15980 "name": "AddAgents",
15981 "group": "Mail_Accounts",
15982 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15983 "version": "0.0.0",
15984 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
15985 "groupTitle": "Mail_Accounts"
15989 "url": "/api/mail/accounts/{id}/in_servers",
15990 "title": "Creates a new IMAP server",
15993 "title": "Example usage:",
15994 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15999 "group": "Mail_Accounts",
16007 "field": "description",
16021 "field": "authentication",
16035 "field": "password",
16056 "field": "mailbox",
16063 "field": "connTimeout",
16070 "field": "authTimeout",
16077 "field": "service",
16083 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16084 "version": "0.0.0",
16085 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16086 "groupTitle": "Mail_Accounts"
16090 "url": "/api/mail/accounts/{id}/out_servers",
16091 "title": "Creates a new SMTP server",
16094 "title": "Example usage:",
16095 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16100 "group": "Mail_Accounts",
16108 "field": "description",
16150 "field": "service",
16157 "field": "authentication",
16163 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16164 "version": "0.0.0",
16165 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16166 "groupTitle": "Mail_Accounts"
16170 "url": "/api/mail/accounts/{id}",
16171 "title": "Deletes a mail account",
16174 "title": "Example usage:",
16175 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
16179 "name": "DeleteMailAccounts",
16180 "group": "Mail_Accounts",
16181 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16182 "version": "0.0.0",
16183 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16184 "groupTitle": "Mail_Accounts"
16188 "url": "/api/mail/accounts/describe",
16189 "title": "Gets table info about Accounts",
16192 "title": "Example usage:",
16193 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
16197 "name": "DescribeAccounts",
16198 "group": "Mail_Accounts",
16199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16200 "version": "0.0.0",
16201 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16202 "groupTitle": "Mail_Accounts"
16206 "url": "/api/mail/accounts",
16207 "title": "Gets a list of Accounts",
16210 "title": "Example usage:",
16211 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
16215 "name": "GetAccounts",
16216 "group": "Mail_Accounts",
16217 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16218 "version": "0.0.0",
16219 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16220 "groupTitle": "Mail_Accounts"
16224 "url": "/api/mail/accounts/{id}/users",
16225 "title": "Gets agents from mail account",
16228 "title": "Example usage:",
16229 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
16233 "name": "GetAgents",
16234 "group": "Mail_Accounts",
16235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16236 "version": "0.0.0",
16237 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16238 "groupTitle": "Mail_Accounts"
16242 "url": "/api/mail/accounts/{id}/in_servers",
16243 "title": "Gets account IMAP server",
16246 "title": "Example usage:",
16247 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
16252 "group": "Mail_Accounts",
16253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16254 "version": "0.0.0",
16255 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16256 "groupTitle": "Mail_Accounts"
16260 "url": "/GetMailAccount",
16261 "title": "Gets a list of Accounts",
16262 "name": "GetMailAccount",
16263 "group": "Mail_Accounts",
16271 "field": "options.attributes",
16278 "field": "options.where",
16284 "version": "0.0.0",
16285 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/mailAccount.rpc.js",
16286 "groupTitle": "Mail_Accounts"
16290 "url": "/api/mail/accounts/{id}/out_servers",
16291 "title": "Gets account SMTP server",
16294 "title": "Example usage:",
16295 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
16300 "group": "Mail_Accounts",
16301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16302 "version": "0.0.0",
16303 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16304 "groupTitle": "Mail_Accounts"
16308 "url": "/NotifyMailAccount",
16310 "name": "NotifyMailAccount",
16311 "group": "Mail_Accounts",
16312 "version": "0.0.0",
16313 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/mailAccount.rpc.js",
16314 "groupTitle": "Mail_Accounts"
16318 "url": "/api/mail/accounts/{id}/users",
16319 "title": "Removes agents from a mail account",
16322 "title": "Example usage:",
16323 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16327 "name": "RemoveAgents",
16328 "group": "Mail_Accounts",
16329 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16330 "version": "0.0.0",
16331 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16332 "groupTitle": "Mail_Accounts"
16336 "url": "/api/mail/accounts/{id}/canned_answers",
16337 "title": "Removes canned answers from account",
16340 "title": "Example usage:",
16341 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16345 "name": "RemoveAnswers",
16346 "group": "Mail_Accounts",
16347 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16348 "version": "0.0.0",
16349 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16350 "groupTitle": "Mail_Accounts"
16354 "url": "/api/mail/accounts/{id}/dispositions",
16355 "title": "Removes dispositions from account",
16358 "title": "Example usage:",
16359 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16363 "name": "RemoveDispositions",
16364 "group": "Mail_Accounts",
16365 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16366 "version": "0.0.0",
16367 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16368 "groupTitle": "Mail_Accounts"
16372 "url": "/api/mail/accounts/{id}/in_servers",
16373 "title": "Removes IMAP server from an account",
16376 "title": "Example usage:",
16377 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
16381 "name": "RemoveImmap",
16382 "group": "Mail_Accounts",
16383 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16384 "version": "0.0.0",
16385 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16386 "groupTitle": "Mail_Accounts"
16390 "url": "/api/mail/accounts/{id}/out_servers",
16391 "title": "Removes SMTP server from an account",
16394 "title": "Example usage:",
16395 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
16399 "name": "RemoveSmtp",
16400 "group": "Mail_Accounts",
16401 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16402 "version": "0.0.0",
16403 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16404 "groupTitle": "Mail_Accounts"
16408 "url": "/api/mail/accounts/{id}",
16409 "title": "Gets a single Account",
16412 "title": "Example usage:",
16413 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
16417 "name": "ShowAccounts",
16418 "group": "Mail_Accounts",
16419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16420 "version": "0.0.0",
16421 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16422 "groupTitle": "Mail_Accounts"
16426 "url": "/ShowMailAccount",
16427 "title": "Gets a single Account",
16428 "name": "ShowMailAccount",
16429 "group": "Mail_Accounts",
16437 "field": "options.attributes",
16444 "field": "options.where",
16450 "version": "0.0.0",
16451 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/mailAccount.rpc.js",
16452 "groupTitle": "Mail_Accounts"
16456 "url": "/api/mail/accounts/{id}/canned_answers",
16457 "title": "Creates new canned answer",
16460 "title": "Example usage:",
16461 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16465 "name": "addAnswer",
16466 "group": "Mail_Accounts",
16488 "field": "description",
16501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16502 "version": "0.0.0",
16503 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16504 "groupTitle": "Mail_Accounts"
16508 "url": "/api/mail/accounts/{id}/applications",
16509 "title": "Creates new applications",
16512 "title": "Example usage:",
16513 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16517 "name": "addApplications",
16518 "group": "Mail_Accounts",
16526 "field": "priority",
16540 "field": "appdata",
16547 "field": "description",
16554 "field": "interval",
16560 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16561 "version": "0.0.0",
16562 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16563 "groupTitle": "Mail_Accounts"
16567 "url": "/api/mail/accounts/{id}/dispositions",
16568 "title": "Creates new disposition",
16571 "title": "Example usage:",
16572 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16576 "name": "addDisposition",
16577 "group": "Mail_Accounts",
16604 "field": "description",
16610 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16611 "version": "0.0.0",
16612 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16613 "groupTitle": "Mail_Accounts"
16617 "url": "/api/mail/accounts/{id}/interactions",
16618 "title": "Creates new interactions",
16621 "title": "Example usage:",
16622 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -d '[{\"subject\": \"My printer is on fire!\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16626 "name": "addInteraction",
16627 "group": "Mail_Accounts",
16642 "field": "closedAt",
16649 "field": "disposition",
16656 "field": "secondDisposition",
16663 "field": "thirdDisposition",
16677 "field": "inReplyTo",
16698 "field": "subject",
16712 "field": "read1stAt",
16719 "field": "substatus",
16726 "field": "substatusAt",
16737 "field": "firstMsgDirection",
16744 "field": "lastMsgAt",
16755 "field": "lastMsgDirection",
16762 "field": "lastMsgBody",
16769 "field": "lastMsgText",
16775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16776 "version": "0.0.0",
16777 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16778 "groupTitle": "Mail_Accounts"
16782 "url": "/api/mail/accounts",
16783 "title": "Create a mail account",
16786 "title": "Example usage:",
16787 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16792 "group": "Mail_Accounts",
16793 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16794 "version": "0.0.0",
16795 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16796 "groupTitle": "Mail_Accounts"
16800 "url": "/api/mail/accounts/{id}/canned_answers",
16801 "title": "Gets account canned answers",
16804 "title": "Example usage:",
16805 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16809 "name": "getAnswers",
16810 "group": "Mail_Accounts",
16811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16812 "version": "0.0.0",
16813 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16814 "groupTitle": "Mail_Accounts"
16818 "url": "/api/mail/accounts/{id}/applications",
16819 "title": "Gets account applications",
16822 "title": "Example usage:",
16823 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16827 "name": "getApplications",
16828 "group": "Mail_Accounts",
16829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16830 "version": "0.0.0",
16831 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16832 "groupTitle": "Mail_Accounts"
16836 "url": "/api/mail/accounts/{id}/dispositions",
16837 "title": "Gets account dispositions",
16840 "title": "Example usage:",
16841 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16845 "name": "getDispositions",
16846 "group": "Mail_Accounts",
16847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16848 "version": "0.0.0",
16849 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16850 "groupTitle": "Mail_Accounts"
16854 "url": "/api/mail/accounts/{id}/interactions",
16855 "title": "Gets account interactions",
16858 "title": "Example usage:",
16859 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16863 "name": "getInteraction",
16864 "group": "Mail_Accounts",
16865 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16866 "version": "0.0.0",
16867 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16868 "groupTitle": "Mail_Accounts"
16872 "url": "/api/mail/accounts/{id}/messages",
16873 "title": "Gets account messages",
16876 "title": "Example usage:",
16877 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16881 "name": "getMessages",
16882 "group": "Mail_Accounts",
16883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16884 "version": "0.0.0",
16885 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16886 "groupTitle": "Mail_Accounts"
16890 "url": "/api/mail/accounts/{id}/send",
16891 "title": "Send new mail",
16894 "title": "Example usage:",
16895 "content": "curl https://{domain}/api/mail/accounts/{id}/send -d '{from: '\"John Doe\" <john.doe@xcally.com>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16899 "name": "sendMail",
16900 "group": "Mail_Accounts",
16901 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16902 "version": "0.0.0",
16903 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16904 "groupTitle": "Mail_Accounts"
16908 "url": "/api/mail/accounts/{id}",
16909 "title": "Update an existing Account",
16912 "title": "Example usage:",
16913 "content": "curl https://{domain}/api/mail/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16917 "name": "updateAccounts",
16918 "group": "Mail_Accounts",
16919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16920 "version": "0.0.0",
16921 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16922 "groupTitle": "Mail_Accounts"
16926 "url": "/api/mail/accounts/{id}/verify",
16927 "title": "Verify mail account",
16930 "title": "Example usage:",
16931 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16935 "name": "verifySmtp",
16936 "group": "Mail_Accounts",
16937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16938 "version": "0.0.0",
16939 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailAccount/index.js",
16940 "groupTitle": "Mail_Accounts"
16944 "url": "/api/mail/applications/{id}",
16945 "title": "Deletes a Application",
16948 "title": "Example usage:",
16949 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16953 "name": "DeleteApplications",
16954 "group": "Mail_Applications",
16955 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16956 "version": "0.0.0",
16957 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailApplication/index.js",
16958 "groupTitle": "Mail_Applications"
16962 "url": "/api/mail/applications/{id}",
16963 "title": "Gets a single Application",
16966 "title": "Example usage:",
16967 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16971 "name": "ShowApplications",
16972 "group": "Mail_Applications",
16973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16974 "version": "0.0.0",
16975 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailApplication/index.js",
16976 "groupTitle": "Mail_Applications"
16980 "url": "/UpdateMailApplication",
16981 "title": "Updates a new Application",
16982 "name": "UpdateMailApplication",
16983 "group": "Mail_Applications",
16991 "field": "options.attributes",
16998 "field": "options.where",
17004 "version": "0.0.0",
17005 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailApplication/mailApplication.rpc.js",
17006 "groupTitle": "Mail_Applications"
17010 "url": "/api/mail/applications/{id}",
17011 "title": "Update an existing Application",
17014 "title": "Example usage:",
17015 "content": "curl https://{domain}/api/mail/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17019 "name": "updateApplications",
17020 "group": "Mail_Applications",
17021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17022 "version": "0.0.0",
17023 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailApplication/index.js",
17024 "groupTitle": "Mail_Applications"
17028 "url": "/GetMailServerIn",
17029 "title": "Gets a list of IMAPs",
17030 "name": "GetMailServerIn",
17031 "group": "Mail_IMAP",
17039 "field": "options.attributes",
17046 "field": "options.where",
17052 "version": "0.0.0",
17053 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailServerIn/mailServerIn.rpc.js",
17054 "groupTitle": "Mail_IMAP"
17058 "url": "/api/mail/interactions/{id}/tags",
17059 "title": "Add tags to the interaction",
17062 "title": "Example usage:",
17063 "content": "curl https://{domain}/api/mail/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17068 "group": "Mail_Interactions",
17069 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17070 "version": "0.0.0",
17071 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17072 "groupTitle": "Mail_Interactions"
17076 "url": "/AddTagsToMailInteraction",
17077 "title": "Add Tags to Mail interaction",
17078 "name": "AddTagsToMailInteraction",
17079 "group": "Mail_Interactions",
17087 "field": "options.attributes",
17094 "field": "options.where",
17100 "version": "0.0.0",
17101 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/mailInteraction.rpc.js",
17102 "groupTitle": "Mail_Interactions"
17106 "url": "/api/mail/interactions",
17107 "title": "Creates a new Interaction",
17110 "title": "Example usage:",
17111 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17115 "name": "CreateInteractions",
17116 "group": "Mail_Interactions",
17131 "field": "closedAt",
17138 "field": "disposition",
17145 "field": "secondDisposition",
17152 "field": "thirdDisposition",
17166 "field": "inReplyTo",
17187 "field": "subject",
17201 "field": "read1stAt",
17208 "field": "substatus",
17215 "field": "substatusAt",
17226 "field": "firstMsgDirection",
17233 "field": "lastMsgAt",
17244 "field": "lastMsgDirection",
17251 "field": "lastMsgBody",
17258 "field": "lastMsgText",
17264 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17265 "version": "0.0.0",
17266 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17267 "groupTitle": "Mail_Interactions"
17271 "url": "/api/mail/interactions/{id}",
17272 "title": "Deletes a Interaction",
17275 "title": "Example usage:",
17276 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
17280 "name": "DeleteInteractions",
17281 "group": "Mail_Interactions",
17282 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17283 "version": "0.0.0",
17284 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17285 "groupTitle": "Mail_Interactions"
17289 "url": "/api/mail/interactions/describe",
17290 "title": "Gets table info about Interactions",
17293 "title": "Example usage:",
17294 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
17298 "name": "DescribeInteractions",
17299 "group": "Mail_Interactions",
17300 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17301 "version": "0.0.0",
17302 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17303 "groupTitle": "Mail_Interactions"
17307 "url": "/api/mail/interactions",
17308 "title": "Gets a list of Interactions",
17311 "title": "Example usage:",
17312 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
17316 "name": "GetInteractions",
17317 "group": "Mail_Interactions",
17318 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17319 "version": "0.0.0",
17320 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17321 "groupTitle": "Mail_Interactions"
17325 "url": "/api/mail/interactions/{id}/tags",
17326 "title": "Removes tags from interaction",
17329 "title": "Example usage:",
17330 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17334 "name": "RemoveTags",
17335 "group": "Mail_Interactions",
17336 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17337 "version": "0.0.0",
17338 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17339 "groupTitle": "Mail_Interactions"
17343 "url": "/api/mail/interactions/{id}",
17344 "title": "Gets a single Interaction",
17347 "title": "Example usage:",
17348 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
17352 "name": "ShowInteractions",
17353 "group": "Mail_Interactions",
17354 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17355 "version": "0.0.0",
17356 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17357 "groupTitle": "Mail_Interactions"
17361 "url": "/UpdateMailInteraction",
17362 "title": "Updates a new Interaction",
17363 "name": "UpdateMailInteraction",
17364 "group": "Mail_Interactions",
17372 "field": "options.attributes",
17379 "field": "options.where",
17385 "version": "0.0.0",
17386 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/mailInteraction.rpc.js",
17387 "groupTitle": "Mail_Interactions"
17391 "url": "/api/mail/interactions/{id}/messages",
17392 "title": "Creates new message",
17395 "title": "Example usage:",
17396 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -d '[{\"to\": \"sales@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17400 "name": "addMessage",
17401 "group": "Mail_Interactions",
17416 "field": "plainBody",
17434 "field": "direction",
17441 "field": "messageId",
17476 "field": "subject",
17511 "field": "originTo",
17518 "field": "originCc",
17524 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17525 "version": "0.0.0",
17526 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17527 "groupTitle": "Mail_Interactions"
17531 "url": "/api/mail/interactions/{id}/download",
17532 "title": "Gets interaction",
17535 "title": "Example usage:",
17536 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
17540 "name": "download",
17541 "group": "Mail_Interactions",
17542 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17543 "version": "0.0.0",
17544 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17545 "groupTitle": "Mail_Interactions"
17549 "url": "/api/mail/interactions/{id}/messages",
17550 "title": "Gets interaction messages",
17553 "title": "Example usage:",
17554 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
17558 "name": "getMessages",
17559 "group": "Mail_Interactions",
17560 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17561 "version": "0.0.0",
17562 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17563 "groupTitle": "Mail_Interactions"
17567 "url": "/api/mail/interactions/{id}",
17568 "title": "Update an existing Interaction",
17571 "title": "Example usage:",
17572 "content": "curl https://{domain}/api/mail/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17576 "name": "updateInteractions",
17577 "group": "Mail_Interactions",
17578 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17579 "version": "0.0.0",
17580 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailInteraction/index.js",
17581 "groupTitle": "Mail_Interactions"
17585 "url": "/CreateMailMessage",
17586 "title": "Creates a new Message",
17587 "name": "CreateMailMessage",
17588 "group": "Mail_Messages",
17589 "version": "0.0.0",
17590 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/mailMessage.rpc.js",
17591 "groupTitle": "Mail_Messages"
17595 "url": "/api/mail/messages/{id}",
17596 "title": "Deletes a Message",
17599 "title": "Example usage:",
17600 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
17604 "name": "DeleteMessages",
17605 "group": "Mail_Messages",
17606 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17607 "version": "0.0.0",
17608 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17609 "groupTitle": "Mail_Messages"
17613 "url": "/api/mail/messages/describe",
17614 "title": "Gets table info about Messages",
17617 "title": "Example usage:",
17618 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
17622 "name": "DescribeMessages",
17623 "group": "Mail_Messages",
17624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17625 "version": "0.0.0",
17626 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17627 "groupTitle": "Mail_Messages"
17631 "url": "/api/mail/messages",
17632 "title": "Gets a list of Messages",
17635 "title": "Example usage:",
17636 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
17640 "name": "GetMessages",
17641 "group": "Mail_Messages",
17642 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17643 "version": "0.0.0",
17644 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17645 "groupTitle": "Mail_Messages"
17649 "url": "/api/mail/messages/{id}",
17650 "title": "Gets a single Message",
17653 "title": "Example usage:",
17654 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
17658 "name": "ShowMessages",
17659 "group": "Mail_Messages",
17660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17661 "version": "0.0.0",
17662 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17663 "groupTitle": "Mail_Messages"
17667 "url": "/api/mail/messages/{id}/accept",
17668 "title": "Accepts message",
17671 "title": "Example usage:",
17672 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17676 "name": "acceptMessage",
17677 "group": "Mail_Messages",
17678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17679 "version": "0.0.0",
17680 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17681 "groupTitle": "Mail_Messages"
17685 "url": "/api/mail/messages",
17686 "title": "Create a message",
17689 "title": "Example usage:",
17690 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17694 "name": "createMessage",
17695 "group": "Mail_Messages",
17696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17697 "version": "0.0.0",
17698 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17699 "groupTitle": "Mail_Messages"
17703 "url": "/api/mail/messages/{id}/download",
17704 "title": "Gets message",
17707 "title": "Example usage:",
17708 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
17712 "name": "download",
17713 "group": "Mail_Messages",
17714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17715 "version": "0.0.0",
17716 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17717 "groupTitle": "Mail_Messages"
17721 "url": "/api/mail/messages/{id}/reject",
17722 "title": "Rejects message",
17725 "title": "Example usage:",
17726 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17730 "name": "rejectMessage",
17731 "group": "Mail_Messages",
17732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17733 "version": "0.0.0",
17734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17735 "groupTitle": "Mail_Messages"
17739 "url": "/api/mail/messages/{id}",
17740 "title": "Update an existing Message",
17743 "title": "Example usage:",
17744 "content": "curl https://{domain}/api/mail/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17748 "name": "updateMessages",
17749 "group": "Mail_Messages",
17750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17751 "version": "0.0.0",
17752 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailMessage/index.js",
17753 "groupTitle": "Mail_Messages"
17757 "url": "/CreateMailQueueReport",
17758 "title": "Creates a new Mail Queue Report",
17759 "name": "CreateMailQueueReport",
17760 "group": "Mail_Queue_Reports",
17761 "version": "0.0.0",
17762 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/mailQueueReport.rpc.js",
17763 "groupTitle": "Mail_Queue_Reports"
17767 "url": "/api/mail/reports/queue",
17768 "title": "Creates a new Mail Queue Report",
17771 "title": "Example usage:",
17772 "content": "curl https://{domain}/api/mail/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17776 "name": "CreateMail_Queue_Reports",
17777 "group": "Mail_Queue_Reports",
17785 "field": "uniqueid",
17806 "field": "leaveAt",
17813 "field": "acceptAt",
17833 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17834 "version": "0.0.0",
17835 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/index.js",
17836 "groupTitle": "Mail_Queue_Reports"
17840 "url": "/api/mail/reports/queue/{id}",
17841 "title": "Deletes a Mail Queue Report",
17844 "title": "Example usage:",
17845 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
17849 "name": "DeleteMail_Queue_Reports",
17850 "group": "Mail_Queue_Reports",
17851 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17852 "version": "0.0.0",
17853 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/index.js",
17854 "groupTitle": "Mail_Queue_Reports"
17858 "url": "/api/mail/reports/queue/describe",
17859 "title": "Gets table info about Mail Queue Reports",
17862 "title": "Example usage:",
17863 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
17867 "name": "DescribeMail_Queue_Reports",
17868 "group": "Mail_Queue_Reports",
17869 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17870 "version": "0.0.0",
17871 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/index.js",
17872 "groupTitle": "Mail_Queue_Reports"
17876 "url": "/api/mail/reports/queue",
17877 "title": "Gets a list of Mail Queue Reports",
17880 "title": "Example usage:",
17881 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
17885 "name": "GetMail_Queue_Reports",
17886 "group": "Mail_Queue_Reports",
17887 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17888 "version": "0.0.0",
17889 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/index.js",
17890 "groupTitle": "Mail_Queue_Reports"
17894 "url": "/api/mail/reports/queue/{id}",
17895 "title": "Gets a single Mail Queue Report",
17898 "title": "Example usage:",
17899 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17903 "name": "ShowMail_Queue_Reports",
17904 "group": "Mail_Queue_Reports",
17905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17906 "version": "0.0.0",
17907 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/index.js",
17908 "groupTitle": "Mail_Queue_Reports"
17912 "url": "/UpdateMailQueueReport",
17913 "title": "Updates a new Mail Queue Report",
17914 "name": "UpdateMailQueueReport",
17915 "group": "Mail_Queue_Reports",
17923 "field": "options.attributes",
17930 "field": "options.where",
17936 "version": "0.0.0",
17937 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/mailQueueReport.rpc.js",
17938 "groupTitle": "Mail_Queue_Reports"
17942 "url": "/api/mail/reports/queue/{id}",
17943 "title": "Update an existing Mail Queue Report",
17946 "title": "Example usage:",
17947 "content": "curl https://{domain}/api/mail/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17951 "name": "updateMail_Queue_Reports",
17952 "group": "Mail_Queue_Reports",
17953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17954 "version": "0.0.0",
17955 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueueReport/index.js",
17956 "groupTitle": "Mail_Queue_Reports"
17960 "url": "/api/mail/queues/{id}/users",
17961 "title": "Add agents to a queue",
17964 "title": "Example usage:",
17965 "content": "curl https://{domain}/api/mail/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17969 "name": "AddAgents",
17970 "group": "Mail_Queues",
17971 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17972 "version": "0.0.0",
17973 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
17974 "groupTitle": "Mail_Queues"
17978 "url": "/api/mail/queues/{id}/teams",
17979 "title": "Add teams to a queue",
17982 "title": "Example usage:",
17983 "content": "curl https://{domain}/api/mail/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17987 "name": "AddTeams",
17988 "group": "Mail_Queues",
17989 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17990 "version": "0.0.0",
17991 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
17992 "groupTitle": "Mail_Queues"
17996 "url": "/api/mail/queues",
17997 "title": "Creates a new Queue",
18000 "title": "Example usage:",
18001 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18005 "name": "CreateQueues",
18006 "group": "Mail_Queues",
18021 "field": "description",
18028 "field": "timeout",
18040 "field": "strategy",
18046 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18047 "version": "0.0.0",
18048 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18049 "groupTitle": "Mail_Queues"
18053 "url": "/api/mail/queues/{id}",
18054 "title": "Deletes a Queue",
18057 "title": "Example usage:",
18058 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
18062 "name": "DeleteQueues",
18063 "group": "Mail_Queues",
18064 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18065 "version": "0.0.0",
18066 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18067 "groupTitle": "Mail_Queues"
18071 "url": "/api/mail/queues/describe",
18072 "title": "Gets table info about Queues",
18075 "title": "Example usage:",
18076 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
18080 "name": "DescribeQueues",
18081 "group": "Mail_Queues",
18082 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18083 "version": "0.0.0",
18084 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18085 "groupTitle": "Mail_Queues"
18089 "url": "/api/mail/queues/{id}/users",
18090 "title": "Gets queue agents",
18093 "title": "Example usage:",
18094 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
18098 "name": "GetAgents",
18099 "group": "Mail_Queues",
18100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18101 "version": "0.0.0",
18102 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18103 "groupTitle": "Mail_Queues"
18107 "url": "/GetMailQueue",
18108 "title": "Gets a list of Queues",
18109 "name": "GetMailQueue",
18110 "group": "Mail_Queues",
18118 "field": "options.attributes",
18125 "field": "options.where",
18131 "version": "0.0.0",
18132 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/mailQueue.rpc.js",
18133 "groupTitle": "Mail_Queues"
18137 "url": "/api/mail/queues/{id}/members",
18138 "title": "GetMembers",
18141 "title": "Example usage:",
18142 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
18146 "name": "GetMembers",
18147 "group": "Mail_Queues",
18148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18149 "version": "0.0.0",
18150 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18151 "groupTitle": "Mail_Queues"
18155 "url": "/api/mail/queues",
18156 "title": "Gets a list of Queues",
18159 "title": "Example usage:",
18160 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
18164 "name": "GetQueues",
18165 "group": "Mail_Queues",
18166 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18167 "version": "0.0.0",
18168 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18169 "groupTitle": "Mail_Queues"
18173 "url": "/api/mail/queues/{id}/teams",
18174 "title": "Gets queues list",
18177 "title": "Example usage:",
18178 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
18182 "name": "GetTeams",
18183 "group": "Mail_Queues",
18184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18185 "version": "0.0.0",
18186 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18187 "groupTitle": "Mail_Queues"
18191 "url": "/api/mail/queues/{id}/users",
18192 "title": "Removes agents from a queue",
18195 "title": "Example usage:",
18196 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18200 "name": "RemoveAgents",
18201 "group": "Mail_Queues",
18202 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18203 "version": "0.0.0",
18204 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18205 "groupTitle": "Mail_Queues"
18209 "url": "/ShowMailQueue",
18210 "title": "Gets a single Queue",
18211 "name": "ShowMailQueue",
18212 "group": "Mail_Queues",
18220 "field": "options.attributes",
18227 "field": "options.where",
18233 "version": "0.0.0",
18234 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/mailQueue.rpc.js",
18235 "groupTitle": "Mail_Queues"
18239 "url": "/api/mail/queues/{id}",
18240 "title": "Gets a single Queue",
18243 "title": "Example usage:",
18244 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
18248 "name": "ShowQueues",
18249 "group": "Mail_Queues",
18250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18251 "version": "0.0.0",
18252 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18253 "groupTitle": "Mail_Queues"
18257 "url": "/api/mail/queues/{id}",
18258 "title": "Update an existing Queue",
18261 "title": "Example usage:",
18262 "content": "curl https://{domain}/api/mail/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18266 "name": "updateQueues",
18267 "group": "Mail_Queues",
18268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18269 "version": "0.0.0",
18270 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
18271 "groupTitle": "Mail_Queues"
18275 "url": "/api/mail/out_servers",
18276 "title": "Creates a new SMTP",
18279 "title": "Example usage:",
18280 "content": "curl https://{domain}/api/mail/out_servers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18284 "name": "CreateSMTPs",
18285 "group": "Mail_SMTP",
18293 "field": "description",
18335 "field": "service",
18342 "field": "authentication",
18348 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18349 "version": "0.0.0",
18350 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailServerOut/index.js",
18351 "groupTitle": "Mail_SMTP"
18355 "url": "/api/mail/out_servers/{id}",
18356 "title": "Deletes a SMTP",
18359 "title": "Example usage:",
18360 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
18364 "name": "DeleteSMTPs",
18365 "group": "Mail_SMTP",
18366 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18367 "version": "0.0.0",
18368 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailServerOut/index.js",
18369 "groupTitle": "Mail_SMTP"
18373 "url": "/api/mail/out_servers",
18374 "title": "Gets a list of SMTPs",
18377 "title": "Example usage:",
18378 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
18382 "name": "GetSMTPs",
18383 "group": "Mail_SMTP",
18384 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/out_servers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/out_servers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/out_servers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/out_servers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/out_servers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18385 "version": "0.0.0",
18386 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailServerOut/index.js",
18387 "groupTitle": "Mail_SMTP"
18391 "url": "/api/mail/out_servers/{id}",
18392 "title": "Gets a single SMTP",
18395 "title": "Example usage:",
18396 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
18400 "name": "ShowSMTPs",
18401 "group": "Mail_SMTP",
18402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18403 "version": "0.0.0",
18404 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailServerOut/index.js",
18405 "groupTitle": "Mail_SMTP"
18409 "url": "/api/mail/out_servers/{id}",
18410 "title": "Update an existing SMTP",
18413 "title": "Example usage:",
18414 "content": "curl https://{domain}/api/mail/out_servers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18418 "name": "updateSMTPs",
18419 "group": "Mail_SMTP",
18420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18421 "version": "0.0.0",
18422 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailServerOut/index.js",
18423 "groupTitle": "Mail_SMTP"
18427 "url": "/api/mail/substatuses",
18428 "title": "Creates a new Queue",
18431 "title": "Example usage:",
18432 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18436 "name": "CreateSubstatuses",
18437 "group": "Mail_Substatuses",
18452 "field": "description",
18458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18459 "version": "0.0.0",
18460 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailSubstatus/index.js",
18461 "groupTitle": "Mail_Substatuses"
18465 "url": "/api/mail/substatuses/{id}",
18466 "title": "Deletes a Queue",
18469 "title": "Example usage:",
18470 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
18474 "name": "DeleteSubstatuses",
18475 "group": "Mail_Substatuses",
18476 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18477 "version": "0.0.0",
18478 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailSubstatus/index.js",
18479 "groupTitle": "Mail_Substatuses"
18483 "url": "/api/mail/substatuses/describe",
18484 "title": "Gets table info about Substatuses",
18487 "title": "Example usage:",
18488 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
18492 "name": "DescribeSubstatuses",
18493 "group": "Mail_Substatuses",
18494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18495 "version": "0.0.0",
18496 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailSubstatus/index.js",
18497 "groupTitle": "Mail_Substatuses"
18501 "url": "/api/mail/substatuses",
18502 "title": "Gets a list of Substatuses",
18505 "title": "Example usage:",
18506 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
18510 "name": "GetSubstatuses",
18511 "group": "Mail_Substatuses",
18512 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/substatuses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/substatuses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/substatuses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/substatuses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/substatuses?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18513 "version": "0.0.0",
18514 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailSubstatus/index.js",
18515 "groupTitle": "Mail_Substatuses"
18519 "url": "/api/mail/substatuses/{id}",
18520 "title": "Gets a single Queue",
18523 "title": "Example usage:",
18524 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
18528 "name": "ShowSubstatuses",
18529 "group": "Mail_Substatuses",
18530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18531 "version": "0.0.0",
18532 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailSubstatus/index.js",
18533 "groupTitle": "Mail_Substatuses"
18537 "url": "/api/mail/substatuses/{id}",
18538 "title": "Update an existing Queue",
18541 "title": "Example usage:",
18542 "content": "curl https://{domain}/api/mail/substatuses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18546 "name": "updateSubstatuses",
18547 "group": "Mail_Substatuses",
18548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18549 "version": "0.0.0",
18550 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailSubstatus/index.js",
18551 "groupTitle": "Mail_Substatuses"
18555 "url": "/api/mail/reports/transfer",
18556 "title": "Creates a new Mail Transfer Report",
18559 "title": "Example usage:",
18560 "content": "curl https://{domain}/api/mail/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18564 "name": "CreateMail_Transfer_Reports",
18565 "group": "Mail_Transfer_Reports",
18573 "field": "uniqueid",
18592 "field": "transferredAt",
18598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18599 "version": "0.0.0",
18600 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailTransferReport/index.js",
18601 "groupTitle": "Mail_Transfer_Reports"
18605 "url": "/api/mail/reports/transfer/{id}",
18606 "title": "Deletes a Mail Transfer Report",
18609 "title": "Example usage:",
18610 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18614 "name": "DeleteMail_Transfer_Reports",
18615 "group": "Mail_Transfer_Reports",
18616 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18617 "version": "0.0.0",
18618 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailTransferReport/index.js",
18619 "groupTitle": "Mail_Transfer_Reports"
18623 "url": "/api/mail/reports/transfer/describe",
18624 "title": "Gets table info about Mail Transfer Reports",
18627 "title": "Example usage:",
18628 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
18632 "name": "DescribeMail_Transfer_Reports",
18633 "group": "Mail_Transfer_Reports",
18634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18635 "version": "0.0.0",
18636 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailTransferReport/index.js",
18637 "groupTitle": "Mail_Transfer_Reports"
18641 "url": "/api/mail/reports/transfer",
18642 "title": "Gets a list of Mail Transfer Reports",
18645 "title": "Example usage:",
18646 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
18650 "name": "GetMail_Transfer_Reports",
18651 "group": "Mail_Transfer_Reports",
18652 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18653 "version": "0.0.0",
18654 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailTransferReport/index.js",
18655 "groupTitle": "Mail_Transfer_Reports"
18659 "url": "/api/mail/reports/transfer/{id}",
18660 "title": "Gets a single Mail Transfer Report",
18663 "title": "Example usage:",
18664 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
18668 "name": "ShowMail_Transfer_Reports",
18669 "group": "Mail_Transfer_Reports",
18670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18671 "version": "0.0.0",
18672 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailTransferReport/index.js",
18673 "groupTitle": "Mail_Transfer_Reports"
18677 "url": "/api/mail/reports/transfer/{id}",
18678 "title": "Update an existing Mail Transfer Report",
18681 "title": "Example usage:",
18682 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18686 "name": "updateMail_Transfer_Reports",
18687 "group": "Mail_Transfer_Reports",
18688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18689 "version": "0.0.0",
18690 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailTransferReport/index.js",
18691 "groupTitle": "Mail_Transfer_Reports"
18695 "url": "/CreateMemberReport",
18696 "title": "Creates a new Member Report",
18697 "name": "CreateMemberReport",
18698 "group": "Member_Reports",
18699 "version": "0.0.0",
18700 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/memberReport/memberReport.rpc.js",
18701 "groupTitle": "Member_Reports"
18705 "url": "/api/members/reports/describe",
18706 "title": "Gets table info about Member Reports",
18709 "title": "Example usage:",
18710 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
18714 "name": "DescribeMember_Reports",
18715 "group": "Member_Reports",
18716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18717 "version": "0.0.0",
18718 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/memberReport/index.js",
18719 "groupTitle": "Member_Reports"
18723 "url": "/GetMemberReport",
18724 "title": "Gets a list of Member Reports",
18725 "name": "GetMemberReport",
18726 "group": "Member_Reports",
18734 "field": "options.attributes",
18741 "field": "options.where",
18747 "version": "0.0.0",
18748 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/memberReport/memberReport.rpc.js",
18749 "groupTitle": "Member_Reports"
18753 "url": "/api/members/reports",
18754 "title": "Gets a list of Member Reports",
18757 "title": "Example usage:",
18758 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
18762 "name": "GetMember_Reports",
18763 "group": "Member_Reports",
18764 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/members/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/members/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/members/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/members/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/members/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18765 "version": "0.0.0",
18766 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/memberReport/index.js",
18767 "groupTitle": "Member_Reports"
18771 "url": "/api/members/reports/{id}",
18772 "title": "Gets a single Member Report",
18775 "title": "Example usage:",
18776 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
18780 "name": "ShowMember_Reports",
18781 "group": "Member_Reports",
18782 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18783 "version": "0.0.0",
18784 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/memberReport/index.js",
18785 "groupTitle": "Member_Reports"
18789 "url": "/UpdateMemberReport",
18790 "title": "Updates a new Member Report",
18791 "name": "UpdateMemberReport",
18792 "group": "Member_Reports",
18800 "field": "options.attributes",
18807 "field": "options.where",
18813 "version": "0.0.0",
18814 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/memberReport/memberReport.rpc.js",
18815 "groupTitle": "Member_Reports"
18819 "url": "/api/migrations",
18820 "title": "Gets a list of Migrations",
18823 "title": "Example usage:",
18824 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
18828 "name": "GetMigrations",
18829 "group": "Migrations",
18830 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/migrations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/migrations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/migrations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/migrations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/migrations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18831 "version": "0.0.0",
18832 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/migration/index.js",
18833 "groupTitle": "Migrations"
18837 "url": "/api/voice/networks",
18838 "title": "Create a new network",
18841 "title": "Example usage:",
18842 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18847 "group": "Networks",
18848 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18849 "version": "0.0.0",
18850 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/network/index.js",
18851 "groupTitle": "Networks"
18855 "url": "/api/voice/networks/{id}",
18856 "title": "Deletes a network",
18859 "title": "Example usage:",
18860 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
18865 "group": "Networks",
18866 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18867 "version": "0.0.0",
18868 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/network/index.js",
18869 "groupTitle": "Networks"
18873 "url": "/api/networks",
18874 "title": "Gets a list of Networks",
18877 "title": "Example usage:",
18878 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
18882 "name": "GetNetworks",
18883 "group": "Networks",
18884 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/networks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/networks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/networks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/networks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/networks?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18885 "version": "0.0.0",
18886 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/network/index.js",
18887 "groupTitle": "Networks"
18891 "url": "/api/networks/{id}",
18892 "title": "Gets a single Network",
18895 "title": "Example usage:",
18896 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
18900 "name": "ShowNetworks",
18901 "group": "Networks",
18902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18903 "version": "0.0.0",
18904 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/network/index.js",
18905 "groupTitle": "Networks"
18909 "url": "/api/voice/networks/{id}",
18910 "title": "Update an existing network",
18913 "title": "Example usage:",
18914 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
18919 "group": "Networks",
18920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18921 "version": "0.0.0",
18922 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/network/index.js",
18923 "groupTitle": "Networks"
18927 "url": "/api/notifications",
18928 "title": "Send notification to user",
18931 "title": "Example usage:",
18932 "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18937 "group": "Notifications",
18938 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18939 "version": "0.0.0",
18940 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/notification/index.js",
18941 "groupTitle": "Notifications"
18945 "url": "/api/openchannel/accounts/{id}/users",
18946 "title": "Add agents to a openchannel account",
18949 "title": "Example usage:",
18950 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18954 "name": "AddAgents",
18955 "group": "Openchannel_Accounts",
18956 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18957 "version": "0.0.0",
18958 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
18959 "groupTitle": "Openchannel_Accounts"
18963 "url": "/api/openchannel/accounts",
18964 "title": "Creates a new Account",
18967 "title": "Example usage:",
18968 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18972 "name": "CreateAccounts",
18973 "group": "Openchannel_Accounts",
18988 "field": "description",
19002 "field": "replyUri",
19016 "field": "notificationTemplate",
19023 "field": "notificationSound",
19030 "field": "notificationShake",
19037 "field": "waitForTheAssignedAgent",
19051 "field": "queueTransfer",
19058 "field": "queueTransferTimeout",
19065 "field": "agentTransfer",
19072 "field": "agentTransferTimeout",
19079 "field": "mandatoryDispositionPauseId",
19080 "description": "<p>Status to put when mandatory disposition is enabled</p>"
19086 "field": "mandatoryDisposition",
19087 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
19092 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19093 "version": "0.0.0",
19094 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19095 "groupTitle": "Openchannel_Accounts"
19099 "url": "/api/openchannel/accounts/{id}",
19100 "title": "Deletes a Account",
19103 "title": "Example usage:",
19104 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
19108 "name": "DeleteAccounts",
19109 "group": "Openchannel_Accounts",
19110 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19111 "version": "0.0.0",
19112 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19113 "groupTitle": "Openchannel_Accounts"
19117 "url": "/api/openchannel/accounts/describe",
19118 "title": "Gets table info about Accounts",
19121 "title": "Example usage:",
19122 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
19126 "name": "DescribeAccounts",
19127 "group": "Openchannel_Accounts",
19128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19129 "version": "0.0.0",
19130 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19131 "groupTitle": "Openchannel_Accounts"
19135 "url": "/api/openchannel/accounts",
19136 "title": "Gets a list of Accounts",
19139 "title": "Example usage:",
19140 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
19144 "name": "GetAccounts",
19145 "group": "Openchannel_Accounts",
19146 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19147 "version": "0.0.0",
19148 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19149 "groupTitle": "Openchannel_Accounts"
19153 "url": "/api/openchannel/accounts/{id}/users",
19154 "title": "Gets agents from openchannel account",
19157 "title": "Example usage:",
19158 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
19162 "name": "GetAgents",
19163 "group": "Openchannel_Accounts",
19164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19165 "version": "0.0.0",
19166 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19167 "groupTitle": "Openchannel_Accounts"
19171 "url": "/api/openchannel/accounts/{id}/users",
19172 "title": "Removes agents from a openchannel account",
19175 "title": "Example usage:",
19176 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19180 "name": "RemoveAgents",
19181 "group": "Openchannel_Accounts",
19182 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19183 "version": "0.0.0",
19184 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19185 "groupTitle": "Openchannel_Accounts"
19189 "url": "/api/openchannel/accounts/{id}/canned_answers",
19190 "title": "Removes canned answers from account",
19193 "title": "Example usage:",
19194 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19198 "name": "RemoveAnswers",
19199 "group": "Openchannel_Accounts",
19200 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19201 "version": "0.0.0",
19202 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19203 "groupTitle": "Openchannel_Accounts"
19207 "url": "/api/openchannel/accounts/{id}/dispositions",
19208 "title": "Removes dispositions from account",
19211 "title": "Example usage:",
19212 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19216 "name": "RemoveDispositions",
19217 "group": "Openchannel_Accounts",
19218 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19219 "version": "0.0.0",
19220 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19221 "groupTitle": "Openchannel_Accounts"
19225 "url": "/api/openchannel/accounts/{id}",
19226 "title": "Gets a single Account",
19229 "title": "Example usage:",
19230 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
19234 "name": "ShowAccounts",
19235 "group": "Openchannel_Accounts",
19236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19237 "version": "0.0.0",
19238 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19239 "groupTitle": "Openchannel_Accounts"
19243 "url": "/api/openchannel/accounts/{id}/canned_answers",
19244 "title": "Creates new canned answer",
19247 "title": "Example usage:",
19248 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19252 "name": "addAnswer",
19253 "group": "Openchannel_Accounts",
19275 "field": "description",
19288 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19289 "version": "0.0.0",
19290 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19291 "groupTitle": "Openchannel_Accounts"
19295 "url": "/api/openchannel/accounts/{id}/applications",
19296 "title": "Creates new applications",
19299 "title": "Example usage:",
19300 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19304 "name": "addApplications",
19305 "group": "Openchannel_Accounts",
19313 "field": "priority",
19327 "field": "appdata",
19334 "field": "description",
19341 "field": "interval",
19347 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19348 "version": "0.0.0",
19349 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19350 "groupTitle": "Openchannel_Accounts"
19354 "url": "/api/openchannel/accounts/{id}/dispositions",
19355 "title": "Creates new disposition",
19358 "title": "Example usage:",
19359 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19363 "name": "addDisposition",
19364 "group": "Openchannel_Accounts",
19391 "field": "description",
19397 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19398 "version": "0.0.0",
19399 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19400 "groupTitle": "Openchannel_Accounts"
19404 "url": "/api/openchannel/accounts/{id}/canned_answers",
19405 "title": "Gets account canned answers",
19408 "title": "Example usage:",
19409 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
19413 "name": "getAnswers",
19414 "group": "Openchannel_Accounts",
19415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19416 "version": "0.0.0",
19417 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19418 "groupTitle": "Openchannel_Accounts"
19422 "url": "/api/openchannel/accounts/{id}/applications",
19423 "title": "Gets account applications",
19426 "title": "Example usage:",
19427 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
19431 "name": "getApplications",
19432 "group": "Openchannel_Accounts",
19433 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19434 "version": "0.0.0",
19435 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19436 "groupTitle": "Openchannel_Accounts"
19440 "url": "/api/openchannel/accounts/{id}/dispositions",
19441 "title": "Gets account dispositions",
19444 "title": "Example usage:",
19445 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
19449 "name": "getDispositions",
19450 "group": "Openchannel_Accounts",
19451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19452 "version": "0.0.0",
19453 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19454 "groupTitle": "Openchannel_Accounts"
19458 "url": "/api/openchannel/accounts/{id}/interactions",
19459 "title": "Gets Openchannel Account Interactions",
19462 "title": "Example usage:",
19463 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
19467 "name": "getInteractions",
19468 "group": "Openchannel_Accounts",
19469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19470 "version": "0.0.0",
19471 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19472 "groupTitle": "Openchannel_Accounts"
19476 "url": "/api/openchannel/accounts/{id}/notify",
19477 "title": "Notify new message",
19480 "title": "Example usage:",
19481 "content": "curl https://{domain}/api/openchannel/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19486 "group": "Openchannel_Accounts",
19487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",
19488 "version": "0.0.0",
19489 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19490 "groupTitle": "Openchannel_Accounts"
19494 "url": "/api/openchannel/accounts/{id}/send",
19495 "title": "Send new openchannel message",
19498 "title": "Example usage:",
19499 "content": "curl https://{domain}/api/openchannel/accounts/{id}/send -d '{from: 'John Doe', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19503 "name": "sendOpenchannel",
19504 "group": "Openchannel_Accounts",
19505 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19506 "version": "0.0.0",
19507 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19508 "groupTitle": "Openchannel_Accounts"
19512 "url": "/api/openchannel/accounts/{id}",
19513 "title": "Update an existing Account",
19516 "title": "Example usage:",
19517 "content": "curl https://{domain}/api/openchannel/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19521 "name": "updateAccounts",
19522 "group": "Openchannel_Accounts",
19523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19524 "version": "0.0.0",
19525 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelAccount/index.js",
19526 "groupTitle": "Openchannel_Accounts"
19530 "url": "/api/openchannel/applications",
19531 "title": "Creates a new Application",
19534 "title": "Example usage:",
19535 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19539 "name": "CreateApplications",
19540 "group": "Openchannel_Applications",
19548 "field": "priority",
19562 "field": "appdata",
19569 "field": "description",
19576 "field": "interval",
19582 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19583 "version": "0.0.0",
19584 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelApplication/index.js",
19585 "groupTitle": "Openchannel_Applications"
19589 "url": "/api/openchannel/applications/{id}",
19590 "title": "Deletes a Application",
19593 "title": "Example usage:",
19594 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
19598 "name": "DeleteApplications",
19599 "group": "Openchannel_Applications",
19600 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19601 "version": "0.0.0",
19602 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelApplication/index.js",
19603 "groupTitle": "Openchannel_Applications"
19607 "url": "/api/openchannel/applications",
19608 "title": "Gets a list of Applications",
19611 "title": "Example usage:",
19612 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
19616 "name": "GetApplications",
19617 "group": "Openchannel_Applications",
19618 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19619 "version": "0.0.0",
19620 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelApplication/index.js",
19621 "groupTitle": "Openchannel_Applications"
19625 "url": "/api/openchannel/applications/{id}",
19626 "title": "Gets a single Application",
19629 "title": "Example usage:",
19630 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
19634 "name": "ShowApplications",
19635 "group": "Openchannel_Applications",
19636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19637 "version": "0.0.0",
19638 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelApplication/index.js",
19639 "groupTitle": "Openchannel_Applications"
19643 "url": "/UpdateOpenchannelApplication",
19644 "title": "Updates a new Application",
19645 "name": "UpdateOpenchannelApplication",
19646 "group": "Openchannel_Applications",
19654 "field": "options.attributes",
19661 "field": "options.where",
19667 "version": "0.0.0",
19668 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelApplication/openchannelApplication.rpc.js",
19669 "groupTitle": "Openchannel_Applications"
19673 "url": "/api/openchannel/applications/{id}",
19674 "title": "Update an existing Application",
19677 "title": "Example usage:",
19678 "content": "curl https://{domain}/api/openchannel/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19682 "name": "updateApplications",
19683 "group": "Openchannel_Applications",
19684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19685 "version": "0.0.0",
19686 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelApplication/index.js",
19687 "groupTitle": "Openchannel_Applications"
19691 "url": "/api/openchannel/interactions/{id}/tags",
19692 "title": "Add tags to the interaction",
19695 "title": "Example usage:",
19696 "content": "curl https://{domain}/api/openchannel/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19701 "group": "Openchannel_Interactions",
19702 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19703 "version": "0.0.0",
19704 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19705 "groupTitle": "Openchannel_Interactions"
19709 "url": "/AddTagsToOpenchannelInteraction",
19710 "title": "Add Tags to Openchannel interaction",
19711 "name": "AddTagsToOpenchannelInteraction",
19712 "group": "Openchannel_Interactions",
19720 "field": "options.attributes",
19727 "field": "options.where",
19733 "version": "0.0.0",
19734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/openchannelInteraction.rpc.js",
19735 "groupTitle": "Openchannel_Interactions"
19739 "url": "/api/openchannel/interactions",
19740 "title": "Creates a new Interaction",
19743 "title": "Example usage:",
19744 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19748 "name": "CreateInteractions",
19749 "group": "Openchannel_Interactions",
19764 "field": "closedAt",
19771 "field": "disposition",
19778 "field": "secondDisposition",
19785 "field": "thirdDisposition",
19799 "field": "read1stAt",
19806 "field": "threadId",
19813 "field": "externalUrl",
19820 "field": "lastMsgAt",
19831 "field": "lastMsgDirection",
19844 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19845 "version": "0.0.0",
19846 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19847 "groupTitle": "Openchannel_Interactions"
19851 "url": "/api/openchannel/interactions/{id}",
19852 "title": "Deletes a Interaction",
19855 "title": "Example usage:",
19856 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
19860 "name": "DeleteInteractions",
19861 "group": "Openchannel_Interactions",
19862 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19863 "version": "0.0.0",
19864 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19865 "groupTitle": "Openchannel_Interactions"
19869 "url": "/api/openchannel/interactions/describe",
19870 "title": "Gets table info about Interactions",
19873 "title": "Example usage:",
19874 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
19878 "name": "DescribeInteractions",
19879 "group": "Openchannel_Interactions",
19880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19881 "version": "0.0.0",
19882 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19883 "groupTitle": "Openchannel_Interactions"
19887 "url": "/api/openchannel/interactions",
19888 "title": "Gets a list of Interactions",
19891 "title": "Example usage:",
19892 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
19896 "name": "GetInteractions",
19897 "group": "Openchannel_Interactions",
19898 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19899 "version": "0.0.0",
19900 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19901 "groupTitle": "Openchannel_Interactions"
19905 "url": "/api/openchannel/interactions/{id}/tags",
19906 "title": "Removes tags from interaction",
19909 "title": "Example usage:",
19910 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19914 "name": "RemoveTags",
19915 "group": "Openchannel_Interactions",
19916 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19917 "version": "0.0.0",
19918 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19919 "groupTitle": "Openchannel_Interactions"
19923 "url": "/api/openchannel/interactions/{id}",
19924 "title": "Gets a single Interaction",
19927 "title": "Example usage:",
19928 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
19932 "name": "ShowInteractions",
19933 "group": "Openchannel_Interactions",
19934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19935 "version": "0.0.0",
19936 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
19937 "groupTitle": "Openchannel_Interactions"
19941 "url": "/UpdateOpenchannelInteraction",
19942 "title": "Updates a new Interaction",
19943 "name": "UpdateOpenchannelInteraction",
19944 "group": "Openchannel_Interactions",
19952 "field": "options.attributes",
19959 "field": "options.where",
19965 "version": "0.0.0",
19966 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/openchannelInteraction.rpc.js",
19967 "groupTitle": "Openchannel_Interactions"
19971 "url": "/api/openchannel/interactions/{id}/messages",
19972 "title": "Creates new messages",
19975 "title": "Example usage:",
19976 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19980 "name": "addMessage",
19981 "group": "Openchannel_Interactions",
20014 "field": "direction",
20028 "field": "providerName",
20035 "field": "providerResponse",
20041 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20042 "version": "0.0.0",
20043 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
20044 "groupTitle": "Openchannel_Interactions"
20048 "url": "/api/openchannel/interactions/{id}/download",
20049 "title": "Gets interaction",
20052 "title": "Example usage:",
20053 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
20057 "name": "download",
20058 "group": "Openchannel_Interactions",
20059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20060 "version": "0.0.0",
20061 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
20062 "groupTitle": "Openchannel_Interactions"
20066 "url": "/api/openchannel/interactions/{id}/messages",
20067 "title": "Gets interaction messages",
20070 "title": "Example usage:",
20071 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
20075 "name": "getMessages",
20076 "group": "Openchannel_Interactions",
20077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20078 "version": "0.0.0",
20079 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
20080 "groupTitle": "Openchannel_Interactions"
20084 "url": "/api/openchannel/interactions/{id}",
20085 "title": "Update an existing Interaction",
20088 "title": "Example usage:",
20089 "content": "curl https://{domain}/api/openchannel/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20093 "name": "updateInteractions",
20094 "group": "Openchannel_Interactions",
20095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20096 "version": "0.0.0",
20097 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelInteraction/index.js",
20098 "groupTitle": "Openchannel_Interactions"
20102 "url": "/api/openchannel/messages",
20103 "title": "Creates a new Message",
20106 "title": "Example usage:",
20107 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20111 "name": "CreateMessages",
20112 "group": "Openchannel_Messages",
20145 "field": "direction",
20159 "field": "providerName",
20166 "field": "providerResponse",
20172 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20173 "version": "0.0.0",
20174 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20175 "groupTitle": "Openchannel_Messages"
20179 "url": "/CreateOpenchannelMessage",
20180 "title": "Creates a new Message",
20181 "name": "CreateOpenchannelMessage",
20182 "group": "Openchannel_Messages",
20183 "version": "0.0.0",
20184 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/openchannelMessage.rpc.js",
20185 "groupTitle": "Openchannel_Messages"
20189 "url": "/api/openchannel/messages/{id}",
20190 "title": "Deletes a Message",
20193 "title": "Example usage:",
20194 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
20198 "name": "DeleteMessages",
20199 "group": "Openchannel_Messages",
20200 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20201 "version": "0.0.0",
20202 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20203 "groupTitle": "Openchannel_Messages"
20207 "url": "/api/openchannel/messages/describe",
20208 "title": "Gets table info about Messages",
20211 "title": "Example usage:",
20212 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
20216 "name": "DescribeMessages",
20217 "group": "Openchannel_Messages",
20218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20219 "version": "0.0.0",
20220 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20221 "groupTitle": "Openchannel_Messages"
20225 "url": "/api/openchannel/messages",
20226 "title": "Gets a list of Messages",
20229 "title": "Example usage:",
20230 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
20234 "name": "GetMessages",
20235 "group": "Openchannel_Messages",
20236 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20237 "version": "0.0.0",
20238 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20239 "groupTitle": "Openchannel_Messages"
20243 "url": "/api/openchannel/messages/{id}",
20244 "title": "Gets a single Message",
20247 "title": "Example usage:",
20248 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
20252 "name": "ShowMessages",
20253 "group": "Openchannel_Messages",
20254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20255 "version": "0.0.0",
20256 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20257 "groupTitle": "Openchannel_Messages"
20261 "url": "/api/openchannel/messages/{id}/accept",
20262 "title": "Accepts message",
20265 "title": "Example usage:",
20266 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
20270 "name": "acceptMessage",
20271 "group": "Openchannel_Messages",
20272 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20273 "version": "0.0.0",
20274 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20275 "groupTitle": "Openchannel_Messages"
20279 "url": "/api/openchannel/messages/{id}/reject",
20280 "title": "Rejects message",
20283 "title": "Example usage:",
20284 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
20288 "name": "rejectMessage",
20289 "group": "Openchannel_Messages",
20290 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20291 "version": "0.0.0",
20292 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20293 "groupTitle": "Openchannel_Messages"
20297 "url": "/api/openchannel/messages/{id}",
20298 "title": "Update an existing Message",
20301 "title": "Example usage:",
20302 "content": "curl https://{domain}/api/openchannel/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20306 "name": "updateMessages",
20307 "group": "Openchannel_Messages",
20308 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20309 "version": "0.0.0",
20310 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelMessage/index.js",
20311 "groupTitle": "Openchannel_Messages"
20315 "url": "/CreateOpenchannelQueueReport",
20316 "title": "Creates a new Openchannel Queue Report",
20317 "name": "CreateOpenchannelQueueReport",
20318 "group": "Openchannel_Queue_Reports",
20319 "version": "0.0.0",
20320 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/openchannelQueueReport.rpc.js",
20321 "groupTitle": "Openchannel_Queue_Reports"
20325 "url": "/api/openchannel/reports/queue",
20326 "title": "Creates a new Openchannel Queue Report",
20329 "title": "Example usage:",
20330 "content": "curl https://{domain}/api/openchannel/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20334 "name": "CreateOpenchannel_Queue_Reports",
20335 "group": "Openchannel_Queue_Reports",
20343 "field": "uniqueid",
20364 "field": "leaveAt",
20371 "field": "acceptAt",
20391 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20392 "version": "0.0.0",
20393 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/index.js",
20394 "groupTitle": "Openchannel_Queue_Reports"
20398 "url": "/api/openchannel/reports/queue/{id}",
20399 "title": "Deletes a Openchannel Queue Report",
20402 "title": "Example usage:",
20403 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
20407 "name": "DeleteOpenchannel_Queue_Reports",
20408 "group": "Openchannel_Queue_Reports",
20409 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20410 "version": "0.0.0",
20411 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/index.js",
20412 "groupTitle": "Openchannel_Queue_Reports"
20416 "url": "/api/openchannel/reports/queue/describe",
20417 "title": "Gets table info about Openchannel Queue Reports",
20420 "title": "Example usage:",
20421 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
20425 "name": "DescribeOpenchannel_Queue_Reports",
20426 "group": "Openchannel_Queue_Reports",
20427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20428 "version": "0.0.0",
20429 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/index.js",
20430 "groupTitle": "Openchannel_Queue_Reports"
20434 "url": "/api/openchannel/reports/queue",
20435 "title": "Gets a list of Openchannel Queue Reports",
20438 "title": "Example usage:",
20439 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
20443 "name": "GetOpenchannel_Queue_Reports",
20444 "group": "Openchannel_Queue_Reports",
20445 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20446 "version": "0.0.0",
20447 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/index.js",
20448 "groupTitle": "Openchannel_Queue_Reports"
20452 "url": "/api/openchannel/reports/queue/{id}",
20453 "title": "Gets a single Openchannel Queue Report",
20456 "title": "Example usage:",
20457 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
20461 "name": "ShowOpenchannel_Queue_Reports",
20462 "group": "Openchannel_Queue_Reports",
20463 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20464 "version": "0.0.0",
20465 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/index.js",
20466 "groupTitle": "Openchannel_Queue_Reports"
20470 "url": "/UpdateOpenchannelQueueReport",
20471 "title": "Updates a new Openchannel Queue Report",
20472 "name": "UpdateOpenchannelQueueReport",
20473 "group": "Openchannel_Queue_Reports",
20481 "field": "options.attributes",
20488 "field": "options.where",
20494 "version": "0.0.0",
20495 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/openchannelQueueReport.rpc.js",
20496 "groupTitle": "Openchannel_Queue_Reports"
20500 "url": "/api/openchannel/reports/queue/{id}",
20501 "title": "Update an existing Openchannel Queue Report",
20504 "title": "Example usage:",
20505 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20509 "name": "updateOpenchannel_Queue_Reports",
20510 "group": "Openchannel_Queue_Reports",
20511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20512 "version": "0.0.0",
20513 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueueReport/index.js",
20514 "groupTitle": "Openchannel_Queue_Reports"
20518 "url": "/api/openchannel/queues/{id}/users",
20519 "title": "Add agents to a queue",
20522 "title": "Example usage:",
20523 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
20527 "name": "AddAgents",
20528 "group": "Openchannel_Queues",
20529 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20530 "version": "0.0.0",
20531 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20532 "groupTitle": "Openchannel_Queues"
20536 "url": "/api/openchannel/queues/{id}/teams",
20537 "title": "Add teams to a queue",
20540 "title": "Example usage:",
20541 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
20545 "name": "AddTeams",
20546 "group": "Openchannel_Queues",
20547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20548 "version": "0.0.0",
20549 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20550 "groupTitle": "Openchannel_Queues"
20554 "url": "/api/openchannel/queues",
20555 "title": "Creates a new Queue",
20558 "title": "Example usage:",
20559 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20563 "name": "CreateQueues",
20564 "group": "Openchannel_Queues",
20579 "field": "description",
20586 "field": "timeout",
20598 "field": "strategy",
20604 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20605 "version": "0.0.0",
20606 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20607 "groupTitle": "Openchannel_Queues"
20611 "url": "/api/openchannel/queues/{id}",
20612 "title": "Deletes a Queue",
20615 "title": "Example usage:",
20616 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
20620 "name": "DeleteQueues",
20621 "group": "Openchannel_Queues",
20622 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20623 "version": "0.0.0",
20624 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20625 "groupTitle": "Openchannel_Queues"
20629 "url": "/api/openchannel/queues/describe",
20630 "title": "Gets table info about Queues",
20633 "title": "Example usage:",
20634 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
20638 "name": "DescribeQueues",
20639 "group": "Openchannel_Queues",
20640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20641 "version": "0.0.0",
20642 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20643 "groupTitle": "Openchannel_Queues"
20647 "url": "/api/openchannel/queues/{id}/users",
20648 "title": "Gets queue agents",
20651 "title": "Example usage:",
20652 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
20656 "name": "GetAgents",
20657 "group": "Openchannel_Queues",
20658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20659 "version": "0.0.0",
20660 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20661 "groupTitle": "Openchannel_Queues"
20665 "url": "/api/openchannel/queues/{id}/members",
20666 "title": "GetMembers",
20669 "title": "Example usage:",
20670 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
20674 "name": "GetMembers",
20675 "group": "Openchannel_Queues",
20676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20677 "version": "0.0.0",
20678 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20679 "groupTitle": "Openchannel_Queues"
20683 "url": "/GetOpenchannelQueue",
20684 "title": "Gets a list of Queues",
20685 "name": "GetOpenchannelQueue",
20686 "group": "Openchannel_Queues",
20694 "field": "options.attributes",
20701 "field": "options.where",
20707 "version": "0.0.0",
20708 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/openchannelQueue.rpc.js",
20709 "groupTitle": "Openchannel_Queues"
20713 "url": "/api/openchannel/queues",
20714 "title": "Gets a list of Queues",
20717 "title": "Example usage:",
20718 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
20722 "name": "GetQueues",
20723 "group": "Openchannel_Queues",
20724 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20725 "version": "0.0.0",
20726 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20727 "groupTitle": "Openchannel_Queues"
20731 "url": "/api/openchannel/queues/{id}/teams",
20732 "title": "Gets queues list",
20735 "title": "Example usage:",
20736 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
20740 "name": "GetTeams",
20741 "group": "Openchannel_Queues",
20742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20743 "version": "0.0.0",
20744 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20745 "groupTitle": "Openchannel_Queues"
20749 "url": "/api/openchannel/queues/{id}/users",
20750 "title": "Removes agents from a queue",
20753 "title": "Example usage:",
20754 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
20758 "name": "RemoveAgents",
20759 "group": "Openchannel_Queues",
20760 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20761 "version": "0.0.0",
20762 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20763 "groupTitle": "Openchannel_Queues"
20767 "url": "/ShowOpenchannelQueue",
20768 "title": "Gets a single Queue",
20769 "name": "ShowOpenchannelQueue",
20770 "group": "Openchannel_Queues",
20778 "field": "options.attributes",
20785 "field": "options.where",
20791 "version": "0.0.0",
20792 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/openchannelQueue.rpc.js",
20793 "groupTitle": "Openchannel_Queues"
20797 "url": "/api/openchannel/queues/{id}",
20798 "title": "Gets a single Queue",
20801 "title": "Example usage:",
20802 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
20806 "name": "ShowQueues",
20807 "group": "Openchannel_Queues",
20808 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20809 "version": "0.0.0",
20810 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20811 "groupTitle": "Openchannel_Queues"
20815 "url": "/api/openchannel/queues/{id}",
20816 "title": "Update an existing Queue",
20819 "title": "Example usage:",
20820 "content": "curl https://{domain}/api/openchannel/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20824 "name": "updateQueues",
20825 "group": "Openchannel_Queues",
20826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20827 "version": "0.0.0",
20828 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
20829 "groupTitle": "Openchannel_Queues"
20833 "url": "/api/openchannel/reports/transfer",
20834 "title": "Creates a new Openchannel Transfer Report",
20837 "title": "Example usage:",
20838 "content": "curl https://{domain}/api/openchannel/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20842 "name": "CreateOpenchannel_Transfer_Reports",
20843 "group": "Openchannel_Transfer_Reports",
20851 "field": "uniqueid",
20870 "field": "transferredAt",
20876 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20877 "version": "0.0.0",
20878 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelTransferReport/index.js",
20879 "groupTitle": "Openchannel_Transfer_Reports"
20883 "url": "/api/openchannel/reports/transfer/{id}",
20884 "title": "Deletes a Openchannel Transfer Report",
20887 "title": "Example usage:",
20888 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
20892 "name": "DeleteOpenchannel_Transfer_Reports",
20893 "group": "Openchannel_Transfer_Reports",
20894 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20895 "version": "0.0.0",
20896 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelTransferReport/index.js",
20897 "groupTitle": "Openchannel_Transfer_Reports"
20901 "url": "/api/openchannel/reports/transfer/describe",
20902 "title": "Gets table info about Openchannel Transfer Reports",
20905 "title": "Example usage:",
20906 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
20910 "name": "DescribeOpenchannel_Transfer_Reports",
20911 "group": "Openchannel_Transfer_Reports",
20912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20913 "version": "0.0.0",
20914 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelTransferReport/index.js",
20915 "groupTitle": "Openchannel_Transfer_Reports"
20919 "url": "/api/openchannel/reports/transfer",
20920 "title": "Gets a list of Openchannel Transfer Reports",
20923 "title": "Example usage:",
20924 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
20928 "name": "GetOpenchannel_Transfer_Reports",
20929 "group": "Openchannel_Transfer_Reports",
20930 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20931 "version": "0.0.0",
20932 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelTransferReport/index.js",
20933 "groupTitle": "Openchannel_Transfer_Reports"
20937 "url": "/api/openchannel/reports/transfer/{id}",
20938 "title": "Gets a single Openchannel Transfer Report",
20941 "title": "Example usage:",
20942 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
20946 "name": "ShowOpenchannel_Transfer_Reports",
20947 "group": "Openchannel_Transfer_Reports",
20948 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20949 "version": "0.0.0",
20950 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelTransferReport/index.js",
20951 "groupTitle": "Openchannel_Transfer_Reports"
20955 "url": "/api/openchannel/reports/transfer/{id}",
20956 "title": "Update an existing Openchannel Transfer Report",
20959 "title": "Example usage:",
20960 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20964 "name": "updateOpenchannel_Transfer_Reports",
20965 "group": "Openchannel_Transfer_Reports",
20966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20967 "version": "0.0.0",
20968 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelTransferReport/index.js",
20969 "groupTitle": "Openchannel_Transfer_Reports"
20973 "url": "/api/pauses",
20974 "title": "Creates a new Pause",
20977 "title": "Example usage:",
20978 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20982 "name": "CreatePauses",
20998 "field": "description",
21004 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21005 "version": "0.0.0",
21006 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pause/index.js",
21007 "groupTitle": "Pauses"
21011 "url": "/api/pauses/{id}",
21012 "title": "Deletes a Pause",
21015 "title": "Example usage:",
21016 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
21020 "name": "DeletePauses",
21022 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21023 "version": "0.0.0",
21024 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pause/index.js",
21025 "groupTitle": "Pauses"
21029 "url": "/api/pauses",
21030 "title": "Gets a list of Pauses",
21033 "title": "Example usage:",
21034 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
21038 "name": "GetPauses",
21040 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/pauses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/pauses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/pauses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/pauses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/pauses?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21041 "version": "0.0.0",
21042 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pause/index.js",
21043 "groupTitle": "Pauses"
21047 "url": "/ShowPause",
21048 "title": "Gets a single Pause",
21049 "name": "ShowPause",
21058 "field": "options.attributes",
21065 "field": "options.where",
21071 "version": "0.0.0",
21072 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pause/pause.rpc.js",
21073 "groupTitle": "Pauses"
21077 "url": "/api/pauses/{id}",
21078 "title": "Gets a single Pause",
21081 "title": "Example usage:",
21082 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
21086 "name": "ShowPauses",
21088 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21089 "version": "0.0.0",
21090 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pause/index.js",
21091 "groupTitle": "Pauses"
21095 "url": "/api/pauses/{id}",
21096 "title": "Update an existing Pause",
21099 "title": "Example usage:",
21100 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21104 "name": "updatePauses",
21106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21107 "version": "0.0.0",
21108 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pause/index.js",
21109 "groupTitle": "Pauses"
21113 "url": "/CreatePlugin",
21114 "title": "Creates a new Plugin",
21115 "name": "CreatePlugin",
21116 "group": "Plugins",
21117 "version": "0.0.0",
21118 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/plugin.rpc.js",
21119 "groupTitle": "Plugins"
21123 "url": "/api/plugins",
21124 "title": "Gets a list of Plugins",
21127 "title": "Example usage:",
21128 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
21132 "name": "GetPlugins",
21133 "group": "Plugins",
21134 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/plugins?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/plugins?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/plugins?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/plugins?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/plugins?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21135 "version": "0.0.0",
21136 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21137 "groupTitle": "Plugins"
21141 "url": "/api/plugins/{id}",
21142 "title": "Gets a single Plugin",
21145 "title": "Example usage:",
21146 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
21150 "name": "ShowPlugins",
21151 "group": "Plugins",
21152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21153 "version": "0.0.0",
21154 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21155 "groupTitle": "Plugins"
21159 "url": "/api/plugins/{id}",
21160 "title": "Delete a plugin",
21163 "title": "Example usage:",
21164 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
21168 "name": "destroyPlugin",
21169 "group": "Plugins",
21170 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21171 "version": "0.0.0",
21172 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21173 "groupTitle": "Plugins"
21177 "url": "/api/plugins/{id}/download",
21178 "title": "Download plugin source code",
21181 "title": "Example usage:",
21182 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
21186 "name": "download",
21187 "group": "Plugins",
21188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21189 "version": "0.0.0",
21190 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21191 "groupTitle": "Plugins"
21195 "url": "/api/plugins/{id}",
21196 "title": "Update an existing plugin",
21199 "title": "Example usage:",
21200 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
21204 "name": "updatePlugin",
21205 "group": "Plugins",
21206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21207 "version": "0.0.0",
21208 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21209 "groupTitle": "Plugins"
21213 "url": "/api/plugins",
21214 "title": "Upload new plugin",
21217 "title": "Example usage:",
21218 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21222 "name": "uploadPlugin",
21223 "group": "Plugins",
21224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21225 "version": "0.0.0",
21226 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21227 "groupTitle": "Plugins"
21231 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
21232 "title": "Redirect a plugin request to the specified path",
21235 "title": "Example usage:",
21236 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
21240 "name": "webhookPlugin",
21241 "group": "Plugins",
21242 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21243 "version": "0.0.0",
21244 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21245 "groupTitle": "Plugins"
21249 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
21250 "title": "Redirect a plugin request to the specified path",
21253 "title": "Example usage:",
21254 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
21258 "name": "webhookPlugin",
21259 "group": "Plugins",
21260 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21261 "version": "0.0.0",
21262 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/plugin/index.js",
21263 "groupTitle": "Plugins"
21267 "url": "/api/pm2/{id}",
21268 "title": "Deletes an existing process",
21271 "title": "Example usage:",
21272 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
21276 "name": "DeletePm2Process",
21278 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21279 "version": "0.0.0",
21280 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pm2/index.js",
21281 "groupTitle": "Pm2"
21285 "url": "/api/pm2/{id}",
21286 "title": "Gets a single pm2 process",
21289 "title": "Example usage:",
21290 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
21294 "name": "GetPm2Process",
21296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21297 "version": "0.0.0",
21298 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pm2/index.js",
21299 "groupTitle": "Pm2"
21304 "title": "Gets pm2 processes",
21307 "title": "Example usage:",
21308 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
21312 "name": "GetPm2Processes",
21314 "description": "<p>Motion returns the pm2 processes list.</p>",
21315 "version": "0.0.0",
21316 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pm2/index.js",
21317 "groupTitle": "Pm2"
21322 "title": "Start a single pm2 process",
21325 "title": "Example usage:",
21326 "content": "curl https://{domain}/api/pm2 -d '{\"name\": \"process_name\", \"script\": \"/index.js\"}'\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21330 "name": "StartPm2Process",
21352 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21353 "version": "0.0.0",
21354 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pm2/index.js",
21355 "groupTitle": "Pm2"
21359 "url": "/api/pm2/{id}",
21360 "title": "Update an existing process",
21363 "title": "Example usage:",
21364 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21368 "name": "UpdatePm2Process",
21370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21371 "version": "0.0.0",
21372 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/pm2/index.js",
21373 "groupTitle": "Pm2"
21377 "url": "/api/rpc/campaigns/",
21378 "title": "Gets a list of campaigns",
21381 "title": "Example usage:",
21382 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
21386 "name": "Campaigns",
21387 "group": "RPC_Realtime",
21388 "description": "<p>Motion will return a list of realtime campaigns parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21389 "version": "0.0.0",
21390 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21391 "groupTitle": "RPC_Realtime"
21395 "url": "/api/rpc/fax/accounts",
21396 "title": "Gets a list of FaxAccounts",
21399 "title": "Example usage:",
21400 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
21404 "name": "FaxAccounts",
21405 "group": "RPC_Realtime",
21406 "description": "<p>Motion will return a list of realtime fax account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21407 "version": "0.0.0",
21408 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21409 "groupTitle": "RPC_Realtime"
21413 "url": "/api/rpc/agents/:id/capacity",
21414 "title": "Sets agent capacity",
21417 "title": "Example usage:",
21418 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
21422 "name": "RTAgentCapacity",
21423 "group": "RPC_Realtime",
21424 "description": "<p>Motion will return the current agent capacity.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425 "version": "0.0.0",
21426 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21427 "groupTitle": "RPC_Realtime"
21431 "url": "/api/rpc/agents",
21432 "title": "Gets a list of RTAgents",
21435 "title": "Example usage:",
21436 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
21440 "name": "RTAgents",
21441 "group": "RPC_Realtime",
21442 "description": "<p>Motion will return a list of realtime agents parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443 "version": "0.0.0",
21444 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21445 "groupTitle": "RPC_Realtime"
21449 "url": "/api/rpc/chat/queues",
21450 "title": "Gets a list of RTChatQueues",
21453 "title": "Example usage:",
21454 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
21458 "name": "RTChatQueues",
21459 "group": "RPC_Realtime",
21460 "description": "<p>Motion will return a list of realtime chat queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461 "version": "0.0.0",
21462 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21463 "groupTitle": "RPC_Realtime"
21467 "url": "/api/rpc/fax/queues",
21468 "title": "Gets a list of RTFaxQueues",
21471 "title": "Example usage:",
21472 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
21476 "name": "RTFaxQueues",
21477 "group": "RPC_Realtime",
21478 "description": "<p>Motion will return a list of realtime fax queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21479 "version": "0.0.0",
21480 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21481 "groupTitle": "RPC_Realtime"
21485 "url": "/api/rpc/mail/accounts",
21486 "title": "Gets a list of RTMailAccounts",
21489 "title": "Example usage:",
21490 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
21494 "name": "RTMailAccounts",
21495 "group": "RPC_Realtime",
21496 "description": "<p>Motion will return a list of realtime mail account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21497 "version": "0.0.0",
21498 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21499 "groupTitle": "RPC_Realtime"
21503 "url": "/api/rpc/mail/queues",
21504 "title": "Gets a list of RTMailQueues",
21507 "title": "Example usage:",
21508 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
21512 "name": "RTMailQueues",
21513 "group": "RPC_Realtime",
21514 "description": "<p>Motion will return a list of realtime mail queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21515 "version": "0.0.0",
21516 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21517 "groupTitle": "RPC_Realtime"
21521 "url": "/api/rpc/openchannel/queues",
21522 "title": "Gets a list of RTOpenchannelQueues",
21525 "title": "Example usage:",
21526 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
21530 "name": "RTOpenchannelQueues",
21531 "group": "RPC_Realtime",
21532 "description": "<p>Motion will return a list of realtime openchannel queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21533 "version": "0.0.0",
21534 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21535 "groupTitle": "RPC_Realtime"
21539 "url": "/api/rpc/outbound/channels",
21540 "title": "Gets a list of RTOutboundChannels",
21543 "title": "Example usage:",
21544 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
21548 "name": "RTOutboundChannels",
21549 "group": "RPC_Realtime",
21550 "description": "<p>Motion will return a list of realtime outbound channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21551 "version": "0.0.0",
21552 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21553 "groupTitle": "RPC_Realtime"
21557 "url": "/api/rpc/sms/queues",
21558 "title": "Gets a list of RTSmsQueues",
21561 "title": "Example usage:",
21562 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
21566 "name": "RTSmsQueues",
21567 "group": "RPC_Realtime",
21568 "description": "<p>Motion will return a list of realtime sms queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21569 "version": "0.0.0",
21570 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21571 "groupTitle": "RPC_Realtime"
21575 "url": "/api/rpc/telephones",
21576 "title": "Gets a list of RTTelephones",
21579 "title": "Example usage:",
21580 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
21584 "name": "RTTelephones",
21585 "group": "RPC_Realtime",
21586 "description": "<p>Motion will return a list of telephones parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21587 "version": "0.0.0",
21588 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21589 "groupTitle": "RPC_Realtime"
21593 "url": "/api/rpc/trunks",
21594 "title": "Gets a list of RTTrunks",
21597 "title": "Example usage:",
21598 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
21602 "name": "RTTrunks",
21603 "group": "RPC_Realtime",
21604 "description": "<p>Motion will return a list of realtime trunks parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21605 "version": "0.0.0",
21606 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21607 "groupTitle": "RPC_Realtime"
21611 "url": "/api/rpc/voice/channels",
21612 "title": "Gets a list of RTVoiceChannelMixMonitor",
21615 "title": "Example usage:",
21616 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
21620 "name": "RTVoiceChannelMixMonitor",
21621 "group": "RPC_Realtime",
21622 "description": "<p>Motion will return a list of realtime voice channel mixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21623 "version": "0.0.0",
21624 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21625 "groupTitle": "RPC_Realtime"
21629 "url": "/api/rpc/voice/channels",
21630 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
21633 "title": "Example usage:",
21634 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
21638 "name": "RTVoiceChannelStopMixMonitor",
21639 "group": "RPC_Realtime",
21640 "description": "<p>Motion will return a list of realtime voice channel stopmixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21641 "version": "0.0.0",
21642 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21643 "groupTitle": "RPC_Realtime"
21647 "url": "/api/rpc/voice/channels",
21648 "title": "Gets a list of RTVoiceChannels",
21651 "title": "Example usage:",
21652 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
21656 "name": "RTVoiceChannels",
21657 "group": "RPC_Realtime",
21658 "description": "<p>Motion will return a list of realtime voice channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21659 "version": "0.0.0",
21660 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21661 "groupTitle": "RPC_Realtime"
21665 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
21666 "title": "Gets a single RTVoiceQueueChannel",
21669 "title": "Example usage:",
21670 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
21674 "name": "RTVoiceQueueChannel",
21675 "group": "RPC_Realtime",
21676 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21677 "version": "0.0.0",
21678 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21679 "groupTitle": "RPC_Realtime"
21683 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
21684 "title": "Hangup a single RTVoiceQueueChannel",
21687 "title": "Example usage:",
21688 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
21692 "name": "RTVoiceQueueChannelHangup",
21693 "group": "RPC_Realtime",
21694 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21695 "version": "0.0.0",
21696 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21697 "groupTitle": "RPC_Realtime"
21701 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
21702 "title": "Hangup a single RTVoiceQueueChannel",
21705 "title": "Example usage:",
21706 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
21710 "name": "RTVoiceQueueChannelRedirect",
21711 "group": "RPC_Realtime",
21712 "description": "<p>Motion will redirect a specific realtime voice queue channel to a specific extension.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21713 "version": "0.0.0",
21714 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21715 "groupTitle": "RPC_Realtime"
21719 "url": "/api/rpc/voice/queues/preview/{id}",
21720 "title": "Gets a single preview contact",
21723 "title": "Example usage:",
21724 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
21728 "name": "RTVoiceQueuePreview",
21729 "group": "RPC_Realtime",
21730 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21731 "version": "0.0.0",
21732 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21733 "groupTitle": "RPC_Realtime"
21737 "url": "/api/rpc/voice/queues",
21738 "title": "Gets a list of RTVoiceQueues",
21741 "title": "Example usage:",
21742 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
21746 "name": "RTVoiceQueues",
21747 "group": "RPC_Realtime",
21748 "description": "<p>Motion will return a list of realtime voice queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21749 "version": "0.0.0",
21750 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21751 "groupTitle": "RPC_Realtime"
21755 "url": "/api/rpc/outbound",
21756 "title": "Gets a list of RTOutbound",
21759 "title": "Example usage:",
21760 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
21764 "name": "RTVoiceQueues",
21765 "group": "RPC_Realtime",
21766 "description": "<p>Motion will return a list of realtime outbound parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21767 "version": "0.0.0",
21768 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21769 "groupTitle": "RPC_Realtime"
21773 "url": "/api/rpc/voice/queues/channels",
21774 "title": "Gets a list of RTVoiceQueuesChannels",
21777 "title": "Example usage:",
21778 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
21782 "name": "RTVoiceQueuesChannels",
21783 "group": "RPC_Realtime",
21784 "description": "<p>Motion will return a list of realtime voice queues channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21785 "version": "0.0.0",
21786 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21787 "groupTitle": "RPC_Realtime"
21791 "url": "/api/rpc/chat/queues/{id}",
21792 "title": "Gets a single RTChatQueue",
21795 "title": "Example usage:",
21796 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
21800 "name": "ShowRTChatQueues",
21801 "group": "RPC_Realtime",
21802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21803 "version": "0.0.0",
21804 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21805 "groupTitle": "RPC_Realtime"
21809 "url": "/api/rpc/fax/queues/{id}",
21810 "title": "Gets a single RTFaxQueue",
21813 "title": "Example usage:",
21814 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
21818 "name": "ShowRTFaxQueues",
21819 "group": "RPC_Realtime",
21820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21821 "version": "0.0.0",
21822 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21823 "groupTitle": "RPC_Realtime"
21827 "url": "/api/rpc/mail/queues/{id}",
21828 "title": "Gets a single RTMailQueue",
21831 "title": "Example usage:",
21832 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
21836 "name": "ShowRTMailQueues",
21837 "group": "RPC_Realtime",
21838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21839 "version": "0.0.0",
21840 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21841 "groupTitle": "RPC_Realtime"
21845 "url": "/api/rpc/openchannel/queues/{id}",
21846 "title": "Gets a single RTOpenchannelQueue",
21849 "title": "Example usage:",
21850 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
21854 "name": "ShowRTOpenchannelQueues",
21855 "group": "RPC_Realtime",
21856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21857 "version": "0.0.0",
21858 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21859 "groupTitle": "RPC_Realtime"
21863 "url": "/api/rpc/sms/queues/{id}",
21864 "title": "Gets a single RTSmsQueue",
21867 "title": "Example usage:",
21868 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
21872 "name": "ShowRTSmsQueues",
21873 "group": "RPC_Realtime",
21874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21875 "version": "0.0.0",
21876 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21877 "groupTitle": "RPC_Realtime"
21881 "url": "/api/rpc/voice/queues/{id}",
21882 "title": "Gets a single RTVoiceQueue",
21885 "title": "Example usage:",
21886 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
21890 "name": "ShowRTVoiceQueues",
21891 "group": "RPC_Realtime",
21892 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21893 "version": "0.0.0",
21894 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21895 "groupTitle": "RPC_Realtime"
21899 "url": "/api/rpc/agents/:id/notify",
21900 "title": "Notify message to a specific agent",
21903 "title": "Example usage:",
21904 "content": "curl https://{domain}/api/rpc/agents/:id/notify -d '{\"messageId\": \"5080\", \"channel\": \"mail\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21908 "name": "agentNotify",
21909 "group": "RPC_Realtime",
21910 "description": "<p>Notify message to a specific agent.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21911 "version": "0.0.0",
21912 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21913 "groupTitle": "RPC_Realtime"
21917 "url": "/api/rpc/chat/queues/:id/notify",
21918 "title": "Notify message to a specific queue",
21921 "title": "Example usage:",
21922 "content": "curl https://{domain}/api/rpc/chat/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21926 "name": "chatQueueNotify",
21927 "group": "RPC_Realtime",
21928 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21929 "version": "0.0.0",
21930 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21931 "groupTitle": "RPC_Realtime"
21935 "url": "/api/rpc/chat/queues/waitinginteractions",
21936 "title": "Gets a list of chatQueuesWaitingInteractions",
21939 "title": "Example usage:",
21940 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
21944 "name": "chatQueuesWaitingInteractions",
21945 "group": "RPC_Realtime",
21946 "description": "<p>Motion will return a list of realtime waiting chat queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21947 "version": "0.0.0",
21948 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21949 "groupTitle": "RPC_Realtime"
21953 "url": "/api/rpc/fax/queues/:id/notify",
21954 "title": "Notify message to a specific queue",
21957 "title": "Example usage:",
21958 "content": "curl https://{domain}/api/rpc/fax/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21962 "name": "faxQueueNotify",
21963 "group": "RPC_Realtime",
21964 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21965 "version": "0.0.0",
21966 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21967 "groupTitle": "RPC_Realtime"
21971 "url": "/api/rpc/fax/queues/waitinginteractions",
21972 "title": "Gets a list of faxQueuesWaitingInteractions",
21975 "title": "Example usage:",
21976 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
21980 "name": "faxQueuesWaitingInteractions",
21981 "group": "RPC_Realtime",
21982 "description": "<p>Motion will return a list of realtime waiting fax queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21983 "version": "0.0.0",
21984 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
21985 "groupTitle": "RPC_Realtime"
21989 "url": "/api/rpc/mail/queues/:id/notify",
21990 "title": "Notify message to a specific queue",
21993 "title": "Example usage:",
21994 "content": "curl https://{domain}/api/rpc/mail/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21998 "name": "mailQueueNotify",
21999 "group": "RPC_Realtime",
22000 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22001 "version": "0.0.0",
22002 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22003 "groupTitle": "RPC_Realtime"
22007 "url": "/api/rpc/mail/queues/waitinginteractions",
22008 "title": "Gets a list of mailQueuesWaitingInteractions",
22011 "title": "Example usage:",
22012 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
22016 "name": "mailQueuesWaitingInteractions",
22017 "group": "RPC_Realtime",
22018 "description": "<p>Motion will return a list of realtime waiting mail queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22019 "version": "0.0.0",
22020 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22021 "groupTitle": "RPC_Realtime"
22025 "url": "/api/rpc/openchannel/queues/:id/notify",
22026 "title": "Notify message to a specific queue",
22029 "title": "Example usage:",
22030 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22034 "name": "openchannelQueueNotify",
22035 "group": "RPC_Realtime",
22036 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22037 "version": "0.0.0",
22038 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22039 "groupTitle": "RPC_Realtime"
22043 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
22044 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
22047 "title": "Example usage:",
22048 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
22052 "name": "openchannelQueuesIdWaitingInteractions",
22053 "group": "RPC_Realtime",
22054 "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22055 "version": "0.0.0",
22056 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22057 "groupTitle": "RPC_Realtime"
22061 "url": "/api/rpc/openchannel/queues/waitinginteractions",
22062 "title": "Gets a list of openchannelQueuesWaitingInteractions",
22065 "title": "Example usage:",
22066 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
22070 "name": "openchannelQueuesWaitingInteractions",
22071 "group": "RPC_Realtime",
22072 "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22073 "version": "0.0.0",
22074 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22075 "groupTitle": "RPC_Realtime"
22079 "url": "/api/rpc/sms/queues/:id/notify",
22080 "title": "Notify message to a specific queue",
22083 "title": "Example usage:",
22084 "content": "curl https://{domain}/api/rpc/sms/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22088 "name": "smsQueueNotify",
22089 "group": "RPC_Realtime",
22090 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22091 "version": "0.0.0",
22092 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22093 "groupTitle": "RPC_Realtime"
22097 "url": "/api/rpc/sms/queues/waitinginteractions",
22098 "title": "Gets a list of smsQueuesWaitingInteractions",
22101 "title": "Example usage:",
22102 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
22106 "name": "smsQueuesWaitingInteractions",
22107 "group": "RPC_Realtime",
22108 "description": "<p>Motion will return a list of realtime waiting sms queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22109 "version": "0.0.0",
22110 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/rpc/index.js",
22111 "groupTitle": "RPC_Realtime"
22115 "url": "/CreateReportAgentPreview",
22116 "title": "Creates a new ReportAgentPreview",
22117 "name": "CreateReportAgentPreview",
22118 "group": "Report_Agent_Preview",
22119 "version": "0.0.0",
22120 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/reportAgentPreview/reportAgentPreview.rpc.js",
22121 "groupTitle": "Report_Agent_Preview"
22125 "url": "/api/integrations/salesforce/accounts",
22126 "title": "Creates a new Salesforce Account",
22129 "title": "Example usage:",
22130 "content": "curl https://{domain}/api/integrations/salesforce/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22134 "name": "CreateSalesforce_Accounts",
22135 "group": "Salesforce_Accounts",
22150 "field": "description",
22157 "field": "username",
22164 "field": "remoteUri",
22171 "field": "password",
22178 "field": "clientId",
22185 "field": "clientSecret",
22192 "field": "securityToken",
22199 "field": "serverUrl",
22206 "\"integrationTab\"",
22216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22217 "version": "0.0.0",
22218 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22219 "groupTitle": "Salesforce_Accounts"
22223 "url": "/api/integrations/salesforce/accounts/{id}",
22224 "title": "Deletes a Salesforce Account",
22227 "title": "Example usage:",
22228 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
22232 "name": "DeleteSalesforce_Accounts",
22233 "group": "Salesforce_Accounts",
22234 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22235 "version": "0.0.0",
22236 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22237 "groupTitle": "Salesforce_Accounts"
22241 "url": "/GetSalesforceAccount",
22242 "title": "Gets a list of Salesforce Accounts",
22243 "name": "GetSalesforceAccount",
22244 "group": "Salesforce_Accounts",
22252 "field": "options.attributes",
22259 "field": "options.where",
22265 "version": "0.0.0",
22266 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/intSalesforceAccount.rpc.js",
22267 "groupTitle": "Salesforce_Accounts"
22271 "url": "/api/integrations/salesforce/accounts",
22272 "title": "Gets a list of Salesforce Accounts",
22275 "title": "Example usage:",
22276 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
22280 "name": "GetSalesforce_Accounts",
22281 "group": "Salesforce_Accounts",
22282 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22283 "version": "0.0.0",
22284 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22285 "groupTitle": "Salesforce_Accounts"
22289 "url": "/ShowSalesforceAccount",
22290 "title": "Gets a single Salesforce Account",
22291 "name": "ShowSalesforceAccount",
22292 "group": "Salesforce_Accounts",
22300 "field": "options.attributes",
22307 "field": "options.where",
22313 "version": "0.0.0",
22314 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/intSalesforceAccount.rpc.js",
22315 "groupTitle": "Salesforce_Accounts"
22319 "url": "/api/integrations/salesforce/accounts/{id}",
22320 "title": "Gets a single Salesforce Account",
22323 "title": "Example usage:",
22324 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
22328 "name": "ShowSalesforce_Accounts",
22329 "group": "Salesforce_Accounts",
22330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22331 "version": "0.0.0",
22332 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22333 "groupTitle": "Salesforce_Accounts"
22337 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
22338 "title": "Creates new configuration",
22341 "title": "Example usage:",
22342 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22346 "name": "addConfiguration",
22347 "group": "Salesforce_Accounts",
22348 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22349 "version": "0.0.0",
22350 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22351 "groupTitle": "Salesforce_Accounts"
22355 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
22356 "title": "Gets account configurations",
22359 "title": "Example usage:",
22360 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22364 "name": "getConfigurations",
22365 "group": "Salesforce_Accounts",
22366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22367 "version": "0.0.0",
22368 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22369 "groupTitle": "Salesforce_Accounts"
22373 "url": "/api/integrations/salesforce/accounts/{id}/fields",
22374 "title": "Gets account fields",
22377 "title": "Example usage:",
22378 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
22382 "name": "getFields",
22383 "group": "Salesforce_Accounts",
22384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22385 "version": "0.0.0",
22386 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22387 "groupTitle": "Salesforce_Accounts"
22391 "url": "/api/integrations/salesforce/accounts/{id}",
22392 "title": "Update an existing Salesforce Account",
22395 "title": "Example usage:",
22396 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22400 "name": "updateSalesforce_Accounts",
22401 "group": "Salesforce_Accounts",
22402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22403 "version": "0.0.0",
22404 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceAccount/index.js",
22405 "groupTitle": "Salesforce_Accounts"
22409 "url": "/api/integrations/salesforce/configurations",
22410 "title": "Creates a new Salesforce Configuration",
22413 "title": "Example usage:",
22414 "content": "curl https://{domain}/api/integrations/salesforce/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22418 "name": "CreateSalesforce_Configurations",
22419 "group": "Salesforce_Configurations",
22434 "field": "description",
22445 "field": "ticketType",
22452 "\"contact_lead\"",
22457 "field": "moduleSearch",
22469 "field": "moduleCreate",
22475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22476 "version": "0.0.0",
22477 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22478 "groupTitle": "Salesforce_Configurations"
22482 "url": "/api/integrations/salesforce/configurations/{id}",
22483 "title": "Deletes a Salesforce Configuration",
22486 "title": "Example usage:",
22487 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
22491 "name": "DeleteSalesforce_Configurations",
22492 "group": "Salesforce_Configurations",
22493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22494 "version": "0.0.0",
22495 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22496 "groupTitle": "Salesforce_Configurations"
22500 "url": "/api/integrations/salesforce/configurations",
22501 "title": "Gets a list of Salesforce Configurations",
22504 "title": "Example usage:",
22505 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
22509 "name": "GetSalesforce_Configurations",
22510 "group": "Salesforce_Configurations",
22511 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22512 "version": "0.0.0",
22513 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22514 "groupTitle": "Salesforce_Configurations"
22518 "url": "/api/integrations/salesforce/configurations/{id}",
22519 "title": "Gets a single Salesforce Configuration",
22522 "title": "Example usage:",
22523 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
22527 "name": "ShowSalesforce_Configurations",
22528 "group": "Salesforce_Configurations",
22529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22530 "version": "0.0.0",
22531 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22532 "groupTitle": "Salesforce_Configurations"
22536 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
22537 "title": "Gets configurations descriptions",
22540 "title": "Example usage:",
22541 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22545 "name": "getDescriptions",
22546 "group": "Salesforce_Configurations",
22547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22548 "version": "0.0.0",
22549 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22550 "groupTitle": "Salesforce_Configurations"
22554 "url": "/api/integrations/salesforce/configurations/{id}/fields",
22555 "title": "Gets configurations fields",
22558 "title": "Example usage:",
22559 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
22563 "name": "getFields",
22564 "group": "Salesforce_Configurations",
22565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22566 "version": "0.0.0",
22567 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22568 "groupTitle": "Salesforce_Configurations"
22572 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
22573 "title": "Gets configurations subjects",
22576 "title": "Example usage:",
22577 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22581 "name": "getSubjects",
22582 "group": "Salesforce_Configurations",
22583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22584 "version": "0.0.0",
22585 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22586 "groupTitle": "Salesforce_Configurations"
22590 "url": "/api/integrations/salesforce/configurations/{id}",
22591 "title": "Update an existing Salesforce Configuration",
22594 "title": "Example usage:",
22595 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22599 "name": "updateSalesforce_Configurations",
22600 "group": "Salesforce_Configurations",
22601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22602 "version": "0.0.0",
22603 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceConfiguration/index.js",
22604 "groupTitle": "Salesforce_Configurations"
22608 "url": "/api/integrations/salesforce/fields",
22609 "title": "Creates a new Salesforce Field",
22612 "title": "Example usage:",
22613 "content": "curl https://{domain}/api/integrations/salesforce/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22617 "name": "CreateSalesforce_Fields",
22618 "group": "Salesforce_Fields",
22628 "\"customVariable\"",
22639 "field": "content",
22655 "\"customVariable\""
22658 "field": "keyType",
22665 "field": "keyContent",
22672 "field": "idField",
22679 "field": "variableName",
22685 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22686 "version": "0.0.0",
22687 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceField/index.js",
22688 "groupTitle": "Salesforce_Fields"
22692 "url": "/api/integrations/salesforce/fields/{id}",
22693 "title": "Deletes a Salesforce Field",
22696 "title": "Example usage:",
22697 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
22701 "name": "DeleteSalesforce_Fields",
22702 "group": "Salesforce_Fields",
22703 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22704 "version": "0.0.0",
22705 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceField/index.js",
22706 "groupTitle": "Salesforce_Fields"
22710 "url": "/api/integrations/salesforce/fields",
22711 "title": "Gets a list of Salesforce Fields",
22714 "title": "Example usage:",
22715 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
22719 "name": "GetSalesforce_Fields",
22720 "group": "Salesforce_Fields",
22721 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22722 "version": "0.0.0",
22723 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceField/index.js",
22724 "groupTitle": "Salesforce_Fields"
22728 "url": "/api/integrations/salesforce/fields/{id}",
22729 "title": "Gets a single Salesforce Field",
22732 "title": "Example usage:",
22733 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
22737 "name": "ShowSalesforce_Fields",
22738 "group": "Salesforce_Fields",
22739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22740 "version": "0.0.0",
22741 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceField/index.js",
22742 "groupTitle": "Salesforce_Fields"
22746 "url": "/api/integrations/salesforce/fields/{id}",
22747 "title": "Update an existing Salesforce Field",
22750 "title": "Example usage:",
22751 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22755 "name": "updateSalesforce_Fields",
22756 "group": "Salesforce_Fields",
22757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22758 "version": "0.0.0",
22759 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSalesforceField/index.js",
22760 "groupTitle": "Salesforce_Fields"
22764 "url": "/api/schedules",
22765 "title": "Creates a new Schedule",
22768 "title": "Example usage:",
22769 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22773 "name": "CreateSchedules",
22774 "group": "Schedules",
22789 "field": "description",
22810 "field": "startAt",
22824 "field": "subtractNumber",
22840 "field": "subtractUnit",
22870 "field": "sendMail",
22898 "field": "sendIfEmpty",
22904 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22905 "version": "0.0.0",
22906 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/schedule/index.js",
22907 "groupTitle": "Schedules"
22911 "url": "/api/schedules/{id}",
22912 "title": "Deletes a Schedule",
22915 "title": "Example usage:",
22916 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
22920 "name": "DeleteSchedules",
22921 "group": "Schedules",
22922 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22923 "version": "0.0.0",
22924 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/schedule/index.js",
22925 "groupTitle": "Schedules"
22929 "url": "/api/schedules",
22930 "title": "Gets a list of Schedules",
22933 "title": "Example usage:",
22934 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
22938 "name": "GetSchedules",
22939 "group": "Schedules",
22940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/schedules?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/schedules?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/schedules?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/schedules?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/schedules?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22941 "version": "0.0.0",
22942 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/schedule/index.js",
22943 "groupTitle": "Schedules"
22947 "url": "/api/schedules/{id}",
22948 "title": "Gets a single Schedule",
22951 "title": "Example usage:",
22952 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
22956 "name": "ShowSchedules",
22957 "group": "Schedules",
22958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22959 "version": "0.0.0",
22960 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/schedule/index.js",
22961 "groupTitle": "Schedules"
22965 "url": "/api/schedules/{id}/run",
22966 "title": "Run Scheduler",
22969 "title": "Example usage:",
22970 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
22975 "group": "Schedules",
22976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22977 "version": "0.0.0",
22978 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/schedule/index.js",
22979 "groupTitle": "Schedules"
22983 "url": "/api/schedules/{id}",
22984 "title": "Update an existing Schedule",
22987 "title": "Example usage:",
22988 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22992 "name": "updateSchedules",
22993 "group": "Schedules",
22994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22995 "version": "0.0.0",
22996 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/schedule/index.js",
22997 "groupTitle": "Schedules"
23001 "url": "/api/screen/recordings",
23002 "title": "Creates a new Recording",
23005 "title": "Example usage:",
23006 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23010 "name": "CreateRecordings",
23011 "group": "Screen_Recordings",
23026 "field": "interactionid",
23033 "field": "channel",
23054 "field": "duration",
23061 "field": "startedAt",
23068 "field": "closedAt",
23075 "field": "createdAt",
23082 "field": "updatedAt",
23088 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23089 "version": "0.0.0",
23090 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23091 "groupTitle": "Screen_Recordings"
23095 "url": "/api/screen/recordings/describe",
23096 "title": "Gets table info about Recordings",
23099 "title": "Example usage:",
23100 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
23104 "name": "DescribeRecordings",
23105 "group": "Screen_Recordings",
23106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23107 "version": "0.0.0",
23108 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23109 "groupTitle": "Screen_Recordings"
23113 "url": "/api/screen/recordings",
23114 "title": "Gets a list of Recordings",
23117 "title": "Example usage:",
23118 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
23122 "name": "GetRecordings",
23123 "group": "Screen_Recordings",
23124 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/screen/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/screen/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/screen/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/screen/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/screen/recordings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23125 "version": "0.0.0",
23126 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23127 "groupTitle": "Screen_Recordings"
23131 "url": "/api/screen/recordings/{id}",
23132 "title": "Gets a single Recording",
23135 "title": "Example usage:",
23136 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
23140 "name": "ShowRecordings",
23141 "group": "Screen_Recordings",
23142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23143 "version": "0.0.0",
23144 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23145 "groupTitle": "Screen_Recordings"
23149 "url": "/api/screen/recordings/{id}",
23150 "title": "Delete screen recording",
23153 "title": "Example usage:",
23154 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
23159 "group": "Screen_Recordings",
23160 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161 "version": "0.0.0",
23162 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23163 "groupTitle": "Screen_Recordings"
23167 "url": "/api/screen/recordings/{id}/download",
23168 "title": "Download Recording",
23171 "title": "Example usage:",
23172 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
23176 "name": "download",
23177 "group": "Screen_Recordings",
23178 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23179 "version": "0.0.0",
23180 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23181 "groupTitle": "Screen_Recordings"
23185 "url": "/api/screen/recordings/{id}",
23186 "title": "Update an existing Recording",
23189 "title": "Example usage:",
23190 "content": "curl https://{domain}/api/screen/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23194 "name": "updateRecordings",
23195 "group": "Screen_Recordings",
23196 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23197 "version": "0.0.0",
23198 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/screenRecording/index.js",
23199 "groupTitle": "Screen_Recordings"
23203 "url": "/api/integrations/servicenow/accounts",
23204 "title": "Creates a new Servicenow Account",
23207 "title": "Example usage:",
23208 "content": "curl https://{domain}/api/integrations/servicenow/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23212 "name": "CreateServicenow_Accounts",
23213 "group": "Servicenow_Accounts",
23228 "field": "description",
23235 "field": "username",
23242 "field": "password",
23256 "field": "remoteUri",
23263 "field": "serverUrl",
23269 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23270 "version": "0.0.0",
23271 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23272 "groupTitle": "Servicenow_Accounts"
23276 "url": "/api/integrations/servicenow/accounts/{id}",
23277 "title": "Deletes a Servicenow Account",
23280 "title": "Example usage:",
23281 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
23285 "name": "DeleteServicenow_Accounts",
23286 "group": "Servicenow_Accounts",
23287 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23288 "version": "0.0.0",
23289 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23290 "groupTitle": "Servicenow_Accounts"
23294 "url": "/GetServicenowAccount",
23295 "title": "Gets a list of Servicenow Accounts",
23296 "name": "GetServicenowAccount",
23297 "group": "Servicenow_Accounts",
23305 "field": "options.attributes",
23312 "field": "options.where",
23318 "version": "0.0.0",
23319 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/intServicenowAccount.rpc.js",
23320 "groupTitle": "Servicenow_Accounts"
23324 "url": "/api/integrations/servicenow/accounts",
23325 "title": "Gets a list of Servicenow Accounts",
23328 "title": "Example usage:",
23329 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
23333 "name": "GetServicenow_Accounts",
23334 "group": "Servicenow_Accounts",
23335 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23336 "version": "0.0.0",
23337 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23338 "groupTitle": "Servicenow_Accounts"
23342 "url": "/ShowServicenowAccount",
23343 "title": "Gets a single Servicenow Account",
23344 "name": "ShowServicenowAccount",
23345 "group": "Servicenow_Accounts",
23353 "field": "options.attributes",
23360 "field": "options.where",
23366 "version": "0.0.0",
23367 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/intServicenowAccount.rpc.js",
23368 "groupTitle": "Servicenow_Accounts"
23372 "url": "/api/integrations/servicenow/accounts/{id}",
23373 "title": "Gets a single Servicenow Account",
23376 "title": "Example usage:",
23377 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
23381 "name": "ShowServicenow_Accounts",
23382 "group": "Servicenow_Accounts",
23383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23384 "version": "0.0.0",
23385 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23386 "groupTitle": "Servicenow_Accounts"
23390 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
23391 "title": "Creates new configuration",
23394 "title": "Example usage:",
23395 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23399 "name": "addConfiguration",
23400 "group": "Servicenow_Accounts",
23401 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23402 "version": "0.0.0",
23403 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23404 "groupTitle": "Servicenow_Accounts"
23408 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
23409 "title": "Gets account configurations",
23412 "title": "Example usage:",
23413 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
23417 "name": "getConfigurations",
23418 "group": "Servicenow_Accounts",
23419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23420 "version": "0.0.0",
23421 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23422 "groupTitle": "Servicenow_Accounts"
23426 "url": "/api/integrations/servicenow/accounts/{id}/fields",
23427 "title": "Gets account fields",
23430 "title": "Example usage:",
23431 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
23435 "name": "getFields",
23436 "group": "Servicenow_Accounts",
23437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23438 "version": "0.0.0",
23439 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23440 "groupTitle": "Servicenow_Accounts"
23444 "url": "/api/integrations/servicenow/accounts/{id}",
23445 "title": "Update an existing Servicenow Account",
23448 "title": "Example usage:",
23449 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23453 "name": "updateServicenow_Accounts",
23454 "group": "Servicenow_Accounts",
23455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23456 "version": "0.0.0",
23457 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowAccount/index.js",
23458 "groupTitle": "Servicenow_Accounts"
23462 "url": "/api/integrations/servicenow/configurations",
23463 "title": "Creates a new Servicenow Configuration",
23466 "title": "Example usage:",
23467 "content": "curl https://{domain}/api/integrations/servicenow/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23471 "name": "CreateServicenow_Configurations",
23472 "group": "Servicenow_Configurations",
23487 "field": "description",
23493 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23494 "version": "0.0.0",
23495 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23496 "groupTitle": "Servicenow_Configurations"
23500 "url": "/api/integrations/servicenow/configurations/{id}",
23501 "title": "Deletes a Servicenow Configuration",
23504 "title": "Example usage:",
23505 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
23509 "name": "DeleteServicenow_Configurations",
23510 "group": "Servicenow_Configurations",
23511 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23512 "version": "0.0.0",
23513 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23514 "groupTitle": "Servicenow_Configurations"
23518 "url": "/api/integrations/servicenow/configurations",
23519 "title": "Gets a list of Servicenow Configurations",
23522 "title": "Example usage:",
23523 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
23527 "name": "GetServicenow_Configurations",
23528 "group": "Servicenow_Configurations",
23529 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23530 "version": "0.0.0",
23531 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23532 "groupTitle": "Servicenow_Configurations"
23536 "url": "/api/integrations/servicenow/configurations/{id}",
23537 "title": "Gets a single Servicenow Configuration",
23540 "title": "Example usage:",
23541 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
23545 "name": "ShowServicenow_Configurations",
23546 "group": "Servicenow_Configurations",
23547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23548 "version": "0.0.0",
23549 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23550 "groupTitle": "Servicenow_Configurations"
23554 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
23555 "title": "Gets configurations descriptions",
23558 "title": "Example usage:",
23559 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
23563 "name": "getDescriptions",
23564 "group": "Servicenow_Configurations",
23565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23566 "version": "0.0.0",
23567 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23568 "groupTitle": "Servicenow_Configurations"
23572 "url": "/api/integrations/servicenow/configurations/{id}/fields",
23573 "title": "Gets configurations fields",
23576 "title": "Example usage:",
23577 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
23581 "name": "getFields",
23582 "group": "Servicenow_Configurations",
23583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23584 "version": "0.0.0",
23585 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23586 "groupTitle": "Servicenow_Configurations"
23590 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
23591 "title": "Gets configurations subjects",
23594 "title": "Example usage:",
23595 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
23599 "name": "getSubjects",
23600 "group": "Servicenow_Configurations",
23601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23602 "version": "0.0.0",
23603 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23604 "groupTitle": "Servicenow_Configurations"
23608 "url": "/api/integrations/servicenow/configurations/{id}",
23609 "title": "Update an existing Servicenow Configuration",
23612 "title": "Example usage:",
23613 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23617 "name": "updateServicenow_Configurations",
23618 "group": "Servicenow_Configurations",
23619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23620 "version": "0.0.0",
23621 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowConfiguration/index.js",
23622 "groupTitle": "Servicenow_Configurations"
23626 "url": "/api/integrations/servicenow/fields",
23627 "title": "Creates a new Servicenow Field",
23630 "title": "Example usage:",
23631 "content": "curl https://{domain}/api/integrations/servicenow/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23635 "name": "CreateServicenow_Fields",
23636 "group": "Servicenow_Fields",
23646 "\"customVariable\"",
23657 "field": "content",
23673 "\"customVariable\""
23676 "field": "keyType",
23683 "field": "keyContent",
23690 "field": "idField",
23697 "field": "nameField",
23704 "field": "customField",
23711 "field": "variableName",
23717 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23718 "version": "0.0.0",
23719 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowField/index.js",
23720 "groupTitle": "Servicenow_Fields"
23724 "url": "/api/integrations/servicenow/fields/{id}",
23725 "title": "Deletes a Servicenow Field",
23728 "title": "Example usage:",
23729 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
23733 "name": "DeleteServicenow_Fields",
23734 "group": "Servicenow_Fields",
23735 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23736 "version": "0.0.0",
23737 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowField/index.js",
23738 "groupTitle": "Servicenow_Fields"
23742 "url": "/api/integrations/servicenow/fields",
23743 "title": "Gets a list of Servicenow Fields",
23746 "title": "Example usage:",
23747 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
23751 "name": "GetServicenow_Fields",
23752 "group": "Servicenow_Fields",
23753 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23754 "version": "0.0.0",
23755 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowField/index.js",
23756 "groupTitle": "Servicenow_Fields"
23760 "url": "/api/integrations/servicenow/fields/{id}",
23761 "title": "Gets a single Servicenow Field",
23764 "title": "Example usage:",
23765 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
23769 "name": "ShowServicenow_Fields",
23770 "group": "Servicenow_Fields",
23771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23772 "version": "0.0.0",
23773 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowField/index.js",
23774 "groupTitle": "Servicenow_Fields"
23778 "url": "/api/integrations/servicenow/fields/{id}",
23779 "title": "Update an existing Servicenow Field",
23782 "title": "Example usage:",
23783 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23787 "name": "updateServicenow_Fields",
23788 "group": "Servicenow_Fields",
23789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23790 "version": "0.0.0",
23791 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intServicenowField/index.js",
23792 "groupTitle": "Servicenow_Fields"
23796 "url": "/api/settings",
23797 "title": "Gets a list of Settings",
23800 "title": "Example usage:",
23801 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
23805 "name": "GetSettings",
23806 "group": "Settings",
23807 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/settings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/settings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/settings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/settings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/settings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23808 "version": "0.0.0",
23809 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23810 "groupTitle": "Settings"
23814 "url": "/api/settings/{id}",
23815 "title": "Gets a single Setting",
23818 "title": "Example usage:",
23819 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
23823 "name": "ShowSettings",
23824 "group": "Settings",
23825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23826 "version": "0.0.0",
23827 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23828 "groupTitle": "Settings"
23832 "url": "/api/settings/{id}/favicon",
23833 "title": "Add Favicon",
23836 "title": "Example usage:",
23837 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23841 "name": "addFavicon",
23842 "group": "Settings",
23843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23844 "version": "0.0.0",
23845 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23846 "groupTitle": "Settings"
23850 "url": "/api/settings/{id}/logo",
23851 "title": "Add logo",
23854 "title": "Example usage:",
23855 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23860 "group": "Settings",
23861 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23862 "version": "0.0.0",
23863 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23864 "groupTitle": "Settings"
23868 "url": "/api/settings/{id}/logo_login",
23869 "title": "Add logo login",
23872 "title": "Example usage:",
23873 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23877 "name": "addLogoLogin",
23878 "group": "Settings",
23879 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23880 "version": "0.0.0",
23881 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23882 "groupTitle": "Settings"
23886 "url": "/api/settings/{id}/preferred",
23887 "title": "Add Preferred",
23890 "title": "Example usage:",
23891 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23895 "name": "addPreferred",
23896 "group": "Settings",
23897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23898 "version": "0.0.0",
23899 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23900 "groupTitle": "Settings"
23904 "url": "/api/settings/{id}/favicon",
23905 "title": "Get Favicon",
23908 "title": "Example usage:",
23909 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
23913 "name": "getFavicon",
23914 "group": "Settings",
23915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23916 "version": "0.0.0",
23917 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23918 "groupTitle": "Settings"
23922 "url": "/api/settings/{id}/gdpr",
23923 "title": "Get gdpr settings",
23926 "title": "Example usage:",
23927 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
23932 "group": "Settings",
23933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23934 "version": "0.0.0",
23935 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23936 "groupTitle": "Settings"
23940 "url": "/api/settings/{id}/logo",
23941 "title": "Get logo",
23944 "title": "Example usage:",
23945 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
23950 "group": "Settings",
23951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23952 "version": "0.0.0",
23953 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23954 "groupTitle": "Settings"
23958 "url": "/api/settings/{id}/logo_login",
23959 "title": "Get logo login",
23962 "title": "Example usage:",
23963 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
23967 "name": "getLogoLogin",
23968 "group": "Settings",
23969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23970 "version": "0.0.0",
23971 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23972 "groupTitle": "Settings"
23976 "url": "/api/settings/{id}/preferred",
23977 "title": "Get Preferred",
23980 "title": "Example usage:",
23981 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
23985 "name": "getPreferred",
23986 "group": "Settings",
23987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23988 "version": "0.0.0",
23989 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
23990 "groupTitle": "Settings"
23994 "url": "/api/settings/{id}",
23995 "title": "Update an existing Setting",
23998 "title": "Example usage:",
23999 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24003 "name": "updateSettings",
24004 "group": "Settings",
24005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24006 "version": "0.0.0",
24007 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/setting/index.js",
24008 "groupTitle": "Settings"
24012 "url": "/api/sms/accounts/{id}/users",
24013 "title": "Add agents to a sms account",
24016 "title": "Example usage:",
24017 "content": "curl https://{domain}/api/sms/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24021 "name": "AddAgents",
24022 "group": "Sms_Accounts",
24023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24024 "version": "0.0.0",
24025 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24026 "groupTitle": "Sms_Accounts"
24030 "url": "/api/sms/accounts",
24031 "title": "Creates a new Account",
24034 "title": "Example usage:",
24035 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24039 "name": "CreateAccounts",
24040 "group": "Sms_Accounts",
24101 "field": "accountSid",
24115 "field": "authToken",
24127 "field": "smsMethod",
24134 "field": "username",
24141 "field": "password",
24155 "field": "senderString",
24162 "field": "deliveryReport",
24169 "field": "description",
24176 "field": "notificationTemplate",
24183 "field": "notificationSound",
24190 "field": "notificationShake",
24197 "field": "waitForTheAssignedAgent",
24204 "field": "queueTransfer",
24211 "field": "queueTransferTimeout",
24218 "field": "agentTransfer",
24225 "field": "agentTransferTimeout",
24232 "field": "baseUrl",
24239 "field": "mandatoryDispositionPauseId",
24240 "description": "<p>Status to put when mandatory disposition is enabled</p>"
24246 "field": "mandatoryDisposition",
24247 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
24252 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24253 "version": "0.0.0",
24254 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24255 "groupTitle": "Sms_Accounts"
24259 "url": "/api/sms/accounts/{id}",
24260 "title": "Deletes a Account",
24263 "title": "Example usage:",
24264 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
24268 "name": "DeleteAccounts",
24269 "group": "Sms_Accounts",
24270 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24271 "version": "0.0.0",
24272 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24273 "groupTitle": "Sms_Accounts"
24277 "url": "/api/sms/accounts/describe",
24278 "title": "Gets table info about Accounts",
24281 "title": "Example usage:",
24282 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
24286 "name": "DescribeAccounts",
24287 "group": "Sms_Accounts",
24288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24289 "version": "0.0.0",
24290 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24291 "groupTitle": "Sms_Accounts"
24295 "url": "/api/sms/accounts",
24296 "title": "Gets a list of Accounts",
24299 "title": "Example usage:",
24300 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
24304 "name": "GetAccounts",
24305 "group": "Sms_Accounts",
24306 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24307 "version": "0.0.0",
24308 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24309 "groupTitle": "Sms_Accounts"
24313 "url": "/api/sms/accounts/{id}/users",
24314 "title": "Gets agents from sms account",
24317 "title": "Example usage:",
24318 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
24322 "name": "GetAgents",
24323 "group": "Sms_Accounts",
24324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24325 "version": "0.0.0",
24326 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24327 "groupTitle": "Sms_Accounts"
24331 "url": "/api/sms/accounts/{id}/users",
24332 "title": "Removes agents from a sms account",
24335 "title": "Example usage:",
24336 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24340 "name": "RemoveAgents",
24341 "group": "Sms_Accounts",
24342 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24343 "version": "0.0.0",
24344 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24345 "groupTitle": "Sms_Accounts"
24349 "url": "/api/sms/accounts/{id}/canned_answers",
24350 "title": "Removes canned answers from account",
24353 "title": "Example usage:",
24354 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24358 "name": "RemoveAnswers",
24359 "group": "Sms_Accounts",
24360 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24361 "version": "0.0.0",
24362 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24363 "groupTitle": "Sms_Accounts"
24367 "url": "/api/sms/accounts/{id}/dispositions",
24368 "title": "Removes dispositions from account",
24371 "title": "Example usage:",
24372 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24376 "name": "RemoveDispositions",
24377 "group": "Sms_Accounts",
24378 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24379 "version": "0.0.0",
24380 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24381 "groupTitle": "Sms_Accounts"
24385 "url": "/api/sms/accounts/{id}",
24386 "title": "Gets a single Account",
24389 "title": "Example usage:",
24390 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
24394 "name": "ShowAccounts",
24395 "group": "Sms_Accounts",
24396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24397 "version": "0.0.0",
24398 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24399 "groupTitle": "Sms_Accounts"
24403 "url": "/ShowSmsAccount",
24404 "title": "Gets a single Account",
24405 "name": "ShowSmsAccount",
24406 "group": "Sms_Accounts",
24414 "field": "options.attributes",
24421 "field": "options.where",
24427 "version": "0.0.0",
24428 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/smsAccount.rpc.js",
24429 "groupTitle": "Sms_Accounts"
24433 "url": "/api/sms/messages/{id}/accept",
24434 "title": "Accepts message",
24437 "title": "Example usage:",
24438 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
24442 "name": "acceptMessage",
24443 "group": "Sms_Accounts",
24444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24445 "version": "0.0.0",
24446 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
24447 "groupTitle": "Sms_Accounts"
24451 "url": "/api/sms/accounts/{id}/canned_answers",
24452 "title": "Creates new canned answer",
24455 "title": "Example usage:",
24456 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24460 "name": "addAnswer",
24461 "group": "Sms_Accounts",
24483 "field": "description",
24496 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24497 "version": "0.0.0",
24498 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24499 "groupTitle": "Sms_Accounts"
24503 "url": "/api/sms/accounts/{id}/applications",
24504 "title": "Creates new applications",
24507 "title": "Example usage:",
24508 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24512 "name": "addApplications",
24513 "group": "Sms_Accounts",
24521 "field": "priority",
24535 "field": "appdata",
24542 "field": "description",
24549 "field": "interval",
24555 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24556 "version": "0.0.0",
24557 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24558 "groupTitle": "Sms_Accounts"
24562 "url": "/api/sms/accounts/{id}/dispositions",
24563 "title": "Creates new disposition",
24566 "title": "Example usage:",
24567 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24571 "name": "addDisposition",
24572 "group": "Sms_Accounts",
24599 "field": "description",
24605 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24606 "version": "0.0.0",
24607 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24608 "groupTitle": "Sms_Accounts"
24612 "url": "/api/sms/accounts/{id}/canned_answers",
24613 "title": "Gets account canned answers",
24616 "title": "Example usage:",
24617 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
24621 "name": "getAnswers",
24622 "group": "Sms_Accounts",
24623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24624 "version": "0.0.0",
24625 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24626 "groupTitle": "Sms_Accounts"
24630 "url": "/api/sms/accounts/{id}/applications",
24631 "title": "Gets account applications",
24634 "title": "Example usage:",
24635 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
24639 "name": "getApplications",
24640 "group": "Sms_Accounts",
24641 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24642 "version": "0.0.0",
24643 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24644 "groupTitle": "Sms_Accounts"
24648 "url": "/api/sms/accounts/{id}/dispositions",
24649 "title": "Gets account dispositions",
24652 "title": "Example usage:",
24653 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
24657 "name": "getDispositions",
24658 "group": "Sms_Accounts",
24659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24660 "version": "0.0.0",
24661 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24662 "groupTitle": "Sms_Accounts"
24666 "url": "/api/sms/accounts/{id}/interactions",
24667 "title": "Gets Sms Account interactions",
24670 "title": "Example usage:",
24671 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
24675 "name": "getInteractions",
24676 "group": "Sms_Accounts",
24677 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24678 "version": "0.0.0",
24679 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24680 "groupTitle": "Sms_Accounts"
24684 "url": "/api/sms/accounts/{id}/notify",
24685 "title": "Notify new message",
24688 "title": "Example usage:",
24689 "content": "curl https://{domain}/api/sms/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24694 "group": "Sms_Accounts",
24695 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new sms message to be sent to the system.</p>",
24696 "version": "0.0.0",
24697 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24698 "groupTitle": "Sms_Accounts"
24702 "url": "/api/sms/messages/{id}/reject",
24703 "title": "Rejects message",
24706 "title": "Example usage:",
24707 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
24711 "name": "rejectMessage",
24712 "group": "Sms_Accounts",
24713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24714 "version": "0.0.0",
24715 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
24716 "groupTitle": "Sms_Accounts"
24720 "url": "/api/sms/accounts/{id}/send",
24721 "title": "Send new sms message",
24724 "title": "Example usage:",
24725 "content": "curl https://{domain}/api/sms/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24730 "group": "Sms_Accounts",
24731 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24732 "version": "0.0.0",
24733 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24734 "groupTitle": "Sms_Accounts"
24738 "url": "/api/sms/accounts/{id}/status",
24739 "title": "Receive message status as get request",
24742 "title": "Example usage:",
24743 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
24747 "name": "statusMessage",
24748 "group": "Sms_Accounts",
24749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24750 "version": "0.0.0",
24751 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24752 "groupTitle": "Sms_Accounts"
24756 "url": "/api/sms/accounts/{id}/status",
24757 "title": "Receive message status",
24760 "title": "Example usage:",
24761 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
24765 "name": "statusMessage",
24766 "group": "Sms_Accounts",
24767 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24768 "version": "0.0.0",
24769 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24770 "groupTitle": "Sms_Accounts"
24774 "url": "/api/sms/messages/{id}/status",
24775 "title": "Receive message status",
24778 "title": "Example usage:",
24779 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
24783 "name": "statusMessage",
24784 "group": "Sms_Accounts",
24785 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24786 "version": "0.0.0",
24787 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
24788 "groupTitle": "Sms_Accounts"
24792 "url": "/api/sms/accounts/{id}",
24793 "title": "Update an existing Account",
24796 "title": "Example usage:",
24797 "content": "curl https://{domain}/api/sms/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24801 "name": "updateAccounts",
24802 "group": "Sms_Accounts",
24803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24804 "version": "0.0.0",
24805 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsAccount/index.js",
24806 "groupTitle": "Sms_Accounts"
24810 "url": "/api/sms/applications",
24811 "title": "Creates a new Application",
24814 "title": "Example usage:",
24815 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24819 "name": "CreateApplications",
24820 "group": "Sms_Applications",
24828 "field": "priority",
24842 "field": "appdata",
24849 "field": "description",
24856 "field": "interval",
24862 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24863 "version": "0.0.0",
24864 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsApplication/index.js",
24865 "groupTitle": "Sms_Applications"
24869 "url": "/api/sms/applications/{id}",
24870 "title": "Deletes a Application",
24873 "title": "Example usage:",
24874 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
24878 "name": "DeleteApplications",
24879 "group": "Sms_Applications",
24880 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24881 "version": "0.0.0",
24882 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsApplication/index.js",
24883 "groupTitle": "Sms_Applications"
24887 "url": "/api/sms/applications",
24888 "title": "Gets a list of Applications",
24891 "title": "Example usage:",
24892 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
24896 "name": "GetApplications",
24897 "group": "Sms_Applications",
24898 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24899 "version": "0.0.0",
24900 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsApplication/index.js",
24901 "groupTitle": "Sms_Applications"
24905 "url": "/api/sms/applications/{id}",
24906 "title": "Gets a single Application",
24909 "title": "Example usage:",
24910 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
24914 "name": "ShowApplications",
24915 "group": "Sms_Applications",
24916 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24917 "version": "0.0.0",
24918 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsApplication/index.js",
24919 "groupTitle": "Sms_Applications"
24923 "url": "/api/sms/applications/{id}",
24924 "title": "Update an existing Application",
24927 "title": "Example usage:",
24928 "content": "curl https://{domain}/api/sms/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24932 "name": "updateApplications",
24933 "group": "Sms_Applications",
24934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24935 "version": "0.0.0",
24936 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsApplication/index.js",
24937 "groupTitle": "Sms_Applications"
24941 "url": "/api/sms/interactions/{id}/tags",
24942 "title": "Add tags to the interaction",
24945 "title": "Example usage:",
24946 "content": "curl https://{domain}/api/sms/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24951 "group": "Sms_Interactions",
24952 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24953 "version": "0.0.0",
24954 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
24955 "groupTitle": "Sms_Interactions"
24959 "url": "/AddTagsToSmsInteraction",
24960 "title": "Add Tags to Sms interaction",
24961 "name": "AddTagsToSmsInteraction",
24962 "group": "Sms_Interactions",
24970 "field": "options.attributes",
24977 "field": "options.where",
24983 "version": "0.0.0",
24984 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/smsInteraction.rpc.js",
24985 "groupTitle": "Sms_Interactions"
24989 "url": "/api/sms/interactions",
24990 "title": "Creates a new Interaction",
24993 "title": "Example usage:",
24994 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24998 "name": "CreateInteractions",
24999 "group": "Sms_Interactions",
25014 "field": "closedAt",
25021 "field": "disposition",
25028 "field": "secondDisposition",
25035 "field": "thirdDisposition",
25056 "field": "read1stAt",
25067 "field": "firstMsgDirection",
25074 "field": "lastMsgAt",
25085 "field": "lastMsgDirection",
25091 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25092 "version": "0.0.0",
25093 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25094 "groupTitle": "Sms_Interactions"
25098 "url": "/api/sms/interactions/{id}",
25099 "title": "Deletes a Interaction",
25102 "title": "Example usage:",
25103 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
25107 "name": "DeleteInteractions",
25108 "group": "Sms_Interactions",
25109 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25110 "version": "0.0.0",
25111 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25112 "groupTitle": "Sms_Interactions"
25116 "url": "/api/sms/interactions/describe",
25117 "title": "Gets table info about Interactions",
25120 "title": "Example usage:",
25121 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
25125 "name": "DescribeInteractions",
25126 "group": "Sms_Interactions",
25127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25128 "version": "0.0.0",
25129 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25130 "groupTitle": "Sms_Interactions"
25134 "url": "/api/sms/interactions",
25135 "title": "Gets a list of Interactions",
25138 "title": "Example usage:",
25139 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
25143 "name": "GetInteractions",
25144 "group": "Sms_Interactions",
25145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25146 "version": "0.0.0",
25147 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25148 "groupTitle": "Sms_Interactions"
25152 "url": "/api/sms/interactions/{id}/tags",
25153 "title": "Removes tags from interaction",
25156 "title": "Example usage:",
25157 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25161 "name": "RemoveTags",
25162 "group": "Sms_Interactions",
25163 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25164 "version": "0.0.0",
25165 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25166 "groupTitle": "Sms_Interactions"
25170 "url": "/api/sms/interactions/{id}",
25171 "title": "Gets a single Interaction",
25174 "title": "Example usage:",
25175 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
25179 "name": "ShowInteractions",
25180 "group": "Sms_Interactions",
25181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25182 "version": "0.0.0",
25183 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25184 "groupTitle": "Sms_Interactions"
25188 "url": "/UpdateSmsInteraction",
25189 "title": "Updates a new Interaction",
25190 "name": "UpdateSmsInteraction",
25191 "group": "Sms_Interactions",
25199 "field": "options.attributes",
25206 "field": "options.where",
25212 "version": "0.0.0",
25213 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/smsInteraction.rpc.js",
25214 "groupTitle": "Sms_Interactions"
25218 "url": "/api/sms/interactions/{id}/messages",
25219 "title": "Creates new messages",
25222 "title": "Example usage:",
25223 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25227 "name": "addMessage",
25228 "group": "Sms_Interactions",
25254 "field": "direction",
25261 "field": "messageId",
25289 "field": "providerName",
25296 "field": "providerResponse",
25302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25303 "version": "0.0.0",
25304 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25305 "groupTitle": "Sms_Interactions"
25309 "url": "/api/sms/interactions/{id}/download",
25310 "title": "Gets interaction",
25313 "title": "Example usage:",
25314 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
25318 "name": "download",
25319 "group": "Sms_Interactions",
25320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25321 "version": "0.0.0",
25322 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25323 "groupTitle": "Sms_Interactions"
25327 "url": "/api/sms/interactions/{id}/messages",
25328 "title": "Gets interaction messages",
25331 "title": "Example usage:",
25332 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
25336 "name": "getMessages",
25337 "group": "Sms_Interactions",
25338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25339 "version": "0.0.0",
25340 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25341 "groupTitle": "Sms_Interactions"
25345 "url": "/api/sms/interactions/{id}",
25346 "title": "Update an existing Interaction",
25349 "title": "Example usage:",
25350 "content": "curl https://{domain}/api/sms/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25354 "name": "updateInteractions",
25355 "group": "Sms_Interactions",
25356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25357 "version": "0.0.0",
25358 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsInteraction/index.js",
25359 "groupTitle": "Sms_Interactions"
25363 "url": "/api/sms/messages",
25364 "title": "Creates a new Message",
25367 "title": "Example usage:",
25368 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25372 "name": "CreateMessages",
25373 "group": "Sms_Messages",
25399 "field": "direction",
25406 "field": "messageId",
25434 "field": "providerName",
25441 "field": "providerResponse",
25447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25448 "version": "0.0.0",
25449 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
25450 "groupTitle": "Sms_Messages"
25454 "url": "/CreateSmsMessage",
25455 "title": "Creates a new Message",
25456 "name": "CreateSmsMessage",
25457 "group": "Sms_Messages",
25458 "version": "0.0.0",
25459 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/smsMessage.rpc.js",
25460 "groupTitle": "Sms_Messages"
25464 "url": "/api/sms/messages/{id}",
25465 "title": "Deletes a Message",
25468 "title": "Example usage:",
25469 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
25473 "name": "DeleteMessages",
25474 "group": "Sms_Messages",
25475 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25476 "version": "0.0.0",
25477 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
25478 "groupTitle": "Sms_Messages"
25482 "url": "/api/sms/messages/describe",
25483 "title": "Gets table info about Messages",
25486 "title": "Example usage:",
25487 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
25491 "name": "DescribeMessages",
25492 "group": "Sms_Messages",
25493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25494 "version": "0.0.0",
25495 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
25496 "groupTitle": "Sms_Messages"
25500 "url": "/api/sms/messages",
25501 "title": "Gets a list of Messages",
25504 "title": "Example usage:",
25505 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
25509 "name": "GetMessages",
25510 "group": "Sms_Messages",
25511 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25512 "version": "0.0.0",
25513 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
25514 "groupTitle": "Sms_Messages"
25518 "url": "/api/sms/messages/{id}",
25519 "title": "Gets a single Message",
25522 "title": "Example usage:",
25523 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
25527 "name": "ShowMessages",
25528 "group": "Sms_Messages",
25529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25530 "version": "0.0.0",
25531 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
25532 "groupTitle": "Sms_Messages"
25536 "url": "/api/sms/messages/{id}",
25537 "title": "Update an existing Message",
25540 "title": "Example usage:",
25541 "content": "curl https://{domain}/api/sms/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25545 "name": "updateMessages",
25546 "group": "Sms_Messages",
25547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25548 "version": "0.0.0",
25549 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsMessage/index.js",
25550 "groupTitle": "Sms_Messages"
25554 "url": "/CreateSmsQueueReport",
25555 "title": "Creates a new Sms Queue Report",
25556 "name": "CreateSmsQueueReport",
25557 "group": "Sms_Queue_Reports",
25558 "version": "0.0.0",
25559 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/smsQueueReport.rpc.js",
25560 "groupTitle": "Sms_Queue_Reports"
25564 "url": "/api/sms/reports/queue",
25565 "title": "Creates a new Sms Queue Report",
25568 "title": "Example usage:",
25569 "content": "curl https://{domain}/api/sms/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25573 "name": "CreateSms_Queue_Reports",
25574 "group": "Sms_Queue_Reports",
25582 "field": "uniqueid",
25603 "field": "leaveAt",
25610 "field": "acceptAt",
25630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25631 "version": "0.0.0",
25632 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/index.js",
25633 "groupTitle": "Sms_Queue_Reports"
25637 "url": "/api/sms/reports/queue/{id}",
25638 "title": "Deletes a Sms Queue Report",
25641 "title": "Example usage:",
25642 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
25646 "name": "DeleteSms_Queue_Reports",
25647 "group": "Sms_Queue_Reports",
25648 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25649 "version": "0.0.0",
25650 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/index.js",
25651 "groupTitle": "Sms_Queue_Reports"
25655 "url": "/api/sms/reports/queue/describe",
25656 "title": "Gets table info about Sms Queue Reports",
25659 "title": "Example usage:",
25660 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
25664 "name": "DescribeSms_Queue_Reports",
25665 "group": "Sms_Queue_Reports",
25666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25667 "version": "0.0.0",
25668 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/index.js",
25669 "groupTitle": "Sms_Queue_Reports"
25673 "url": "/api/sms/reports/queue",
25674 "title": "Gets a list of Sms Queue Reports",
25677 "title": "Example usage:",
25678 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
25682 "name": "GetSms_Queue_Reports",
25683 "group": "Sms_Queue_Reports",
25684 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25685 "version": "0.0.0",
25686 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/index.js",
25687 "groupTitle": "Sms_Queue_Reports"
25691 "url": "/api/sms/reports/queue/{id}",
25692 "title": "Gets a single Sms Queue Report",
25695 "title": "Example usage:",
25696 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
25700 "name": "ShowSms_Queue_Reports",
25701 "group": "Sms_Queue_Reports",
25702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25703 "version": "0.0.0",
25704 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/index.js",
25705 "groupTitle": "Sms_Queue_Reports"
25709 "url": "/UpdateSmsQueueReport",
25710 "title": "Updates a new Sms Queue Report",
25711 "name": "UpdateSmsQueueReport",
25712 "group": "Sms_Queue_Reports",
25720 "field": "options.attributes",
25727 "field": "options.where",
25733 "version": "0.0.0",
25734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/smsQueueReport.rpc.js",
25735 "groupTitle": "Sms_Queue_Reports"
25739 "url": "/api/sms/reports/queue/{id}",
25740 "title": "Update an existing Sms Queue Report",
25743 "title": "Example usage:",
25744 "content": "curl https://{domain}/api/sms/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25748 "name": "updateSms_Queue_Reports",
25749 "group": "Sms_Queue_Reports",
25750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25751 "version": "0.0.0",
25752 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueueReport/index.js",
25753 "groupTitle": "Sms_Queue_Reports"
25757 "url": "/api/sms/queues/{id}/users",
25758 "title": "Add agents to a queue",
25761 "title": "Example usage:",
25762 "content": "curl https://{domain}/api/sms/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25766 "name": "AddAgents",
25767 "group": "Sms_Queues",
25768 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25769 "version": "0.0.0",
25770 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25771 "groupTitle": "Sms_Queues"
25775 "url": "/api/sms/queues/{id}/teams",
25776 "title": "Add teams to a queue",
25779 "title": "Example usage:",
25780 "content": "curl https://{domain}/api/sms/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25784 "name": "AddTeams",
25785 "group": "Sms_Queues",
25786 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25787 "version": "0.0.0",
25788 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25789 "groupTitle": "Sms_Queues"
25793 "url": "/api/sms/queues",
25794 "title": "Creates a new Queue",
25797 "title": "Example usage:",
25798 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25802 "name": "CreateQueues",
25803 "group": "Sms_Queues",
25818 "field": "description",
25825 "field": "timeout",
25837 "field": "strategy",
25843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25844 "version": "0.0.0",
25845 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25846 "groupTitle": "Sms_Queues"
25850 "url": "/api/sms/queues/{id}",
25851 "title": "Deletes a Queue",
25854 "title": "Example usage:",
25855 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
25859 "name": "DeleteQueues",
25860 "group": "Sms_Queues",
25861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25862 "version": "0.0.0",
25863 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25864 "groupTitle": "Sms_Queues"
25868 "url": "/api/sms/queues/describe",
25869 "title": "Gets table info about Queues",
25872 "title": "Example usage:",
25873 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
25877 "name": "DescribeQueues",
25878 "group": "Sms_Queues",
25879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25880 "version": "0.0.0",
25881 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25882 "groupTitle": "Sms_Queues"
25886 "url": "/api/sms/queues/{id}/users",
25887 "title": "Gets queue agents",
25890 "title": "Example usage:",
25891 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
25895 "name": "GetAgents",
25896 "group": "Sms_Queues",
25897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25898 "version": "0.0.0",
25899 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25900 "groupTitle": "Sms_Queues"
25904 "url": "/api/sms/queues/{id}/members",
25905 "title": "GetMembers",
25908 "title": "Example usage:",
25909 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
25913 "name": "GetMembers",
25914 "group": "Sms_Queues",
25915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25916 "version": "0.0.0",
25917 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25918 "groupTitle": "Sms_Queues"
25922 "url": "/api/sms/queues",
25923 "title": "Gets a list of Queues",
25926 "title": "Example usage:",
25927 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
25931 "name": "GetQueues",
25932 "group": "Sms_Queues",
25933 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25934 "version": "0.0.0",
25935 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25936 "groupTitle": "Sms_Queues"
25940 "url": "/GetSmsQueue",
25941 "title": "Gets a list of Queues",
25942 "name": "GetSmsQueue",
25943 "group": "Sms_Queues",
25951 "field": "options.attributes",
25958 "field": "options.where",
25964 "version": "0.0.0",
25965 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/smsQueue.rpc.js",
25966 "groupTitle": "Sms_Queues"
25970 "url": "/api/sms/queues/{id}/teams",
25971 "title": "Gets queues list",
25974 "title": "Example usage:",
25975 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
25979 "name": "GetTeams",
25980 "group": "Sms_Queues",
25981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25982 "version": "0.0.0",
25983 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
25984 "groupTitle": "Sms_Queues"
25988 "url": "/api/sms/queues/{id}/users",
25989 "title": "Removes agents from a queue",
25992 "title": "Example usage:",
25993 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25997 "name": "RemoveAgents",
25998 "group": "Sms_Queues",
25999 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26000 "version": "0.0.0",
26001 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
26002 "groupTitle": "Sms_Queues"
26006 "url": "/api/sms/queues/{id}",
26007 "title": "Gets a single Queue",
26010 "title": "Example usage:",
26011 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
26015 "name": "ShowQueues",
26016 "group": "Sms_Queues",
26017 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26018 "version": "0.0.0",
26019 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
26020 "groupTitle": "Sms_Queues"
26024 "url": "/ShowSmsQueue",
26025 "title": "Gets a single Queue",
26026 "name": "ShowSmsQueue",
26027 "group": "Sms_Queues",
26035 "field": "options.attributes",
26042 "field": "options.where",
26048 "version": "0.0.0",
26049 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/smsQueue.rpc.js",
26050 "groupTitle": "Sms_Queues"
26054 "url": "/api/sms/queues/{id}",
26055 "title": "Update an existing Queue",
26058 "title": "Example usage:",
26059 "content": "curl https://{domain}/api/sms/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26063 "name": "updateQueues",
26064 "group": "Sms_Queues",
26065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066 "version": "0.0.0",
26067 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
26068 "groupTitle": "Sms_Queues"
26072 "url": "/api/sms/reports/transfer",
26073 "title": "Creates a new Sms Transfer Report",
26076 "title": "Example usage:",
26077 "content": "curl https://{domain}/api/sms/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26081 "name": "CreateSms_Transfer_Reports",
26082 "group": "Sms_Transfer_Reports",
26090 "field": "uniqueid",
26109 "field": "transferredAt",
26115 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26116 "version": "0.0.0",
26117 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsTransferReport/index.js",
26118 "groupTitle": "Sms_Transfer_Reports"
26122 "url": "/api/sms/reports/transfer/{id}",
26123 "title": "Deletes a Sms Transfer Report",
26126 "title": "Example usage:",
26127 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
26131 "name": "DeleteSms_Transfer_Reports",
26132 "group": "Sms_Transfer_Reports",
26133 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26134 "version": "0.0.0",
26135 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsTransferReport/index.js",
26136 "groupTitle": "Sms_Transfer_Reports"
26140 "url": "/api/sms/reports/transfer/describe",
26141 "title": "Gets table info about Sms Transfer Reports",
26144 "title": "Example usage:",
26145 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
26149 "name": "DescribeSms_Transfer_Reports",
26150 "group": "Sms_Transfer_Reports",
26151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26152 "version": "0.0.0",
26153 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsTransferReport/index.js",
26154 "groupTitle": "Sms_Transfer_Reports"
26158 "url": "/api/sms/reports/transfer",
26159 "title": "Gets a list of Sms Transfer Reports",
26162 "title": "Example usage:",
26163 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
26167 "name": "GetSms_Transfer_Reports",
26168 "group": "Sms_Transfer_Reports",
26169 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26170 "version": "0.0.0",
26171 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsTransferReport/index.js",
26172 "groupTitle": "Sms_Transfer_Reports"
26176 "url": "/api/sms/reports/transfer/{id}",
26177 "title": "Gets a single Sms Transfer Report",
26180 "title": "Example usage:",
26181 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
26185 "name": "ShowSms_Transfer_Reports",
26186 "group": "Sms_Transfer_Reports",
26187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26188 "version": "0.0.0",
26189 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsTransferReport/index.js",
26190 "groupTitle": "Sms_Transfer_Reports"
26194 "url": "/api/sms/reports/transfer/{id}",
26195 "title": "Update an existing Sms Transfer Report",
26198 "title": "Example usage:",
26199 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26203 "name": "updateSms_Transfer_Reports",
26204 "group": "Sms_Transfer_Reports",
26205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26206 "version": "0.0.0",
26207 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsTransferReport/index.js",
26208 "groupTitle": "Sms_Transfer_Reports"
26212 "url": "/api/sounds",
26213 "title": "Gets a list of Sounds",
26216 "title": "Example usage:",
26217 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
26221 "name": "GetSounds",
26223 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sounds?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sounds?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sounds?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sounds?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sounds?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26224 "version": "0.0.0",
26225 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/index.js",
26226 "groupTitle": "Sounds"
26230 "url": "/ShowSound",
26231 "title": "Gets a single Sound",
26232 "name": "ShowSound",
26241 "field": "options.attributes",
26248 "field": "options.where",
26254 "version": "0.0.0",
26255 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/sound.rpc.js",
26256 "groupTitle": "Sounds"
26260 "url": "/api/sounds/{id}",
26261 "title": "Gets a single Sound",
26264 "title": "Example usage:",
26265 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
26269 "name": "ShowSounds",
26271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26272 "version": "0.0.0",
26273 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/index.js",
26274 "groupTitle": "Sounds"
26278 "url": "/api/sounds",
26279 "title": "Create a new sound",
26282 "title": "Example usage:",
26283 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
26287 "name": "addSound",
26289 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26290 "version": "0.0.0",
26291 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/index.js",
26292 "groupTitle": "Sounds"
26296 "url": "/api/sounds/{id}",
26297 "title": "Deletes a sound",
26300 "title": "Example usage:",
26301 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
26305 "name": "destroySound",
26307 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26308 "version": "0.0.0",
26309 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/index.js",
26310 "groupTitle": "Sounds"
26314 "url": "/api/sounds/{id}/download",
26315 "title": "Download Sound",
26318 "title": "Example usage:",
26319 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
26323 "name": "download",
26325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26326 "version": "0.0.0",
26327 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/index.js",
26328 "groupTitle": "Sounds"
26332 "url": "/api/sounds",
26333 "title": "Update an existing new sound",
26336 "title": "Example usage:",
26337 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
26341 "name": "updateSound",
26343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26344 "version": "0.0.0",
26345 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/sound/index.js",
26346 "groupTitle": "Sounds"
26350 "url": "/CreateSquareDetailsReport",
26351 "title": "Creates a new Square Detail Report",
26352 "name": "CreateSquareDetailsReport",
26353 "group": "Square_Details_Reports",
26354 "version": "0.0.0",
26355 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/squareReportDetail.rpc.js",
26356 "groupTitle": "Square_Details_Reports"
26360 "url": "/api/square/details/reports",
26361 "title": "Creates a new Square Detail Report",
26364 "title": "Example usage:",
26365 "content": "curl https://{domain}/api/square/details/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26369 "name": "CreateSquare_Detail_Reports",
26370 "group": "Square_Details_Reports",
26378 "field": "uniqueid",
26392 "field": "application",
26406 "field": "project_name",
26413 "field": "callerid",
26419 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26420 "version": "0.0.0",
26421 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/index.js",
26422 "groupTitle": "Square_Details_Reports"
26426 "url": "/api/square/details/reports/{id}",
26427 "title": "Deletes a Square Detail Report",
26430 "title": "Example usage:",
26431 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
26435 "name": "DeleteSquare_Detail_Reports",
26436 "group": "Square_Details_Reports",
26437 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26438 "version": "0.0.0",
26439 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/index.js",
26440 "groupTitle": "Square_Details_Reports"
26444 "url": "/api/square/details/reports/describe",
26445 "title": "Gets table info about Square Detail Reports",
26448 "title": "Example usage:",
26449 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
26453 "name": "DescribeSquare_Detail_Reports",
26454 "group": "Square_Details_Reports",
26455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26456 "version": "0.0.0",
26457 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/index.js",
26458 "groupTitle": "Square_Details_Reports"
26462 "url": "/api/square/details/reports",
26463 "title": "Gets a list of Square Detail Reports",
26466 "title": "Example usage:",
26467 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
26471 "name": "GetSquare_Detail_Reports",
26472 "group": "Square_Details_Reports",
26473 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/details/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/details/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/details/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/details/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/details/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26474 "version": "0.0.0",
26475 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/index.js",
26476 "groupTitle": "Square_Details_Reports"
26480 "url": "/api/square/details/reports/{id}",
26481 "title": "Gets a single Square Detail Report",
26484 "title": "Example usage:",
26485 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
26489 "name": "ShowSquare_Detail_Reports",
26490 "group": "Square_Details_Reports",
26491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26492 "version": "0.0.0",
26493 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/index.js",
26494 "groupTitle": "Square_Details_Reports"
26498 "url": "/api/square/details/reports/{id}",
26499 "title": "Update an existing Square Detail Report",
26502 "title": "Example usage:",
26503 "content": "curl https://{domain}/api/square/details/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26507 "name": "updateSquare_Detail_Reports",
26508 "group": "Square_Details_Reports",
26509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26510 "version": "0.0.0",
26511 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReportDetail/index.js",
26512 "groupTitle": "Square_Details_Reports"
26516 "url": "/api/square/messages",
26517 "title": "Creates a new Message",
26520 "title": "Example usage:",
26521 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26525 "name": "CreateMessages",
26526 "group": "Square_Messages",
26534 "field": "uniqueid",
26552 "field": "direction",
26559 "field": "providerName",
26566 "field": "providerResponse",
26572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26573 "version": "0.0.0",
26574 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareMessage/index.js",
26575 "groupTitle": "Square_Messages"
26579 "url": "/CreateSquareMessage",
26580 "title": "Creates a new Message",
26581 "name": "CreateSquareMessage",
26582 "group": "Square_Messages",
26583 "version": "0.0.0",
26584 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareMessage/squareMessage.rpc.js",
26585 "groupTitle": "Square_Messages"
26589 "url": "/api/square/messages/{id}",
26590 "title": "Deletes a Message",
26593 "title": "Example usage:",
26594 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
26598 "name": "DeleteMessages",
26599 "group": "Square_Messages",
26600 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26601 "version": "0.0.0",
26602 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareMessage/index.js",
26603 "groupTitle": "Square_Messages"
26607 "url": "/api/square/messages",
26608 "title": "Gets a list of Messages",
26611 "title": "Example usage:",
26612 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
26616 "name": "GetMessages",
26617 "group": "Square_Messages",
26618 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26619 "version": "0.0.0",
26620 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareMessage/index.js",
26621 "groupTitle": "Square_Messages"
26625 "url": "/api/square/messages/{id}",
26626 "title": "Gets a single Message",
26629 "title": "Example usage:",
26630 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
26634 "name": "ShowMessages",
26635 "group": "Square_Messages",
26636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26637 "version": "0.0.0",
26638 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareMessage/index.js",
26639 "groupTitle": "Square_Messages"
26643 "url": "/api/square/messages/{id}",
26644 "title": "Update an existing Message",
26647 "title": "Example usage:",
26648 "content": "curl https://{domain}/api/square/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26652 "name": "updateMessages",
26653 "group": "Square_Messages",
26654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26655 "version": "0.0.0",
26656 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareMessage/index.js",
26657 "groupTitle": "Square_Messages"
26661 "url": "/api/square/odbc",
26662 "title": "Creates a new ODBC",
26665 "title": "Example usage:",
26666 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26670 "name": "CreateODBCs",
26671 "group": "Square_ODBC",
26693 "field": "description",
26699 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26700 "version": "0.0.0",
26701 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/index.js",
26702 "groupTitle": "Square_ODBC"
26706 "url": "/api/square/odbc/{id}",
26707 "title": "Deletes a ODBC",
26710 "title": "Example usage:",
26711 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
26715 "name": "DeleteODBCs",
26716 "group": "Square_ODBC",
26717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26718 "version": "0.0.0",
26719 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/index.js",
26720 "groupTitle": "Square_ODBC"
26724 "url": "/api/square/odbc",
26725 "title": "Gets a list of ODBCs",
26728 "title": "Example usage:",
26729 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
26733 "name": "GetODBCs",
26734 "group": "Square_ODBC",
26735 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/odbc?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/odbc?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/odbc?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/odbc?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/odbc?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26736 "version": "0.0.0",
26737 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/index.js",
26738 "groupTitle": "Square_ODBC"
26742 "url": "/api/square/odbc/{id}",
26743 "title": "Gets a single ODBC",
26746 "title": "Example usage:",
26747 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
26751 "name": "ShowODBCs",
26752 "group": "Square_ODBC",
26753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26754 "version": "0.0.0",
26755 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/index.js",
26756 "groupTitle": "Square_ODBC"
26760 "url": "/ShowSquareOdbc",
26761 "title": "Gets a single ODBC",
26762 "name": "ShowSquareOdbc",
26763 "group": "Square_ODBC",
26771 "field": "options.attributes",
26778 "field": "options.where",
26784 "version": "0.0.0",
26785 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/squareOdbc.rpc.js",
26786 "groupTitle": "Square_ODBC"
26790 "url": "/api/square/odbc/{id}/test",
26791 "title": "Test Odbc",
26794 "title": "Example usage:",
26795 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
26800 "group": "Square_ODBC",
26801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26802 "version": "0.0.0",
26803 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/index.js",
26804 "groupTitle": "Square_ODBC"
26808 "url": "/api/square/odbc/{id}",
26809 "title": "Update an existing ODBC",
26812 "title": "Example usage:",
26813 "content": "curl https://{domain}/api/square/odbc/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26817 "name": "updateODBCs",
26818 "group": "Square_ODBC",
26819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26820 "version": "0.0.0",
26821 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareOdbc/index.js",
26822 "groupTitle": "Square_ODBC"
26826 "url": "/api/square/projects",
26827 "title": "Creates a new Project",
26830 "title": "Example usage:",
26831 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26835 "name": "CreateProjects",
26836 "group": "Square_Projects",
26851 "field": "description",
26865 "field": "preproduction",
26872 "field": "production",
26878 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26879 "version": "0.0.0",
26880 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
26881 "groupTitle": "Square_Projects"
26885 "url": "/api/square/projects/{id}",
26886 "title": "Deletes a Project",
26889 "title": "Example usage:",
26890 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
26894 "name": "DeleteProjects",
26895 "group": "Square_Projects",
26896 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26897 "version": "0.0.0",
26898 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
26899 "groupTitle": "Square_Projects"
26903 "url": "/api/square/projects",
26904 "title": "Gets a list of Projects",
26907 "title": "Example usage:",
26908 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
26912 "name": "GetProjects",
26913 "group": "Square_Projects",
26914 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/projects?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26915 "version": "0.0.0",
26916 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
26917 "groupTitle": "Square_Projects"
26921 "url": "/api/square/projects/{id}",
26922 "title": "Gets a single Project",
26925 "title": "Example usage:",
26926 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
26930 "name": "ShowProjects",
26931 "group": "Square_Projects",
26932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26933 "version": "0.0.0",
26934 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
26935 "groupTitle": "Square_Projects"
26939 "url": "/ShowSquareProject",
26940 "title": "Gets a single Project",
26941 "name": "ShowSquareProject",
26942 "group": "Square_Projects",
26950 "field": "options.attributes",
26957 "field": "options.where",
26963 "version": "0.0.0",
26964 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/squareProject.rpc.js",
26965 "groupTitle": "Square_Projects"
26969 "url": "/api/square/projects/{id}/users",
26970 "title": "Adds user permissions to a Project",
26973 "title": "Example usage:",
26974 "content": "curl https://{domain}/api/square/projects/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26978 "name": "addUsers",
26979 "group": "Square_Projects",
26980 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26981 "version": "0.0.0",
26982 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
26983 "groupTitle": "Square_Projects"
26987 "url": "/api/square/projects/{id}/users",
26988 "title": "Gets users permissions from Project",
26991 "title": "Example usage:",
26992 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
26996 "name": "getUsers",
26997 "group": "Square_Projects",
26998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26999 "version": "0.0.0",
27000 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
27001 "groupTitle": "Square_Projects"
27005 "url": "/api/square/projects/{id}/users",
27006 "title": "Removes user permissions from a Project",
27009 "title": "Example usage:",
27010 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27014 "name": "removeUsers",
27015 "group": "Square_Projects",
27016 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27017 "version": "0.0.0",
27018 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
27019 "groupTitle": "Square_Projects"
27023 "url": "/api/square/projects/{id}",
27024 "title": "Update an existing Project",
27027 "title": "Example usage:",
27028 "content": "curl https://{domain}/api/square/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27032 "name": "updateProjects",
27033 "group": "Square_Projects",
27034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27035 "version": "0.0.0",
27036 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareProject/index.js",
27037 "groupTitle": "Square_Projects"
27041 "url": "/api/square/recordings",
27042 "title": "Creates a new Recording",
27045 "title": "Example usage:",
27046 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27050 "name": "CreateRecordings",
27051 "group": "Square_Recordings",
27059 "field": "uniqueid",
27066 "field": "callerid",
27073 "field": "calleridname",
27080 "field": "context",
27087 "field": "extension",
27094 "field": "priority",
27101 "field": "accountcode",
27115 "field": "projectName",
27122 "field": "saveName",
27129 "field": "filename",
27136 "field": "savePath",
27149 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27150 "version": "0.0.0",
27151 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/index.js",
27152 "groupTitle": "Square_Recordings"
27156 "url": "/CreateSquareRecording",
27157 "title": "Creates a new Recording",
27158 "name": "CreateSquareRecording",
27159 "group": "Square_Recordings",
27160 "version": "0.0.0",
27161 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/squareRecording.rpc.js",
27162 "groupTitle": "Square_Recordings"
27166 "url": "/api/square/recordings",
27167 "title": "Gets a list of Recordings",
27170 "title": "Example usage:",
27171 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
27175 "name": "GetRecordings",
27176 "group": "Square_Recordings",
27177 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/recordings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
27178 "version": "0.0.0",
27179 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/index.js",
27180 "groupTitle": "Square_Recordings"
27184 "url": "/api/square/recordings/{id}",
27185 "title": "Gets a single Recording",
27188 "title": "Example usage:",
27189 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
27193 "name": "ShowRecordings",
27194 "group": "Square_Recordings",
27195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27196 "version": "0.0.0",
27197 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/index.js",
27198 "groupTitle": "Square_Recordings"
27202 "url": "/api/square/recordings/{id}/delete",
27203 "title": "Delete recording",
27206 "title": "Example usage:",
27207 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
27212 "group": "Square_Recordings",
27213 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27214 "version": "0.0.0",
27215 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/index.js",
27216 "groupTitle": "Square_Recordings"
27220 "url": "/api/square/recordings/{id}/download",
27221 "title": "Download Recording",
27224 "title": "Example usage:",
27225 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
27229 "name": "download",
27230 "group": "Square_Recordings",
27231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27232 "version": "0.0.0",
27233 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/index.js",
27234 "groupTitle": "Square_Recordings"
27238 "url": "/api/square/recordings/{id}",
27239 "title": "Update an existing Recording",
27242 "title": "Example usage:",
27243 "content": "curl https://{domain}/api/square/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27247 "name": "updateRecordings",
27248 "group": "Square_Recordings",
27249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27250 "version": "0.0.0",
27251 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareRecording/index.js",
27252 "groupTitle": "Square_Recordings"
27256 "url": "/CreateSquareReport",
27257 "title": "Creates a new Square Report",
27258 "name": "CreateSquareReport",
27259 "group": "Square_Reports",
27260 "version": "0.0.0",
27261 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/squareReport.rpc.js",
27262 "groupTitle": "Square_Reports"
27266 "url": "/api/square/reports",
27267 "title": "Creates a new Square Report",
27270 "title": "Example usage:",
27271 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27275 "name": "CreateSquare_Reports",
27276 "group": "Square_Reports",
27284 "field": "network",
27291 "field": "network_script",
27298 "field": "request",
27305 "field": "channel",
27312 "field": "language",
27326 "field": "uniqueid",
27333 "field": "version",
27340 "field": "callerid",
27347 "field": "calleridname",
27354 "field": "callingpres",
27361 "field": "callingani2",
27368 "field": "callington",
27375 "field": "callingtns",
27396 "field": "context",
27403 "field": "extension",
27410 "field": "priority",
27417 "field": "enhanced",
27424 "field": "accountcode",
27431 "field": "threadid",
27438 "field": "project_name",
27452 "field": "leaveAt",
27465 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27466 "version": "0.0.0",
27467 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/index.js",
27468 "groupTitle": "Square_Reports"
27472 "url": "/api/square/reports/{id}",
27473 "title": "Deletes a Square Report",
27476 "title": "Example usage:",
27477 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
27481 "name": "DeleteSquare_Reports",
27482 "group": "Square_Reports",
27483 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27484 "version": "0.0.0",
27485 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/index.js",
27486 "groupTitle": "Square_Reports"
27490 "url": "/api/square/reports/describe",
27491 "title": "Gets table info about Square Reports",
27494 "title": "Example usage:",
27495 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
27499 "name": "DescribeSquare_Reports",
27500 "group": "Square_Reports",
27501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27502 "version": "0.0.0",
27503 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/index.js",
27504 "groupTitle": "Square_Reports"
27508 "url": "/api/square/reports",
27509 "title": "Gets a list of Square Reports",
27512 "title": "Example usage:",
27513 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
27517 "name": "GetSquare_Reports",
27518 "group": "Square_Reports",
27519 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
27520 "version": "0.0.0",
27521 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/index.js",
27522 "groupTitle": "Square_Reports"
27526 "url": "/api/square/reports/{id}",
27527 "title": "Gets a single Square Report",
27530 "title": "Example usage:",
27531 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
27535 "name": "ShowSquare_Reports",
27536 "group": "Square_Reports",
27537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27538 "version": "0.0.0",
27539 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/index.js",
27540 "groupTitle": "Square_Reports"
27544 "url": "/UpdateSquareReport",
27545 "title": "Updates a new Square Report",
27546 "name": "UpdateSquareReport",
27547 "group": "Square_Reports",
27555 "field": "options.attributes",
27562 "field": "options.where",
27568 "version": "0.0.0",
27569 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/squareReport.rpc.js",
27570 "groupTitle": "Square_Reports"
27574 "url": "/api/square/reports/{id}",
27575 "title": "Update an existing Square Report",
27578 "title": "Example usage:",
27579 "content": "curl https://{domain}/api/square/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27583 "name": "updateSquare_Reports",
27584 "group": "Square_Reports",
27585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27586 "version": "0.0.0",
27587 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/squareReport/index.js",
27588 "groupTitle": "Square_Reports"
27592 "url": "/api/integrations/sugarcrm/configurations",
27593 "title": "Creates a new SugarCRM Configuration",
27596 "title": "Example usage:",
27597 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27601 "name": "CreateSugarCRM_Configurations",
27602 "group": "SugarCRM_Configurations",
27617 "field": "description",
27623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27624 "version": "0.0.0",
27625 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27626 "groupTitle": "SugarCRM_Configurations"
27630 "url": "/api/integrations/sugarcrm/configurations/{id}",
27631 "title": "Deletes a SugarCRM Configuration",
27634 "title": "Example usage:",
27635 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
27639 "name": "DeleteSugarCRM_Configurations",
27640 "group": "SugarCRM_Configurations",
27641 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27642 "version": "0.0.0",
27643 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27644 "groupTitle": "SugarCRM_Configurations"
27648 "url": "/api/integrations/sugarcrm/configurations",
27649 "title": "Gets a list of SugarCRM Configurations",
27652 "title": "Example usage:",
27653 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
27657 "name": "GetSugarCRM_Configurations",
27658 "group": "SugarCRM_Configurations",
27659 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
27660 "version": "0.0.0",
27661 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27662 "groupTitle": "SugarCRM_Configurations"
27666 "url": "/api/integrations/sugarcrm/configurations/{id}",
27667 "title": "Gets a single SugarCRM Configuration",
27670 "title": "Example usage:",
27671 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
27675 "name": "ShowSugarCRM_Configurations",
27676 "group": "SugarCRM_Configurations",
27677 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27678 "version": "0.0.0",
27679 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27680 "groupTitle": "SugarCRM_Configurations"
27684 "url": "/api/integrations/sugarcrm/configurations/{id}",
27685 "title": "Update an existing SugarCRM Configuration",
27688 "title": "Example usage:",
27689 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27693 "name": "updateSugarCRM_Configurations",
27694 "group": "SugarCRM_Configurations",
27695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27696 "version": "0.0.0",
27697 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27698 "groupTitle": "SugarCRM_Configurations"
27702 "url": "/api/integrations/sugarcrm/accounts",
27703 "title": "Creates a new Sugarcrm Account",
27706 "title": "Example usage:",
27707 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27711 "name": "CreateSugarcrm_Accounts",
27712 "group": "Sugarcrm_Accounts",
27727 "field": "description",
27734 "field": "username",
27741 "field": "password",
27748 "field": "remoteUri",
27755 "field": "serverUrl",
27761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27762 "version": "0.0.0",
27763 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27764 "groupTitle": "Sugarcrm_Accounts"
27768 "url": "/api/integrations/sugarcrm/accounts/{id}",
27769 "title": "Deletes a Sugarcrm Account",
27772 "title": "Example usage:",
27773 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
27777 "name": "DeleteSugarcrm_Accounts",
27778 "group": "Sugarcrm_Accounts",
27779 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27780 "version": "0.0.0",
27781 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27782 "groupTitle": "Sugarcrm_Accounts"
27786 "url": "/GetSugarcrmAccount",
27787 "title": "Gets a list of Sugarcrm Accounts",
27788 "name": "GetSugarcrmAccount",
27789 "group": "Sugarcrm_Accounts",
27797 "field": "options.attributes",
27804 "field": "options.where",
27810 "version": "0.0.0",
27811 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/intSugarcrmAccount.rpc.js",
27812 "groupTitle": "Sugarcrm_Accounts"
27816 "url": "/api/integrations/sugarcrm/accounts",
27817 "title": "Gets a list of Sugarcrm Accounts",
27820 "title": "Example usage:",
27821 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
27825 "name": "GetSugarcrm_Accounts",
27826 "group": "Sugarcrm_Accounts",
27827 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
27828 "version": "0.0.0",
27829 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27830 "groupTitle": "Sugarcrm_Accounts"
27834 "url": "/ShowSugarcrmAccount",
27835 "title": "Gets a single Sugarcrm Account",
27836 "name": "ShowSugarcrmAccount",
27837 "group": "Sugarcrm_Accounts",
27845 "field": "options.attributes",
27852 "field": "options.where",
27858 "version": "0.0.0",
27859 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/intSugarcrmAccount.rpc.js",
27860 "groupTitle": "Sugarcrm_Accounts"
27864 "url": "/api/integrations/sugarcrm/accounts/{id}",
27865 "title": "Gets a single Sugarcrm Account",
27868 "title": "Example usage:",
27869 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
27873 "name": "ShowSugarcrm_Accounts",
27874 "group": "Sugarcrm_Accounts",
27875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27876 "version": "0.0.0",
27877 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27878 "groupTitle": "Sugarcrm_Accounts"
27882 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
27883 "title": "Creates new configuration",
27886 "title": "Example usage:",
27887 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27891 "name": "addConfiguration",
27892 "group": "Sugarcrm_Accounts",
27893 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27894 "version": "0.0.0",
27895 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27896 "groupTitle": "Sugarcrm_Accounts"
27900 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
27901 "title": "Gets account configurations",
27904 "title": "Example usage:",
27905 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
27909 "name": "getConfigurations",
27910 "group": "Sugarcrm_Accounts",
27911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27912 "version": "0.0.0",
27913 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27914 "groupTitle": "Sugarcrm_Accounts"
27918 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
27919 "title": "Gets account fields",
27922 "title": "Example usage:",
27923 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
27927 "name": "getFields",
27928 "group": "Sugarcrm_Accounts",
27929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27930 "version": "0.0.0",
27931 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27932 "groupTitle": "Sugarcrm_Accounts"
27936 "url": "/api/integrations/sugarcrm/accounts/{id}",
27937 "title": "Update an existing Sugarcrm Account",
27940 "title": "Example usage:",
27941 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27945 "name": "updateSugarcrm_Accounts",
27946 "group": "Sugarcrm_Accounts",
27947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27948 "version": "0.0.0",
27949 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmAccount/index.js",
27950 "groupTitle": "Sugarcrm_Accounts"
27954 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
27955 "title": "Gets configurations descriptions",
27958 "title": "Example usage:",
27959 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
27963 "name": "getDescriptions",
27964 "group": "Sugarcrm_Configurations",
27965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27966 "version": "0.0.0",
27967 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27968 "groupTitle": "Sugarcrm_Configurations"
27972 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
27973 "title": "Gets configurations fields",
27976 "title": "Example usage:",
27977 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
27981 "name": "getFields",
27982 "group": "Sugarcrm_Configurations",
27983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27984 "version": "0.0.0",
27985 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
27986 "groupTitle": "Sugarcrm_Configurations"
27990 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
27991 "title": "Gets configurations subjects",
27994 "title": "Example usage:",
27995 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
27999 "name": "getSubjects",
28000 "group": "Sugarcrm_Configurations",
28001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28002 "version": "0.0.0",
28003 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmConfiguration/index.js",
28004 "groupTitle": "Sugarcrm_Configurations"
28008 "url": "/api/integrations/sugarcrm/fields",
28009 "title": "Creates a new Sugarcrm Field",
28012 "title": "Example usage:",
28013 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28017 "name": "CreateSugarcrm_Fields",
28018 "group": "Sugarcrm_Fields",
28028 "\"customVariable\"",
28039 "field": "content",
28055 "\"customVariable\""
28058 "field": "keyType",
28065 "field": "keyContent",
28072 "field": "idField",
28079 "field": "nameField",
28086 "field": "customField",
28093 "field": "variableName",
28099 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28100 "version": "0.0.0",
28101 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmField/index.js",
28102 "groupTitle": "Sugarcrm_Fields"
28106 "url": "/api/integrations/sugarcrm/fields/{id}",
28107 "title": "Deletes a Sugarcrm Field",
28110 "title": "Example usage:",
28111 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
28115 "name": "DeleteSugarcrm_Fields",
28116 "group": "Sugarcrm_Fields",
28117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28118 "version": "0.0.0",
28119 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmField/index.js",
28120 "groupTitle": "Sugarcrm_Fields"
28124 "url": "/api/integrations/sugarcrm/fields",
28125 "title": "Gets a list of Sugarcrm Fields",
28128 "title": "Example usage:",
28129 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
28133 "name": "GetSugarcrm_Fields",
28134 "group": "Sugarcrm_Fields",
28135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28136 "version": "0.0.0",
28137 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmField/index.js",
28138 "groupTitle": "Sugarcrm_Fields"
28142 "url": "/api/integrations/sugarcrm/fields/{id}",
28143 "title": "Gets a single Sugarcrm Field",
28146 "title": "Example usage:",
28147 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
28151 "name": "ShowSugarcrm_Fields",
28152 "group": "Sugarcrm_Fields",
28153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28154 "version": "0.0.0",
28155 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmField/index.js",
28156 "groupTitle": "Sugarcrm_Fields"
28160 "url": "/api/integrations/sugarcrm/fields/{id}",
28161 "title": "Update an existing Sugarcrm Field",
28164 "title": "Example usage:",
28165 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28169 "name": "updateSugarcrm_Fields",
28170 "group": "Sugarcrm_Fields",
28171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28172 "version": "0.0.0",
28173 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intSugarcrmField/index.js",
28174 "groupTitle": "Sugarcrm_Fields"
28178 "url": "/api/system",
28179 "title": "Gets system information",
28182 "title": "Example usage:",
28183 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
28187 "name": "GetSystemInformation",
28188 "group": "System_Information",
28189 "description": "<p>Motion returns the system information.</p>",
28190 "version": "0.0.0",
28191 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/system/index.js",
28192 "groupTitle": "System_Information"
28196 "url": "/api/system/process",
28197 "title": "Gets system information",
28200 "title": "Example usage:",
28201 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
28205 "name": "GetSystemInformation",
28206 "group": "System_Information",
28207 "description": "<p>Motion returns the system information.</p>",
28208 "version": "0.0.0",
28209 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/system/index.js",
28210 "groupTitle": "System_Information"
28214 "url": "/api/tags",
28215 "title": "Creates a new Tag",
28218 "title": "Example usage:",
28219 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28223 "name": "CreateTags",
28246 "field": "description",
28252 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28253 "version": "0.0.0",
28254 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/tag/index.js",
28255 "groupTitle": "Tags"
28259 "url": "/api/tags/{id}",
28260 "title": "Deletes a Tag",
28263 "title": "Example usage:",
28264 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
28268 "name": "DeleteTags",
28270 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28271 "version": "0.0.0",
28272 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/tag/index.js",
28273 "groupTitle": "Tags"
28277 "url": "/api/tags",
28278 "title": "Gets a list of Tags",
28281 "title": "Example usage:",
28282 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
28288 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/tags?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/tags?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/tags?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/tags?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/tags?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28289 "version": "0.0.0",
28290 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/tag/index.js",
28291 "groupTitle": "Tags"
28295 "url": "/api/tags/{id}",
28296 "title": "Gets a single Tag",
28299 "title": "Example usage:",
28300 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
28304 "name": "ShowTags",
28306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28307 "version": "0.0.0",
28308 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/tag/index.js",
28309 "groupTitle": "Tags"
28313 "url": "/api/tags/{id}",
28314 "title": "Update an existing Tag",
28317 "title": "Example usage:",
28318 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28322 "name": "updateTags",
28324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28325 "version": "0.0.0",
28326 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/tag/index.js",
28327 "groupTitle": "Tags"
28331 "url": "/api/teams/{id}/queues",
28332 "title": "Add queues to a team",
28335 "title": "Example usage:",
28336 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28340 "name": "AddQueues",
28342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28343 "version": "0.0.0",
28344 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28345 "groupTitle": "Teams"
28349 "url": "/api/teams",
28350 "title": "Creates a new Team",
28353 "title": "Example usage:",
28354 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28358 "name": "CreateTeams",
28374 "field": "description",
28380 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28381 "version": "0.0.0",
28382 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28383 "groupTitle": "Teams"
28387 "url": "/api/teams/{id}",
28388 "title": "Deletes a Team",
28391 "title": "Example usage:",
28392 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
28396 "name": "DeleteTeams",
28398 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28399 "version": "0.0.0",
28400 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28401 "groupTitle": "Teams"
28405 "url": "/api/teams/{id}/users",
28406 "title": "Gets agents from team",
28409 "title": "Example usage:",
28410 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
28414 "name": "GetAgents",
28416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28417 "version": "0.0.0",
28418 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28419 "groupTitle": "Teams"
28423 "url": "/api/teams/{id}/queues?channel={channel}",
28424 "title": "Gets Queues list",
28427 "title": "Example usage:",
28428 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
28432 "name": "GetQueues",
28434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28435 "version": "0.0.0",
28436 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28437 "groupTitle": "Teams"
28441 "url": "/api/teams",
28442 "title": "Gets a list of Teams",
28445 "title": "Example usage:",
28446 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
28450 "name": "GetTeams",
28452 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/teams?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/teams?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/teams?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/teams?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/teams?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28453 "version": "0.0.0",
28454 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28455 "groupTitle": "Teams"
28459 "url": "/api/teams/{id}/users",
28460 "title": "Removes agents from a team",
28463 "title": "Example usage:",
28464 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28468 "name": "RemoveAgents",
28470 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28471 "version": "0.0.0",
28472 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28473 "groupTitle": "Teams"
28477 "url": "/api/teams/{id}/queues",
28478 "title": "Remove queues to a team",
28481 "title": "Example usage:",
28482 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28486 "name": "RemoveQueues",
28488 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28489 "version": "0.0.0",
28490 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28491 "groupTitle": "Teams"
28495 "url": "/api/chat/queues/{id}/teams",
28496 "title": "Remove teams from a queue",
28499 "title": "Example usage:",
28500 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28504 "name": "RemoveTeams",
28506 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28507 "version": "0.0.0",
28508 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/chatQueue/index.js",
28509 "groupTitle": "Teams"
28513 "url": "/api/fax/queues/{id}/teams",
28514 "title": "Remove teams from a queue",
28517 "title": "Example usage:",
28518 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28522 "name": "RemoveTeams",
28524 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28525 "version": "0.0.0",
28526 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/faxQueue/index.js",
28527 "groupTitle": "Teams"
28531 "url": "/api/mail/queues/{id}/teams",
28532 "title": "Remove teams from a queue",
28535 "title": "Example usage:",
28536 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28540 "name": "RemoveTeams",
28542 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28543 "version": "0.0.0",
28544 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/mailQueue/index.js",
28545 "groupTitle": "Teams"
28549 "url": "/api/openchannel/queues/{id}/teams",
28550 "title": "Remove teams from a queue",
28553 "title": "Example usage:",
28554 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28558 "name": "RemoveTeams",
28560 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28561 "version": "0.0.0",
28562 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/openchannelQueue/index.js",
28563 "groupTitle": "Teams"
28567 "url": "/api/sms/queues/{id}/teams",
28568 "title": "Remove teams from a queue",
28571 "title": "Example usage:",
28572 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28576 "name": "RemoveTeams",
28578 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28579 "version": "0.0.0",
28580 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/smsQueue/index.js",
28581 "groupTitle": "Teams"
28585 "url": "/api/voice/queues/{id}/teams",
28586 "title": "Remove teams from a queue",
28589 "title": "Example usage:",
28590 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28594 "name": "RemoveTeams",
28596 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28597 "version": "0.0.0",
28598 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
28599 "groupTitle": "Teams"
28603 "url": "/api/whatsapp/queues/{id}/teams",
28604 "title": "Remove teams from a queue",
28607 "title": "Example usage:",
28608 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
28612 "name": "RemoveTeams",
28614 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28615 "version": "0.0.0",
28616 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
28617 "groupTitle": "Teams"
28621 "url": "/api/teams/{id}",
28622 "title": "Gets a single Team",
28625 "title": "Example usage:",
28626 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
28630 "name": "ShowTeams",
28632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28633 "version": "0.0.0",
28634 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28635 "groupTitle": "Teams"
28639 "url": "/api/teams/{id}/users",
28640 "title": "Adds agents to a team",
28643 "title": "Example usage:",
28644 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28648 "name": "addAgents",
28650 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28651 "version": "0.0.0",
28652 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28653 "groupTitle": "Teams"
28657 "url": "/api/teams/{id}",
28658 "title": "Update an existing Team",
28661 "title": "Example usage:",
28662 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28666 "name": "updateTeams",
28668 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28669 "version": "0.0.0",
28670 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/team/index.js",
28671 "groupTitle": "Teams"
28675 "url": "/api/templates",
28676 "title": "Creates a new Template",
28679 "title": "Example usage:",
28680 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28684 "name": "CreateTemplates",
28685 "group": "Templates",
28700 "field": "description",
28713 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28714 "version": "0.0.0",
28715 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/template/index.js",
28716 "groupTitle": "Templates"
28720 "url": "/api/templates/{id}",
28721 "title": "Deletes a Template",
28724 "title": "Example usage:",
28725 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
28729 "name": "DeleteTemplates",
28730 "group": "Templates",
28731 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28732 "version": "0.0.0",
28733 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/template/index.js",
28734 "groupTitle": "Templates"
28738 "url": "/GetTemplate",
28739 "title": "Gets a list of Templates",
28740 "name": "GetTemplate",
28741 "group": "Templates",
28749 "field": "options.attributes",
28756 "field": "options.where",
28762 "version": "0.0.0",
28763 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/template/template.rpc.js",
28764 "groupTitle": "Templates"
28768 "url": "/api/templates",
28769 "title": "Gets a list of Templates",
28772 "title": "Example usage:",
28773 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
28777 "name": "GetTemplates",
28778 "group": "Templates",
28779 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/templates?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/templates?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/templates?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/templates?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/templates?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28780 "version": "0.0.0",
28781 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/template/index.js",
28782 "groupTitle": "Templates"
28786 "url": "/api/templates/{id}",
28787 "title": "Gets a single Template",
28790 "title": "Example usage:",
28791 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
28795 "name": "ShowTemplates",
28796 "group": "Templates",
28797 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28798 "version": "0.0.0",
28799 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/template/index.js",
28800 "groupTitle": "Templates"
28804 "url": "/api/templates/{id}",
28805 "title": "Update an existing Template",
28808 "title": "Example usage:",
28809 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28813 "name": "updateTemplates",
28814 "group": "Templates",
28815 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28816 "version": "0.0.0",
28817 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/template/index.js",
28818 "groupTitle": "Templates"
28822 "url": "/api/triggers",
28823 "title": "Creates a new Trigger",
28826 "title": "Example usage:",
28827 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28831 "name": "CreateTriggers",
28832 "group": "Triggers",
28847 "field": "channel",
28854 "field": "description",
28867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28868 "version": "0.0.0",
28869 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
28870 "groupTitle": "Triggers"
28874 "url": "/api/triggers/{id}",
28875 "title": "Deletes a Trigger",
28878 "title": "Example usage:",
28879 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
28883 "name": "DeleteTriggers",
28884 "group": "Triggers",
28885 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28886 "version": "0.0.0",
28887 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
28888 "groupTitle": "Triggers"
28892 "url": "/GetTrigger",
28893 "title": "Gets a list of Triggers",
28894 "name": "GetTrigger",
28895 "group": "Triggers",
28903 "field": "options.attributes",
28910 "field": "options.where",
28916 "version": "0.0.0",
28917 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/trigger.rpc.js",
28918 "groupTitle": "Triggers"
28922 "url": "/api/triggers",
28923 "title": "Gets a list of Triggers",
28926 "title": "Example usage:",
28927 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
28931 "name": "GetTriggers",
28932 "group": "Triggers",
28933 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/triggers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/triggers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/triggers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/triggers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/triggers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28934 "version": "0.0.0",
28935 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
28936 "groupTitle": "Triggers"
28940 "url": "/ShowTrigger",
28941 "title": "Gets a single Trigger",
28942 "name": "ShowTrigger",
28943 "group": "Triggers",
28951 "field": "options.attributes",
28958 "field": "options.where",
28964 "version": "0.0.0",
28965 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/trigger.rpc.js",
28966 "groupTitle": "Triggers"
28970 "url": "/api/triggers/{id}",
28971 "title": "Gets a single Trigger",
28974 "title": "Example usage:",
28975 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
28979 "name": "ShowTriggers",
28980 "group": "Triggers",
28981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28982 "version": "0.0.0",
28983 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
28984 "groupTitle": "Triggers"
28988 "url": "/api/triggers/{id}/actions",
28989 "title": "Creates new actions",
28992 "title": "Example usage:",
28993 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28997 "name": "addAction",
28998 "group": "Triggers",
29014 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
29021 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
29028 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
29035 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
29068 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29069 "version": "0.0.0",
29070 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29071 "groupTitle": "Triggers"
29075 "url": "/api/triggers/{id}/all_conditions",
29076 "title": "Creates a new \"AND\"condition",
29079 "title": "Example usage:",
29080 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -d '{\"field\": \"name\", \"operator\": \"equal\", \"value\": \"John Doe\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29084 "name": "addAllCondition",
29085 "group": "Triggers",
29107 "field": "operator",
29120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29121 "version": "0.0.0",
29122 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29123 "groupTitle": "Triggers"
29127 "url": "/api/triggers/{id}/any_conditions",
29128 "title": "Creates a new \"OR\"condition",
29131 "title": "Example usage:",
29132 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -d '{\"field\": \"name\", \"operator\": \"equal\", \"value\": \"John Doe\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29136 "name": "addAnyCondition",
29137 "group": "Triggers",
29159 "field": "operator",
29172 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29173 "version": "0.0.0",
29174 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29175 "groupTitle": "Triggers"
29179 "url": "/api/triggers/{id}/actions",
29180 "title": "Gets Trigger Actions",
29183 "title": "Example usage:",
29184 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
29188 "name": "getActions",
29189 "group": "Triggers",
29190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29191 "version": "0.0.0",
29192 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29193 "groupTitle": "Triggers"
29197 "url": "/api/triggers/{id}/all_conditions",
29198 "title": "Gets \"AND\" Trigger Conditions",
29201 "title": "Example usage:",
29202 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
29206 "name": "getAllConditions",
29207 "group": "Triggers",
29208 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29209 "version": "0.0.0",
29210 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29211 "groupTitle": "Triggers"
29215 "url": "/api/triggers/{id}/any_conditions",
29216 "title": "Gets \"OR\" Trigger Conditions",
29219 "title": "Example usage:",
29220 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
29224 "name": "getAnyConditions",
29225 "group": "Triggers",
29226 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29227 "version": "0.0.0",
29228 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29229 "groupTitle": "Triggers"
29233 "url": "/api/triggers/{id}",
29234 "title": "Update an existing Trigger",
29237 "title": "Example usage:",
29238 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29242 "name": "updateTriggers",
29243 "group": "Triggers",
29244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29245 "version": "0.0.0",
29246 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trigger/index.js",
29247 "groupTitle": "Triggers"
29251 "url": "/api/trunks/clone",
29252 "title": "Clone an existing Trunk",
29255 "title": "Example usage:",
29256 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29260 "name": "CloneTrunks",
29262 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29263 "version": "0.0.0",
29264 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/index.js",
29265 "groupTitle": "Trunks"
29269 "url": "/api/trunks",
29270 "title": "Create a new trunk",
29273 "title": "Example usage:",
29274 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
29306 "field": "context",
29313 "\"ALLOWED_NOT_SCREENED\"",
29314 "\"ALLOWED_PASSED_SCREEN\"",
29315 "\"ALLOWED_FAILED_SCREEN\"",
29317 "\"PROHIB_NOT_SCREENED\"",
29318 "\"PROHIB_PASSED_SCREEN\"",
29319 "\"PROHIB_FAILED_SCREEN\"",
29323 "field": "callingpres",
29351 "field": "md5secret",
29358 "field": "remotesecret",
29365 "field": "transport",
29366 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
29379 "field": "dtmfmode",
29393 "field": "directmedia",
29404 "field": "directrtpsetup",
29411 "field": "directmediapermit",
29418 "field": "directmediadeny",
29426 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
29432 "field": "callgroup",
29439 "field": "namedcallgroup",
29446 "field": "pickupgroup",
29453 "field": "namedpickupgroup",
29460 "field": "language",
29467 "field": "tonezone",
29474 "field": "disallow",
29482 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
29492 "field": "autoframing",
29499 "field": "insecure",
29500 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
29510 "field": "trustrpid",
29521 "field": "trust_id_outbound",
29533 "field": "progressinband",
29544 "field": "promiscredir",
29555 "field": "useclientcode",
29562 "field": "accountcode",
29576 "field": "callerid",
29583 "field": "amaflags",
29594 "field": "callcounter",
29601 "field": "busylevel",
29612 "field": "allowoverlap",
29623 "field": "allowsubscribe",
29634 "field": "allowtransfer",
29645 "field": "ignoresdpversion",
29652 "field": "subscribecontext",
29659 "field": "template",
29671 "field": "videosupport",
29678 "field": "maxcallbitrate",
29689 "field": "rfc2833compensate",
29696 "field": "mailbox",
29708 "field": "session_timers",
29715 "field": "session_expires",
29722 "field": "session_minse",
29733 "field": "session_refresher",
29740 "field": "t38pt_usertpsource",
29747 "field": "regexten",
29754 "field": "fromdomain",
29761 "field": "fromuser",
29779 "field": "qualify",
29786 "field": "keepalive",
29793 "field": "defaultip",
29800 "field": "defaultuser",
29807 "field": "rtptimeout",
29814 "field": "rtpholdtimeout",
29821 "field": "rtpkeepalive",
29833 "field": "sendrpid",
29840 "field": "outboundproxy",
29847 "field": "callbackextension",
29854 "field": "timert1",
29868 "field": "qualifyfreq",
29875 "field": "contactpermit",
29882 "field": "contactdeny",
29889 "field": "contactacl",
29896 "field": "unsolicited_mailbox",
29903 "field": "use_q850_reason",
29910 "field": "maxforwards",
29921 "field": "encryption",
29943 "field": "force_avp",
29954 "field": "icesupport",
29965 "field": "dtlsenable",
29978 "field": "dtlsverify",
29985 "field": "dtlsrekey",
29992 "field": "dtlscertfile",
29999 "field": "dtlsprivatekey",
30006 "field": "dtlscipher",
30013 "field": "dtlscafile",
30020 "field": "dtlscapath",
30032 "field": "dtlssetup",
30039 "field": "dtlsfingerprint",
30050 "field": "usereqphone",
30057 "field": "recordonfeature",
30064 "field": "recordofffeature",
30071 "field": "call_limit",
30082 "field": "registertrying",
30093 "field": "subscribemwi",
30100 "field": "vmexten",
30107 "field": "mohinterpret",
30114 "field": "mohsuggest",
30121 "field": "parkinglot",
30128 "field": "description",
30149 "field": "canreinvite",
30156 "field": "registry",
30163 "field": "otherFields",
30177 "field": "t38pt_udptl",
30183 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30184 "version": "0.0.0",
30185 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/index.js",
30186 "groupTitle": "Trunks"
30190 "url": "/api/trunks/{id}",
30191 "title": "Deletes a trunk",
30194 "title": "Example usage:",
30195 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
30201 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30202 "version": "0.0.0",
30203 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/index.js",
30204 "groupTitle": "Trunks"
30208 "url": "/GetTrunk",
30209 "title": "Gets a list of Trunks",
30210 "name": "GetTrunk",
30219 "field": "options.attributes",
30226 "field": "options.where",
30232 "version": "0.0.0",
30233 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/trunk.rpc.js",
30234 "groupTitle": "Trunks"
30238 "url": "/api/trunks",
30239 "title": "Gets a list of Trunks",
30242 "title": "Example usage:",
30243 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
30247 "name": "GetTrunks",
30249 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/trunks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/trunks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/trunks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/trunks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/trunks?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30250 "version": "0.0.0",
30251 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/index.js",
30252 "groupTitle": "Trunks"
30256 "url": "/ShowTrunk",
30257 "title": "Gets a single Trunk",
30258 "name": "ShowTrunk",
30267 "field": "options.attributes",
30274 "field": "options.where",
30280 "version": "0.0.0",
30281 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/trunk.rpc.js",
30282 "groupTitle": "Trunks"
30286 "url": "/api/trunks/{id}",
30287 "title": "Gets a single Trunk",
30290 "title": "Example usage:",
30291 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
30295 "name": "ShowTrunks",
30297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30298 "version": "0.0.0",
30299 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/index.js",
30300 "groupTitle": "Trunks"
30304 "url": "/api/trunks/{id}",
30305 "title": "Update an existing trunk",
30308 "title": "Example usage:",
30309 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
30315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30316 "version": "0.0.0",
30317 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/trunk/index.js",
30318 "groupTitle": "Trunks"
30322 "url": "/getVoiceQueueRtPauses",
30323 "title": "Counts queue pauses",
30324 "name": "GetVoiceQueueRtPauses",
30325 "group": "UserVoiceQueueRt",
30333 "field": "options.attributes",
30340 "field": "options.where",
30346 "version": "0.0.0",
30347 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userVoiceQueueRt/userVoiceQueueRt.rpc.js",
30348 "groupTitle": "UserVoiceQueueRt"
30352 "url": "/api/userProfile/resources",
30353 "title": "Creates a new User Profile Resource",
30356 "title": "Example usage:",
30357 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30361 "name": "CreateUser_Profile_Resources",
30362 "group": "User_Profile_Resources",
30377 "field": "resourceId",
30390 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30391 "version": "0.0.0",
30392 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileResource/index.js",
30393 "groupTitle": "User_Profile_Resources"
30397 "url": "/api/userProfile/resources/{id}",
30398 "title": "Deletes a User Profile Resource",
30401 "title": "Example usage:",
30402 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
30406 "name": "DeleteUser_Profile_Resources",
30407 "group": "User_Profile_Resources",
30408 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30409 "version": "0.0.0",
30410 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileResource/index.js",
30411 "groupTitle": "User_Profile_Resources"
30415 "url": "/api/userProfile/resources/describe",
30416 "title": "Gets table info about User Profile Resources",
30419 "title": "Example usage:",
30420 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
30424 "name": "DescribeUser_Profile_Resources",
30425 "group": "User_Profile_Resources",
30426 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30427 "version": "0.0.0",
30428 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileResource/index.js",
30429 "groupTitle": "User_Profile_Resources"
30433 "url": "/api/userProfile/resources",
30434 "title": "Gets a list of User Profile Resources",
30437 "title": "Example usage:",
30438 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
30442 "name": "GetUser_Profile_Resources",
30443 "group": "User_Profile_Resources",
30444 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfile/resources?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfile/resources?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfile/resources?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfile/resources?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfile/resources?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30445 "version": "0.0.0",
30446 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileResource/index.js",
30447 "groupTitle": "User_Profile_Resources"
30451 "url": "/api/userProfile/resources/{id}",
30452 "title": "Gets a single User Profile Resource",
30455 "title": "Example usage:",
30456 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
30460 "name": "ShowUser_Profile_Resources",
30461 "group": "User_Profile_Resources",
30462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30463 "version": "0.0.0",
30464 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileResource/index.js",
30465 "groupTitle": "User_Profile_Resources"
30469 "url": "/api/userProfile/resources/{id}",
30470 "title": "Update an existing User Profile Resource",
30473 "title": "Example usage:",
30474 "content": "curl https://{domain}/api/userProfile/resources/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30478 "name": "updateUser_Profile_Resources",
30479 "group": "User_Profile_Resources",
30480 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30481 "version": "0.0.0",
30482 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileResource/index.js",
30483 "groupTitle": "User_Profile_Resources"
30487 "url": "/api/userProfile/sections",
30488 "title": "Creates a new User Profile Section",
30491 "title": "Example usage:",
30492 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30496 "name": "CreateUser_Profile_Sections",
30497 "group": "User_Profile_Sections",
30512 "field": "category",
30519 "field": "sectionId",
30526 "field": "enabled",
30533 "field": "autoAssociation",
30540 "field": "crudPermissions",
30546 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30547 "version": "0.0.0",
30548 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileSection/index.js",
30549 "groupTitle": "User_Profile_Sections"
30553 "url": "/api/userProfile/sections/{id}",
30554 "title": "Deletes a User Profile Section",
30557 "title": "Example usage:",
30558 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
30562 "name": "DeleteUser_Profile_Sections",
30563 "group": "User_Profile_Sections",
30564 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30565 "version": "0.0.0",
30566 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileSection/index.js",
30567 "groupTitle": "User_Profile_Sections"
30571 "url": "/api/userProfile/sections/describe",
30572 "title": "Gets table info about User Profile Sections",
30575 "title": "Example usage:",
30576 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
30580 "name": "DescribeUser_Profile_Sections",
30581 "group": "User_Profile_Sections",
30582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30583 "version": "0.0.0",
30584 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileSection/index.js",
30585 "groupTitle": "User_Profile_Sections"
30589 "url": "/api/userProfile/sections",
30590 "title": "Gets a list of User Profile Sections",
30593 "title": "Example usage:",
30594 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
30598 "name": "GetUser_Profile_Sections",
30599 "group": "User_Profile_Sections",
30600 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfile/sections?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfile/sections?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfile/sections?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfile/sections?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfile/sections?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30601 "version": "0.0.0",
30602 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileSection/index.js",
30603 "groupTitle": "User_Profile_Sections"
30607 "url": "/api/userProfile/sections/{id}",
30608 "title": "Gets a single User Profile Section",
30611 "title": "Example usage:",
30612 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
30616 "name": "ShowUser_Profile_Sections",
30617 "group": "User_Profile_Sections",
30618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30619 "version": "0.0.0",
30620 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileSection/index.js",
30621 "groupTitle": "User_Profile_Sections"
30625 "url": "/api/userProfile/sections/{id}",
30626 "title": "Update an existing User Profile Section",
30629 "title": "Example usage:",
30630 "content": "curl https://{domain}/api/userProfile/sections/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30634 "name": "updateUser_Profile_Sections",
30635 "group": "User_Profile_Sections",
30636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30637 "version": "0.0.0",
30638 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfileSection/index.js",
30639 "groupTitle": "User_Profile_Sections"
30643 "url": "/api/userProfiles/{id}/resources",
30644 "title": "Add resources' permissions to User Profile",
30647 "title": "Example usage:",
30648 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30652 "name": "AddResources",
30653 "group": "User_Profiles",
30654 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30655 "version": "0.0.0",
30656 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30657 "groupTitle": "User_Profiles"
30661 "url": "/api/userProfiles/{id}/sections",
30662 "title": "Add sections' permissions to User Profile",
30665 "title": "Example usage:",
30666 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30670 "name": "AddSections",
30671 "group": "User_Profiles",
30672 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30673 "version": "0.0.0",
30674 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30675 "groupTitle": "User_Profiles"
30679 "url": "/api/userProfiles/clone",
30680 "title": "Clone an existing User Profile",
30683 "title": "Example usage:",
30684 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30688 "name": "CloneUser_Profiles",
30689 "group": "User_Profiles",
30690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30691 "version": "0.0.0",
30692 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30693 "groupTitle": "User_Profiles"
30697 "url": "/api/userProfiles",
30698 "title": "Creates a new User Profile",
30701 "title": "Example usage:",
30702 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30706 "name": "CreateUser_Profiles",
30707 "group": "User_Profiles",
30722 "field": "crudPermissions",
30729 "field": "description",
30735 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30736 "version": "0.0.0",
30737 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30738 "groupTitle": "User_Profiles"
30742 "url": "/api/userProfiles/{id}",
30743 "title": "Deletes a User Profile",
30746 "title": "Example usage:",
30747 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
30751 "name": "DeleteUser_Profiles",
30752 "group": "User_Profiles",
30753 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30754 "version": "0.0.0",
30755 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30756 "groupTitle": "User_Profiles"
30760 "url": "/api/userProfiles/describe",
30761 "title": "Gets table info about User Profiles",
30764 "title": "Example usage:",
30765 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
30769 "name": "DescribeUser_Profiles",
30770 "group": "User_Profiles",
30771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30772 "version": "0.0.0",
30773 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30774 "groupTitle": "User_Profiles"
30778 "url": "/api/userProfiles/{id}/resources?section={section}",
30779 "title": "Get Resources assigned to a Section",
30782 "title": "Example usage:",
30783 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
30787 "name": "GetResources",
30788 "group": "User_Profiles",
30789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30790 "version": "0.0.0",
30791 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30792 "groupTitle": "User_Profiles"
30796 "url": "/api/userProfiles/{id}/sections",
30797 "title": "Get sections associated to a User Profile",
30800 "title": "Example usage:",
30801 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
30805 "name": "GetSections",
30806 "group": "User_Profiles",
30807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30808 "version": "0.0.0",
30809 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30810 "groupTitle": "User_Profiles"
30814 "url": "/api/userProfiles",
30815 "title": "Gets a list of User Profiles",
30818 "title": "Example usage:",
30819 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
30823 "name": "GetUser_Profiles",
30824 "group": "User_Profiles",
30825 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfiles?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfiles?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfiles?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfiles?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfiles?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30826 "version": "0.0.0",
30827 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30828 "groupTitle": "User_Profiles"
30832 "url": "/api/userProfiles/{id}/resources",
30833 "title": "Removes resources' permissions from User Profile",
30836 "title": "Example usage:",
30837 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30841 "name": "RemoveResources",
30842 "group": "User_Profiles",
30843 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30844 "version": "0.0.0",
30845 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30846 "groupTitle": "User_Profiles"
30850 "url": "/api/userProfiles/{id}/sections",
30851 "title": "Removes sections' permissions from User Profile",
30854 "title": "Example usage:",
30855 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30859 "name": "RemoveSections",
30860 "group": "User_Profiles",
30861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30862 "version": "0.0.0",
30863 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30864 "groupTitle": "User_Profiles"
30868 "url": "/api/userProfiles/{id}",
30869 "title": "Gets a single User Profile",
30872 "title": "Example usage:",
30873 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
30877 "name": "ShowUser_Profiles",
30878 "group": "User_Profiles",
30879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30880 "version": "0.0.0",
30881 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30882 "groupTitle": "User_Profiles"
30886 "url": "/api/userProfiles/{id}",
30887 "title": "Update an existing User Profile",
30890 "title": "Example usage:",
30891 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30895 "name": "updateUser_Profiles",
30896 "group": "User_Profiles",
30897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30898 "version": "0.0.0",
30899 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/userProfile/index.js",
30900 "groupTitle": "User_Profiles"
30904 "url": "/api/users/{id}/chat_interactions",
30905 "title": "Add chat interaction tabs to an agent",
30908 "title": "Example usage:",
30909 "content": "curl https://{domain}/api/users/{id}/chat_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30913 "name": "AddChatInteractions",
30915 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30916 "version": "0.0.0",
30917 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
30918 "groupTitle": "Users"
30922 "url": "/api/users/{id}/chat_websites",
30923 "title": "Add a Chat Website to a user",
30926 "title": "Example usage:",
30927 "content": "curl https://{domain}/api/users/{id}/chat_websites -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30931 "name": "AddChatWebsites",
30933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30934 "version": "0.0.0",
30935 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
30936 "groupTitle": "Users"
30940 "url": "/api/users/{id}/contacts",
30941 "title": "Add contacts to a user",
30944 "title": "Example usage:",
30945 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30949 "name": "AddContacts",
30951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30952 "version": "0.0.0",
30953 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
30954 "groupTitle": "Users"
30958 "url": "/api/users/{id}/fax_accounts",
30959 "title": "Add a Fax Account to a user",
30962 "title": "Example usage:",
30963 "content": "curl https://{domain}/api/users/{id}/fax_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30967 "name": "AddFaxAccounts",
30969 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30970 "version": "0.0.0",
30971 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
30972 "groupTitle": "Users"
30976 "url": "/api/users/{id}/fax_interactions",
30977 "title": "Add fax interaction tabs to an agent",
30980 "title": "Example usage:",
30981 "content": "curl https://{domain}/api/users/{id}/fax_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30985 "name": "AddFaxInteractions",
30987 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30988 "version": "0.0.0",
30989 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
30990 "groupTitle": "Users"
30994 "url": "/api/users/{id}/mail_accounts",
30995 "title": "Add a Mail Account to a user",
30998 "title": "Example usage:",
30999 "content": "curl https://{domain}/api/users/{id}/mail_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31003 "name": "AddMailAccounts",
31005 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31006 "version": "0.0.0",
31007 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31008 "groupTitle": "Users"
31012 "url": "/api/users/{id}/mail_interactions",
31013 "title": "Add mail interaction tabs to an agent",
31016 "title": "Example usage:",
31017 "content": "curl https://{domain}/api/users/{id}/mail_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31021 "name": "AddMailInteractions",
31023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31024 "version": "0.0.0",
31025 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31026 "groupTitle": "Users"
31030 "url": "/api/users/{id}/openchannel_accounts",
31031 "title": "Add a Open Channel Account to a user",
31034 "title": "Example usage:",
31035 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31039 "name": "AddOpenchannelAccounts",
31041 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31042 "version": "0.0.0",
31043 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31044 "groupTitle": "Users"
31048 "url": "/api/users/{id}/openchannel_interactions",
31049 "title": "Add openchannel interaction tabs to an agent",
31052 "title": "Example usage:",
31053 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31057 "name": "AddOpenchannelInteractions",
31059 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31060 "version": "0.0.0",
31061 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31062 "groupTitle": "Users"
31066 "url": "/api/users/{id}/queues",
31067 "title": "Add queues to an agent",
31070 "title": "Example usage:",
31071 "content": "curl https://{domain}/api/users/{id}/queues -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31075 "name": "AddQueues",
31077 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31078 "version": "0.0.0",
31079 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31080 "groupTitle": "Users"
31084 "url": "/api/users/{id}/sms_accounts",
31085 "title": "Add a Sms Account to a user",
31088 "title": "Example usage:",
31089 "content": "curl https://{domain}/api/users/{id}/sms_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31093 "name": "AddSmsAccounts",
31095 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31096 "version": "0.0.0",
31097 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31098 "groupTitle": "Users"
31102 "url": "/api/users/{id}/sms_interactions",
31103 "title": "Add sms interaction tabs to an agent",
31106 "title": "Example usage:",
31107 "content": "curl https://{domain}/api/users/{id}/sms_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31111 "name": "AddSmsInteractions",
31113 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31114 "version": "0.0.0",
31115 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31116 "groupTitle": "Users"
31120 "url": "/api/users/{id}/square_projects",
31121 "title": "Add a Square Project to a user",
31124 "title": "Example usage:",
31125 "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31129 "name": "AddSquareProjects",
31131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31132 "version": "0.0.0",
31133 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31134 "groupTitle": "Users"
31138 "url": "/api/users/{id}/teams",
31139 "title": "Add teams to an agent",
31142 "title": "Example usage:",
31143 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31147 "name": "AddTeams",
31149 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31150 "version": "0.0.0",
31151 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31152 "groupTitle": "Users"
31156 "url": "/api/users/{id}/whatsapp_accounts",
31157 "title": "Add a Whatsapp Account to a user",
31160 "title": "Example usage:",
31161 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31165 "name": "AddWhatsappAccounts",
31167 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31168 "version": "0.0.0",
31169 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31170 "groupTitle": "Users"
31174 "url": "/api/users/{id}/whatsapp_interactions",
31175 "title": "Add Whatsapp interaction tabs to an agent",
31178 "title": "Example usage:",
31179 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31183 "name": "AddWhatsappInteractions",
31185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31186 "version": "0.0.0",
31187 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31188 "groupTitle": "Users"
31192 "url": "/api/users/{id}/password",
31193 "title": "Change user password",
31196 "title": "Example usage:",
31197 "content": "curl https://{domain}/api/users/{id}/password -d '{\"oldPassword\": \"1234\", \"newPassword\": \"5678\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
31201 "name": "ChangePwd",
31203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31204 "version": "0.0.0",
31205 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31206 "groupTitle": "Users"
31210 "url": "/api/users",
31211 "title": "Create a new user",
31214 "title": "Example usage:",
31215 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31221 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31222 "version": "0.0.0",
31223 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31224 "groupTitle": "Users"
31228 "url": "/api/users/{id}/api_key",
31229 "title": "Create a new API access key for the user",
31232 "title": "Example usage:",
31233 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31237 "name": "CreateApiKey",
31239 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31240 "version": "0.0.0",
31241 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31242 "groupTitle": "Users"
31246 "url": "/api/users/{id}",
31247 "title": "Deletes a user",
31250 "title": "Example usage:",
31251 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
31257 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31258 "version": "0.0.0",
31259 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31260 "groupTitle": "Users"
31264 "url": "/api/users/describe",
31265 "title": "Gets table info about Users",
31268 "title": "Example usage:",
31269 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
31273 "name": "DescribeUsers",
31275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31276 "version": "0.0.0",
31277 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31278 "groupTitle": "Users"
31282 "url": "/api/users/{id}/agents",
31283 "title": "GetAgents",
31286 "title": "Example usage:",
31287 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
31291 "name": "GetAgents",
31293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31294 "version": "0.0.0",
31295 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31296 "groupTitle": "Users"
31300 "url": "/api/users/{id}/api_key",
31301 "title": "Get the API access key for the user",
31304 "title": "Example usage:",
31305 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
31309 "name": "GetApiKey",
31311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31312 "version": "0.0.0",
31313 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31314 "groupTitle": "Users"
31318 "url": "/api/users/{id}/groups",
31319 "title": "GetChatGroups",
31322 "title": "Example usage:",
31323 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
31327 "name": "GetChatGroups",
31329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31330 "version": "0.0.0",
31331 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31332 "groupTitle": "Users"
31336 "url": "/api/users/{id}/chat/interactions",
31337 "title": "GetChatInteractions",
31340 "title": "Example usage:",
31341 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
31345 "name": "GetChatInteractions",
31347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31348 "version": "0.0.0",
31349 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31350 "groupTitle": "Users"
31354 "url": "/api/users/{id}/chat_websites",
31355 "title": "GetChatWebsites",
31358 "title": "Example usage:",
31359 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
31363 "name": "GetChatWebsites",
31365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31366 "version": "0.0.0",
31367 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31368 "groupTitle": "Users"
31372 "url": "/api/users/{id}/contacts",
31373 "title": "GetContacts",
31376 "title": "Example usage:",
31377 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
31381 "name": "GetContacts",
31383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31384 "version": "0.0.0",
31385 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31386 "groupTitle": "Users"
31390 "url": "/api/users/{id}/fax_accounts",
31391 "title": "GetFaxAccounts",
31394 "title": "Example usage:",
31395 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
31399 "name": "GetFaxAccounts",
31401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31402 "version": "0.0.0",
31403 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31404 "groupTitle": "Users"
31408 "url": "/api/users/{id}/fax/interactions",
31409 "title": "GetFaxInteractions",
31412 "title": "Example usage:",
31413 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
31417 "name": "GetFaxInteractions",
31419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31420 "version": "0.0.0",
31421 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31422 "groupTitle": "Users"
31426 "url": "/api/users/{id}/lists",
31427 "title": "GetLists",
31430 "title": "Example usage:",
31431 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
31435 "name": "GetLists",
31437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31438 "version": "0.0.0",
31439 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31440 "groupTitle": "Users"
31444 "url": "/api/users/{id}/mail_accounts",
31445 "title": "GetMailAccounts",
31448 "title": "Example usage:",
31449 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
31453 "name": "GetMailAccounts",
31455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31456 "version": "0.0.0",
31457 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31458 "groupTitle": "Users"
31462 "url": "/api/users/{id}/mail/interactions",
31463 "title": "GetMailInteractions",
31466 "title": "Example usage:",
31467 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
31471 "name": "GetMailInteractions",
31473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31474 "version": "0.0.0",
31475 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31476 "groupTitle": "Users"
31480 "url": "/api/users/{id}/openchannel_accounts",
31481 "title": "GetOpenchannelAccounts",
31484 "title": "Example usage:",
31485 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
31489 "name": "GetOpenchannelAccounts",
31491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31492 "version": "0.0.0",
31493 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31494 "groupTitle": "Users"
31498 "url": "/api/users/{id}/openchannel/interactions",
31499 "title": "GetOpenchannelInteractions",
31502 "title": "Example usage:",
31503 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
31507 "name": "GetOpenchannelInteractions",
31509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31510 "version": "0.0.0",
31511 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31512 "groupTitle": "Users"
31516 "url": "/api/users/{id}/prefixes",
31517 "title": "GetPrefixes",
31520 "title": "Example usage:",
31521 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
31525 "name": "GetPrefixes",
31527 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31528 "version": "0.0.0",
31529 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31530 "groupTitle": "Users"
31534 "url": "/api/users/{id}/queues?channel={channel}",
31535 "title": "Gets Queues list",
31538 "title": "Example usage:",
31539 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
31543 "name": "GetQueues",
31545 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31546 "version": "0.0.0",
31547 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31548 "groupTitle": "Users"
31552 "url": "/api/users/{id}/recordings",
31553 "title": "GetRecordings",
31556 "title": "Example usage:",
31557 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
31561 "name": "GetRecordings",
31563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31564 "version": "0.0.0",
31565 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31566 "groupTitle": "Users"
31570 "url": "/api/users/{id}/scheduled_calls",
31571 "title": "GetScheduledCalls",
31574 "title": "Example usage:",
31575 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
31579 "name": "GetScheduledCalls",
31581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31582 "version": "0.0.0",
31583 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31584 "groupTitle": "Users"
31588 "url": "/api/users/{id}/screen_recordings",
31589 "title": "GetScreenRecordings",
31592 "title": "Example usage:",
31593 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
31597 "name": "GetScreenRecordings",
31599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31600 "version": "0.0.0",
31601 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31602 "groupTitle": "Users"
31606 "url": "/api/users/{id}/sms_accounts",
31607 "title": "GetSmsAccounts",
31610 "title": "Example usage:",
31611 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
31615 "name": "GetSmsAccounts",
31617 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31618 "version": "0.0.0",
31619 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31620 "groupTitle": "Users"
31624 "url": "/api/users/{id}/sms/interactions",
31625 "title": "GetSmsInteractions",
31628 "title": "Example usage:",
31629 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
31633 "name": "GetSmsInteractions",
31635 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31636 "version": "0.0.0",
31637 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31638 "groupTitle": "Users"
31642 "url": "/api/users/{id}/square_projects",
31643 "title": "GetSquareProjects",
31646 "title": "Example usage:",
31647 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
31651 "name": "GetSquareProjects",
31653 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31654 "version": "0.0.0",
31655 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31656 "groupTitle": "Users"
31660 "url": "/api/users/{id}/teams",
31661 "title": "GetTeams",
31664 "title": "Example usage:",
31665 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
31669 "name": "GetTeams",
31671 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31672 "version": "0.0.0",
31673 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31674 "groupTitle": "Users"
31679 "title": "Gets a list of Users",
31689 "field": "options.attributes",
31696 "field": "options.where",
31702 "version": "0.0.0",
31703 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.rpc.js",
31704 "groupTitle": "Users"
31708 "url": "/api/users",
31709 "title": "Gets a list of Users",
31712 "title": "Example usage:",
31713 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
31717 "name": "GetUsers",
31719 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/users?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/users?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/users?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/users?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/users?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31720 "version": "0.0.0",
31721 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31722 "groupTitle": "Users"
31726 "url": "/api/users/{id}/queues_rt",
31727 "title": "GetVoiceQueuesRt",
31730 "title": "Example usage:",
31731 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
31735 "name": "GetVoiceQueuesRt",
31737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31738 "version": "0.0.0",
31739 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31740 "groupTitle": "Users"
31744 "url": "/api/users/{id}/whatsapp_accounts",
31745 "title": "GetWhatsappAccounts",
31748 "title": "Example usage:",
31749 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
31753 "name": "GetWhatsappAccounts",
31755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31756 "version": "0.0.0",
31757 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31758 "groupTitle": "Users"
31762 "url": "/api/users/{id}/whatsapp/interactions",
31763 "title": "GetWhatsappInteractions",
31766 "title": "Example usage:",
31767 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
31771 "name": "GetWhatsappInteractions",
31773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31774 "version": "0.0.0",
31775 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31776 "groupTitle": "Users"
31780 "url": "/api/users/{id}/login",
31784 "title": "Example usage:",
31785 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
31791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31792 "version": "0.0.0",
31793 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31794 "groupTitle": "Users"
31798 "url": "/LoginUser",
31800 "name": "LoginUser",
31809 "field": "options.attributes",
31816 "field": "options.where",
31822 "version": "0.0.0",
31823 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.rpc.js",
31824 "groupTitle": "Users"
31828 "url": "/api/users/{id}/logout",
31832 "title": "Example usage:",
31833 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
31839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31840 "version": "0.0.0",
31841 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31842 "groupTitle": "Users"
31846 "url": "/LogoutUser",
31848 "name": "LogoutUser",
31857 "field": "options.attributes",
31864 "field": "options.where",
31870 "version": "0.0.0",
31871 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.rpc.js",
31872 "groupTitle": "Users"
31876 "url": "/api/users/{id}/pause",
31880 "title": "Example usage:",
31881 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
31887 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31888 "version": "0.0.0",
31889 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31890 "groupTitle": "Users"
31894 "url": "/PauseUser",
31895 "title": "Put in pause a User",
31896 "name": "PauseUser",
31905 "field": "options.attributes",
31912 "field": "options.where",
31918 "version": "0.0.0",
31919 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.rpc.js",
31920 "groupTitle": "Users"
31924 "url": "/api/users/{id}/api_key",
31925 "title": "Remove API access key for the user",
31928 "title": "Example usage:",
31929 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
31933 "name": "RemoveApiKey",
31935 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31936 "version": "0.0.0",
31937 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31938 "groupTitle": "Users"
31942 "url": "/api/users/{id}/chat_interactions",
31943 "title": "Removes interactions from an agent",
31946 "title": "Example usage:",
31947 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31951 "name": "RemoveChatInteractions",
31953 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31954 "version": "0.0.0",
31955 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31956 "groupTitle": "Users"
31960 "url": "/api/users/{id}/chat_websites",
31961 "title": "Removes a Chat Website from a user",
31964 "title": "Example usage:",
31965 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31969 "name": "RemoveChatWebsites",
31971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31972 "version": "0.0.0",
31973 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31974 "groupTitle": "Users"
31978 "url": "/api/users/{id}/fax_accounts",
31979 "title": "Removes a Fax Account from a user",
31982 "title": "Example usage:",
31983 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31987 "name": "RemoveFaxAccounts",
31989 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31990 "version": "0.0.0",
31991 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
31992 "groupTitle": "Users"
31996 "url": "/api/users/{id}/fax_interactions",
31997 "title": "Removes interactions from an agent",
32000 "title": "Example usage:",
32001 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32005 "name": "RemoveFaxInteractions",
32007 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32008 "version": "0.0.0",
32009 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32010 "groupTitle": "Users"
32014 "url": "/api/users/{id}/mail_accounts",
32015 "title": "Removes a Mail Account from a user",
32018 "title": "Example usage:",
32019 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32023 "name": "RemoveMailAccounts",
32025 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32026 "version": "0.0.0",
32027 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32028 "groupTitle": "Users"
32032 "url": "/api/users/{id}/mail_interactions",
32033 "title": "Removes interactions from an agent",
32036 "title": "Example usage:",
32037 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32041 "name": "RemoveMailInteractions",
32043 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32044 "version": "0.0.0",
32045 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32046 "groupTitle": "Users"
32050 "url": "/api/users/{id}/openchannel_accounts",
32051 "title": "Removes a Open Channel Account from a user",
32054 "title": "Example usage:",
32055 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32059 "name": "RemoveOpenchannelAccounts",
32061 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32062 "version": "0.0.0",
32063 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32064 "groupTitle": "Users"
32068 "url": "/api/users/{id}/openchannel_interactions",
32069 "title": "Removes openchannel interactions from an agent",
32072 "title": "Example usage:",
32073 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32077 "name": "RemoveOpenchannelInteractions",
32079 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32080 "version": "0.0.0",
32081 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32082 "groupTitle": "Users"
32086 "url": "/api/users/{id}/queues",
32087 "title": "Remove queues to an agent",
32090 "title": "Example usage:",
32091 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32095 "name": "RemoveQueues",
32097 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32098 "version": "0.0.0",
32099 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32100 "groupTitle": "Users"
32104 "url": "/api/users/{id}/sms_accounts",
32105 "title": "Removes a Sms Account from a user",
32108 "title": "Example usage:",
32109 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32113 "name": "RemoveSmsAccounts",
32115 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32116 "version": "0.0.0",
32117 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32118 "groupTitle": "Users"
32122 "url": "/api/users/{id}/sms_interactions",
32123 "title": "Removes interactions from an agent",
32126 "title": "Example usage:",
32127 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32131 "name": "RemoveSmsInteractions",
32133 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32134 "version": "0.0.0",
32135 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32136 "groupTitle": "Users"
32140 "url": "/api/users/{id}/square_projects",
32141 "title": "Removes a Square Project from a user",
32144 "title": "Example usage:",
32145 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32149 "name": "RemoveSquareProjects",
32151 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32152 "version": "0.0.0",
32153 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32154 "groupTitle": "Users"
32158 "url": "/api/users/{id}/teams",
32159 "title": "Removes teams from an agent",
32162 "title": "Example usage:",
32163 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32167 "name": "RemoveTeams",
32169 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32170 "version": "0.0.0",
32171 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32172 "groupTitle": "Users"
32176 "url": "/api/users/{id}/whatsapp_accounts",
32177 "title": "Removes a Whatsapp Account from a user",
32180 "title": "Example usage:",
32181 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32185 "name": "RemoveWhatsappAccounts",
32187 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32188 "version": "0.0.0",
32189 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32190 "groupTitle": "Users"
32194 "url": "/api/users/{id}/whatsapp_interactions",
32195 "title": "Removes Whatsapp interactions from an agent",
32198 "title": "Example usage:",
32199 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32203 "name": "RemoveWhatsappInteractions",
32205 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32206 "version": "0.0.0",
32207 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32208 "groupTitle": "Users"
32212 "url": "/ShowUser",
32213 "title": "Gets a single User",
32214 "name": "ShowUser",
32223 "field": "options.attributes",
32230 "field": "options.where",
32236 "version": "0.0.0",
32237 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.rpc.js",
32238 "groupTitle": "Users"
32242 "url": "/api/users/{id}",
32243 "title": "Gets a single User",
32246 "title": "Example usage:",
32247 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
32251 "name": "ShowUsers",
32253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32254 "version": "0.0.0",
32255 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32256 "groupTitle": "Users"
32260 "url": "/api/users/{id}/unpause",
32261 "title": "Unpause",
32264 "title": "Example usage:",
32265 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
32271 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32272 "version": "0.0.0",
32273 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32274 "groupTitle": "Users"
32278 "url": "/UnpauseUser",
32279 "title": "Remove a User from pause",
32280 "name": "UnpauseUser",
32289 "field": "options.attributes",
32296 "field": "options.where",
32302 "version": "0.0.0",
32303 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/user.rpc.js",
32304 "groupTitle": "Users"
32308 "url": "/api/users/whoami",
32312 "title": "Example usage:",
32313 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
32319 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32320 "version": "0.0.0",
32321 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32322 "groupTitle": "Users"
32326 "url": "/api/users/{id}/avatar",
32327 "title": "Add avatar",
32330 "title": "Example usage:",
32331 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
32335 "name": "addAvatar",
32337 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32338 "version": "0.0.0",
32339 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32340 "groupTitle": "Users"
32344 "url": "/api/users/create_many",
32345 "title": "Create Users",
32348 "title": "Example usage:",
32349 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
32353 "name": "bulkCreate",
32355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32356 "version": "0.0.0",
32357 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32358 "groupTitle": "Users"
32362 "url": "/api/users/{id}/avatar",
32363 "title": "Get avatar",
32366 "title": "Example usage:",
32367 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
32371 "name": "getAvatar",
32373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32374 "version": "0.0.0",
32375 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32376 "groupTitle": "Users"
32380 "url": "/api/users/{id}",
32381 "title": "Update an existing User",
32384 "title": "Example usage:",
32385 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
32389 "name": "updateUsers",
32391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32392 "version": "0.0.0",
32393 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/user/index.js",
32394 "groupTitle": "Users"
32398 "url": "/api/variables",
32399 "title": "Creates a new Variable",
32402 "title": "Example usage:",
32403 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32407 "name": "CreateVariables",
32408 "group": "Variables",
32423 "field": "description",
32429 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32430 "version": "0.0.0",
32431 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/variable/index.js",
32432 "groupTitle": "Variables"
32436 "url": "/api/variables/{id}",
32437 "title": "Deletes a Variable",
32440 "title": "Example usage:",
32441 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
32445 "name": "DeleteVariables",
32446 "group": "Variables",
32447 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32448 "version": "0.0.0",
32449 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/variable/index.js",
32450 "groupTitle": "Variables"
32454 "url": "/api/variables",
32455 "title": "Gets a list of Variables",
32458 "title": "Example usage:",
32459 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
32463 "name": "GetVariables",
32464 "group": "Variables",
32465 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/variables?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/variables?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/variables?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/variables?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/variables?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32466 "version": "0.0.0",
32467 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/variable/index.js",
32468 "groupTitle": "Variables"
32472 "url": "/ShowVariable",
32473 "title": "Gets a single Variable",
32474 "name": "ShowVariable",
32475 "group": "Variables",
32483 "field": "options.attributes",
32490 "field": "options.where",
32496 "version": "0.0.0",
32497 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/variable/variable.rpc.js",
32498 "groupTitle": "Variables"
32502 "url": "/api/variables/{id}",
32503 "title": "Gets a single Variable",
32506 "title": "Example usage:",
32507 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
32511 "name": "ShowVariables",
32512 "group": "Variables",
32513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32514 "version": "0.0.0",
32515 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/variable/index.js",
32516 "groupTitle": "Variables"
32520 "url": "/api/variables/{id}",
32521 "title": "Update an existing Variable",
32524 "title": "Example usage:",
32525 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
32529 "name": "updateVariables",
32530 "group": "Variables",
32531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32532 "version": "0.0.0",
32533 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/variable/index.js",
32534 "groupTitle": "Variables"
32538 "url": "/api/version/fetch",
32539 "title": "Fetch git version",
32542 "title": "Example usage:",
32543 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
32547 "name": "FetchVersion",
32548 "group": "Version",
32549 "description": "<p>Motion run the following command: git fetch origin master</p>",
32550 "version": "0.0.0",
32551 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/version/index.js",
32552 "groupTitle": "Version"
32556 "url": "/api/version",
32557 "title": "Gets version",
32560 "title": "Example usage:",
32561 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
32565 "name": "GetVersion",
32566 "group": "Version",
32567 "description": "<p>Motion returns the current and latest motion version.</p>",
32568 "version": "0.0.0",
32569 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/version/index.js",
32570 "groupTitle": "Version"
32574 "url": "/api/version/migrations",
32575 "title": "Launch database migrations",
32578 "title": "Example usage:",
32579 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
32583 "name": "MigrateVersion",
32584 "group": "Version",
32585 "description": "<p>Motion launch the database migrations, according to the application version</p>",
32586 "version": "0.0.0",
32587 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/version/index.js",
32588 "groupTitle": "Version"
32592 "url": "/api/version/pull",
32593 "title": "Pull git version",
32596 "title": "Example usage:",
32597 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
32601 "name": "PullVersion",
32602 "group": "Version",
32603 "description": "<p>Motion run the following command: git pull</p>",
32604 "version": "0.0.0",
32605 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/version/index.js",
32606 "groupTitle": "Version"
32610 "url": "/api/version/reset",
32611 "title": "Reset git version",
32614 "title": "Example usage:",
32615 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
32619 "name": "ResetVersion",
32620 "group": "Version",
32621 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
32622 "version": "0.0.0",
32623 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/version/index.js",
32624 "groupTitle": "Version"
32628 "url": "/api/version/restart",
32629 "title": "Restart motion2 after update",
32632 "title": "Example usage:",
32633 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
32637 "name": "RestartVersion",
32638 "group": "Version",
32639 "description": "<p>Motion run the following command: pm2 restart motion</p>",
32640 "version": "0.0.0",
32641 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/version/index.js",
32642 "groupTitle": "Version"
32646 "url": "/CreateVoiceAgentReport",
32647 "title": "Creates a new Agent Report",
32648 "name": "CreateVoiceAgentReport",
32649 "group": "Voice_Agent_Reports",
32650 "version": "0.0.0",
32651 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceAgentReport/voiceAgentReport.rpc.js",
32652 "groupTitle": "Voice_Agent_Reports"
32656 "url": "/api/voice/agents/reports/describe",
32657 "title": "Gets table info about Agent Reports",
32660 "title": "Example usage:",
32661 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
32665 "name": "DescribeAgent_Reports",
32666 "group": "Voice_Agent_Reports",
32667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32668 "version": "0.0.0",
32669 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceAgentReport/index.js",
32670 "groupTitle": "Voice_Agent_Reports"
32674 "url": "/api/voice/agents/reports",
32675 "title": "Gets a list of Agent Reports",
32678 "title": "Example usage:",
32679 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
32683 "name": "GetAgent_Reports",
32684 "group": "Voice_Agent_Reports",
32685 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/agents/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/agents/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/agents/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/agents/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/agents/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32686 "version": "0.0.0",
32687 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceAgentReport/index.js",
32688 "groupTitle": "Voice_Agent_Reports"
32692 "url": "/api/voice/agents/reports/{id}",
32693 "title": "Gets a single Agent Report",
32696 "title": "Example usage:",
32697 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
32701 "name": "ShowAgent_Reports",
32702 "group": "Voice_Agent_Reports",
32703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32704 "version": "0.0.0",
32705 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceAgentReport/index.js",
32706 "groupTitle": "Voice_Agent_Reports"
32710 "url": "/UpdateVoiceAgentReport",
32711 "title": "Updates a new Agent Report",
32712 "name": "UpdateVoiceAgentReport",
32713 "group": "Voice_Agent_Reports",
32721 "field": "options.attributes",
32728 "field": "options.where",
32734 "version": "0.0.0",
32735 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceAgentReport/voiceAgentReport.rpc.js",
32736 "groupTitle": "Voice_Agent_Reports"
32740 "url": "/CreateVoiceCallReport",
32741 "title": "Creates a new Call Report",
32742 "name": "CreateVoiceCallReport",
32743 "group": "Voice_Call_Reports",
32744 "version": "0.0.0",
32745 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/voiceCallReport.rpc.js",
32746 "groupTitle": "Voice_Call_Reports"
32750 "url": "/api/voice/calls/reports/describe",
32751 "title": "Gets table info about Call Reports",
32754 "title": "Example usage:",
32755 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
32759 "name": "DescribeCall_Reports",
32760 "group": "Voice_Call_Reports",
32761 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32762 "version": "0.0.0",
32763 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/index.js",
32764 "groupTitle": "Voice_Call_Reports"
32768 "url": "/api/voice/calls/reports",
32769 "title": "Gets a list of Call Reports",
32772 "title": "Example usage:",
32773 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
32777 "name": "GetCall_Reports",
32778 "group": "Voice_Call_Reports",
32779 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/calls/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/calls/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/calls/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/calls/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/calls/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32780 "version": "0.0.0",
32781 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/index.js",
32782 "groupTitle": "Voice_Call_Reports"
32786 "url": "/GetVoiceCallReport",
32787 "title": "Gets a list of Call Reports",
32788 "name": "GetVoiceCallReport",
32789 "group": "Voice_Call_Reports",
32797 "field": "options.attributes",
32804 "field": "options.where",
32810 "version": "0.0.0",
32811 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/voiceCallReport.rpc.js",
32812 "groupTitle": "Voice_Call_Reports"
32816 "url": "/api/voice/calls/reports/{id}",
32817 "title": "Gets a single Call Report",
32820 "title": "Example usage:",
32821 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
32825 "name": "ShowCall_Reports",
32826 "group": "Voice_Call_Reports",
32827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32828 "version": "0.0.0",
32829 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/index.js",
32830 "groupTitle": "Voice_Call_Reports"
32834 "url": "/UpdateVoiceCallReport",
32835 "title": "Updates a new Call Report",
32836 "name": "UpdateVoiceCallReport",
32837 "group": "Voice_Call_Reports",
32845 "field": "options.attributes",
32852 "field": "options.where",
32858 "version": "0.0.0",
32859 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/voiceCallReport.rpc.js",
32860 "groupTitle": "Voice_Call_Reports"
32864 "url": "/api/voice/calls/reports/{id}",
32865 "title": "Update a single cdr",
32868 "title": "Example usage:",
32869 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
32874 "group": "Voice_Call_Reports",
32875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32876 "version": "0.0.0",
32877 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceCallReport/index.js",
32878 "groupTitle": "Voice_Call_Reports"
32882 "url": "/api/voice/chanspy",
32883 "title": "Creates a new ChanSpy",
32886 "title": "Example usage:",
32887 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32891 "name": "CreateChanSpy",
32892 "group": "Voice_ChanSpy",
32914 "field": "options",
32928 "field": "password",
32942 "field": "recordingFormat",
32949 "field": "description",
32955 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32956 "version": "0.0.0",
32957 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceChanSpy/index.js",
32958 "groupTitle": "Voice_ChanSpy"
32962 "url": "/api/voice/chanspy/{id}",
32963 "title": "Deletes a ChanSpy",
32966 "title": "Example usage:",
32967 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
32971 "name": "DeleteChanSpy",
32972 "group": "Voice_ChanSpy",
32973 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32974 "version": "0.0.0",
32975 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceChanSpy/index.js",
32976 "groupTitle": "Voice_ChanSpy"
32980 "url": "/api/voice/chanspy",
32981 "title": "Gets a list of ChanSpy",
32984 "title": "Example usage:",
32985 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
32989 "name": "GetChanSpy",
32990 "group": "Voice_ChanSpy",
32991 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/chanspy?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/chanspy?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/chanspy?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/chanspy?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/chanspy?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32992 "version": "0.0.0",
32993 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceChanSpy/index.js",
32994 "groupTitle": "Voice_ChanSpy"
32998 "url": "/api/voice/chanspy/{id}",
32999 "title": "Gets a single ChanSpy",
33002 "title": "Example usage:",
33003 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
33007 "name": "ShowChanSpy",
33008 "group": "Voice_ChanSpy",
33009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33010 "version": "0.0.0",
33011 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceChanSpy/index.js",
33012 "groupTitle": "Voice_ChanSpy"
33016 "url": "/api/voice/chanspy/{id}",
33017 "title": "Update an existing ChanSpy",
33020 "title": "Example usage:",
33021 "content": "curl https://{domain}/api/voice/chanspy/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33025 "name": "updateChanSpy",
33026 "group": "Voice_ChanSpy",
33027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33028 "version": "0.0.0",
33029 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceChanSpy/index.js",
33030 "groupTitle": "Voice_ChanSpy"
33034 "url": "/api/voice/contexts",
33035 "title": "Create a new context",
33038 "title": "Example usage:",
33039 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
33044 "group": "Voice_Contexts",
33059 "field": "description",
33066 "field": "defaultEntry",
33072 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33073 "version": "0.0.0",
33074 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceContext/index.js",
33075 "groupTitle": "Voice_Contexts"
33079 "url": "/api/voice/contexts/{id}",
33080 "title": "Deletes a context",
33083 "title": "Example usage:",
33084 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
33089 "group": "Voice_Contexts",
33090 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33091 "version": "0.0.0",
33092 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceContext/index.js",
33093 "groupTitle": "Voice_Contexts"
33097 "url": "/api/voice/contexts",
33098 "title": "Gets a list of Contexts",
33101 "title": "Example usage:",
33102 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
33106 "name": "GetContexts",
33107 "group": "Voice_Contexts",
33108 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/contexts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/contexts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/contexts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/contexts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/contexts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33109 "version": "0.0.0",
33110 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceContext/index.js",
33111 "groupTitle": "Voice_Contexts"
33115 "url": "/api/voice/contexts/{id}",
33116 "title": "Gets a single Context",
33119 "title": "Example usage:",
33120 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
33124 "name": "ShowContexts",
33125 "group": "Voice_Contexts",
33126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33127 "version": "0.0.0",
33128 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceContext/index.js",
33129 "groupTitle": "Voice_Contexts"
33133 "url": "/api/voice/contexts/{id}",
33134 "title": "Update an existing context",
33137 "title": "Example usage:",
33138 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
33143 "group": "Voice_Contexts",
33144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33145 "version": "0.0.0",
33146 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceContext/index.js",
33147 "groupTitle": "Voice_Contexts"
33151 "url": "/CreateVoiceDialReport",
33152 "title": "Creates a new Dial Report",
33153 "name": "CreateVoiceDialReport",
33154 "group": "Voice_Dial_Reports",
33155 "version": "0.0.0",
33156 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceDialReport/voiceDialReport.rpc.js",
33157 "groupTitle": "Voice_Dial_Reports"
33161 "url": "/api/voice/dials/reports/describe",
33162 "title": "Gets table info about Dial Reports",
33165 "title": "Example usage:",
33166 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
33170 "name": "DescribeDial_Reports",
33171 "group": "Voice_Dial_Reports",
33172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33173 "version": "0.0.0",
33174 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceDialReport/index.js",
33175 "groupTitle": "Voice_Dial_Reports"
33179 "url": "/api/voice/dials/reports",
33180 "title": "Gets a list of Dial Reports",
33183 "title": "Example usage:",
33184 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
33188 "name": "GetDial_Reports",
33189 "group": "Voice_Dial_Reports",
33190 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/dials/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/dials/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/dials/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/dials/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/dials/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33191 "version": "0.0.0",
33192 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceDialReport/index.js",
33193 "groupTitle": "Voice_Dial_Reports"
33197 "url": "/api/voice/dials/reports/{id}",
33198 "title": "Gets a single Dial Report",
33201 "title": "Example usage:",
33202 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
33206 "name": "ShowDial_Reports",
33207 "group": "Voice_Dial_Reports",
33208 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33209 "version": "0.0.0",
33210 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceDialReport/index.js",
33211 "groupTitle": "Voice_Dial_Reports"
33215 "url": "/UpdateVoiceDialReport",
33216 "title": "Updates a new Dial Report",
33217 "name": "UpdateVoiceDialReport",
33218 "group": "Voice_Dial_Reports",
33226 "field": "options.attributes",
33233 "field": "options.where",
33239 "version": "0.0.0",
33240 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceDialReport/voiceDialReport.rpc.js",
33241 "groupTitle": "Voice_Dial_Reports"
33245 "url": "/api/voice/extensions/{id}",
33246 "title": "Deletes a Extension",
33249 "title": "Example usage:",
33250 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
33254 "name": "DeleteExtensions",
33255 "group": "Voice_Extensions",
33256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33257 "version": "0.0.0",
33258 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/index.js",
33259 "groupTitle": "Voice_Extensions"
33263 "url": "/api/voice/extensions",
33264 "title": "Gets a list of Extensions",
33267 "title": "Example usage:",
33268 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
33272 "name": "GetExtensions",
33273 "group": "Voice_Extensions",
33274 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/extensions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/extensions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/extensions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/extensions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/extensions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33275 "version": "0.0.0",
33276 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/index.js",
33277 "groupTitle": "Voice_Extensions"
33281 "url": "/GetVoiceExtension",
33282 "title": "Gets a list of Extensions",
33283 "name": "GetVoiceExtension",
33284 "group": "Voice_Extensions",
33292 "field": "options.attributes",
33299 "field": "options.where",
33305 "version": "0.0.0",
33306 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/voiceExtension.rpc.js",
33307 "groupTitle": "Voice_Extensions"
33311 "url": "/api/voice/extensions/{id}",
33312 "title": "Gets a single Extension",
33315 "title": "Example usage:",
33316 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
33320 "name": "ShowExtensions",
33321 "group": "Voice_Extensions",
33322 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33323 "version": "0.0.0",
33324 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/index.js",
33325 "groupTitle": "Voice_Extensions"
33329 "url": "/api/voice/extensions",
33330 "title": "Create new applications",
33333 "title": "Example usage:",
33334 "content": "curl https://{domain}/api/voice/extensions/{id}/applications -d '[{\"app\": \"Set\", \"appdata\": \"CALLERDNID=${CALLER(dnid)}\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
33338 "name": "addApplications",
33339 "group": "Voice_Extensions",
33340 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33341 "version": "0.0.0",
33342 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/index.js",
33343 "groupTitle": "Voice_Extensions"
33347 "url": "/api/voice/extensions",
33348 "title": "Create an extension",
33351 "title": "Example usage:",
33352 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
33357 "group": "Voice_Extensions",
33358 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33359 "version": "0.0.0",
33360 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/index.js",
33361 "groupTitle": "Voice_Extensions"
33365 "url": "/api/voice/extensions/{id}",
33366 "title": "Update an extension",
33369 "title": "Example usage:",
33370 "content": "curl https://{domain}/api/voice/extensions/{id} -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
33375 "group": "Voice_Extensions",
33376 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33377 "version": "0.0.0",
33378 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceExtension/index.js",
33379 "groupTitle": "Voice_Extensions"
33383 "url": "/api/voice/mohs",
33384 "title": "Create a new a new MOH",
33387 "title": "Example usage:",
33388 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
33393 "group": "Voice_MOHs",
33394 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33395 "version": "0.0.0",
33396 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33397 "groupTitle": "Voice_MOHs"
33401 "url": "/api/voice/mohs/{id}/sounds",
33402 "title": "Add sound to MOH",
33405 "title": "Example usage:",
33406 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
33410 "name": "AddSound",
33411 "group": "Voice_MOHs",
33412 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33413 "version": "0.0.0",
33414 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33415 "groupTitle": "Voice_MOHs"
33419 "url": "/api/voice/mohs/{id}",
33420 "title": "Deletes an MOH",
33423 "title": "Example usage:",
33424 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
33428 "name": "DestroyMoh",
33429 "group": "Voice_MOHs",
33430 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33431 "version": "0.0.0",
33432 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33433 "groupTitle": "Voice_MOHs"
33437 "url": "/api/voice/mohs",
33438 "title": "Gets a list of Music On Holds",
33441 "title": "Example usage:",
33442 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
33446 "name": "GetMusic_On_Holds",
33447 "group": "Voice_MOHs",
33448 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mohs?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mohs?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mohs?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mohs?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mohs?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33449 "version": "0.0.0",
33450 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33451 "groupTitle": "Voice_MOHs"
33455 "url": "/api/voice/mohs/{id}/sounds",
33456 "title": "Gets sounds from MOH",
33459 "title": "Example usage:",
33460 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
33464 "name": "GetSounds",
33465 "group": "Voice_MOHs",
33466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33467 "version": "0.0.0",
33468 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33469 "groupTitle": "Voice_MOHs"
33473 "url": "/api/voice/mohs/{id}/sounds/{id2}",
33474 "title": "Remove sound from MOH",
33477 "title": "Example usage:",
33478 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
33482 "name": "RemoveSound",
33483 "group": "Voice_MOHs",
33484 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33485 "version": "0.0.0",
33486 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33487 "groupTitle": "Voice_MOHs"
33491 "url": "/api/voice/mohs/{id}",
33492 "title": "Gets a single Music On Hold",
33495 "title": "Example usage:",
33496 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
33500 "name": "ShowMusic_On_Holds",
33501 "group": "Voice_MOHs",
33502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33503 "version": "0.0.0",
33504 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33505 "groupTitle": "Voice_MOHs"
33509 "url": "/api/voice/mohs/{id}",
33510 "title": "Update an existing Music On Hold",
33513 "title": "Example usage:",
33514 "content": "curl https://{domain}/api/voice/mohs/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33518 "name": "updateMusic_On_Holds",
33519 "group": "Voice_MOHs",
33520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33521 "version": "0.0.0",
33522 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMusicOnHold/index.js",
33523 "groupTitle": "Voice_MOHs"
33527 "url": "/api/voice/mails",
33528 "title": "Creates a new Mail",
33531 "title": "Example usage:",
33532 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33536 "name": "CreateMails",
33537 "group": "Voice_Mails",
33545 "field": "customer_id",
33552 "field": "context",
33559 "field": "mailbox",
33566 "field": "password",
33573 "field": "fullname",
33623 "field": "dialout",
33630 "field": "callback",
33652 "field": "operator",
33663 "field": "envelope",
33674 "field": "sayduration",
33681 "field": "saydurationm",
33692 "field": "sendvoicemail",
33714 "field": "nextaftercmd",
33725 "field": "forcename",
33736 "field": "forcegreetings",
33747 "field": "hidefromdir",
33761 "field": "emailsubject",
33768 "field": "emailbody",
33775 "field": "maxsecs",
33795 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33796 "version": "0.0.0",
33797 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMail/index.js",
33798 "groupTitle": "Voice_Mails"
33802 "url": "/api/voice/mails/{id}",
33803 "title": "Deletes a Mail",
33806 "title": "Example usage:",
33807 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
33811 "name": "DeleteMails",
33812 "group": "Voice_Mails",
33813 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33814 "version": "0.0.0",
33815 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMail/index.js",
33816 "groupTitle": "Voice_Mails"
33820 "url": "/api/voice/mails",
33821 "title": "Gets a list of Mails",
33824 "title": "Example usage:",
33825 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
33829 "name": "GetMails",
33830 "group": "Voice_Mails",
33831 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mails?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mails?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mails?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mails?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mails?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33832 "version": "0.0.0",
33833 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMail/index.js",
33834 "groupTitle": "Voice_Mails"
33838 "url": "/api/voice/mails/{id}",
33839 "title": "Gets a single Mail",
33842 "title": "Example usage:",
33843 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
33847 "name": "ShowMails",
33848 "group": "Voice_Mails",
33849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33850 "version": "0.0.0",
33851 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMail/index.js",
33852 "groupTitle": "Voice_Mails"
33856 "url": "/api/voice/mails/{id}/messages",
33857 "title": "Gets voice mail messages",
33860 "title": "Example usage:",
33861 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
33865 "name": "getMessages",
33866 "group": "Voice_Mails",
33867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33868 "version": "0.0.0",
33869 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMail/index.js",
33870 "groupTitle": "Voice_Mails"
33874 "url": "/api/voice/mails/{id}",
33875 "title": "Update an existing Mail",
33878 "title": "Example usage:",
33879 "content": "curl https://{domain}/api/voice/mails/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33883 "name": "updateMails",
33884 "group": "Voice_Mails",
33885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33886 "version": "0.0.0",
33887 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMail/index.js",
33888 "groupTitle": "Voice_Mails"
33892 "url": "/api/voice/mails/messages",
33893 "title": "Creates a new Message",
33896 "title": "Example usage:",
33897 "content": "curl https://{domain}/api/voice/mails/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33901 "name": "CreateMessages",
33902 "group": "Voice_Messages",
33931 "field": "context",
33938 "field": "macrocontext",
33945 "field": "callerid",
33952 "field": "origtime",
33959 "field": "duration",
33966 "field": "mailboxuser",
33973 "field": "mailboxcontext",
33980 "field": "recording",
34007 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34008 "version": "0.0.0",
34009 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMailMessage/index.js",
34010 "groupTitle": "Voice_Messages"
34014 "url": "/api/voice/mails/messages/{id}",
34015 "title": "Deletes a Message",
34018 "title": "Example usage:",
34019 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
34023 "name": "DeleteMessages",
34024 "group": "Voice_Messages",
34025 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34026 "version": "0.0.0",
34027 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMailMessage/index.js",
34028 "groupTitle": "Voice_Messages"
34032 "url": "/api/voice/mails/messages",
34033 "title": "Gets a list of Messages",
34036 "title": "Example usage:",
34037 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
34041 "name": "GetMessages",
34042 "group": "Voice_Messages",
34043 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mails/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mails/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mails/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mails/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mails/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34044 "version": "0.0.0",
34045 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMailMessage/index.js",
34046 "groupTitle": "Voice_Messages"
34050 "url": "/api/voice/mails/messages/{id}",
34051 "title": "Gets a single Message",
34054 "title": "Example usage:",
34055 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
34059 "name": "ShowMessages",
34060 "group": "Voice_Messages",
34061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34062 "version": "0.0.0",
34063 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMailMessage/index.js",
34064 "groupTitle": "Voice_Messages"
34068 "url": "voice/mails/messages/{id}/download",
34069 "title": "Download Voice Message",
34072 "title": "Example usage:",
34073 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
34077 "name": "download",
34078 "group": "Voice_Messages",
34079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34080 "version": "0.0.0",
34081 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMailMessage/index.js",
34082 "groupTitle": "Voice_Messages"
34086 "url": "/api/voice/mails/messages/{id}",
34087 "title": "Update an existing Message",
34090 "title": "Example usage:",
34091 "content": "curl https://{domain}/api/voice/mails/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34095 "name": "updateMessages",
34096 "group": "Voice_Messages",
34097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34098 "version": "0.0.0",
34099 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceMailMessage/index.js",
34100 "groupTitle": "Voice_Messages"
34104 "url": "/api/voice/prefixes/{id}/users",
34105 "title": "Add agents to a prefix",
34108 "title": "Example usage:",
34109 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34113 "name": "AddAgents",
34114 "group": "Voice_Prefixes",
34115 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34116 "version": "0.0.0",
34117 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34118 "groupTitle": "Voice_Prefixes"
34122 "url": "/api/voice/prefixes/{id}",
34123 "title": "Deletes a Prefix",
34126 "title": "Example usage:",
34127 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
34131 "name": "DeletePrefixes",
34132 "group": "Voice_Prefixes",
34133 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34134 "version": "0.0.0",
34135 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34136 "groupTitle": "Voice_Prefixes"
34140 "url": "/api/voice/prefixes/describe",
34141 "title": "Gets table info about Prefixes",
34144 "title": "Example usage:",
34145 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
34149 "name": "DescribePrefixes",
34150 "group": "Voice_Prefixes",
34151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34152 "version": "0.0.0",
34153 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34154 "groupTitle": "Voice_Prefixes"
34158 "url": "/api/voice/prefixes/{id}/users",
34159 "title": "Gets agents from prefix",
34162 "title": "Example usage:",
34163 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
34167 "name": "GetAgents",
34168 "group": "Voice_Prefixes",
34169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34170 "version": "0.0.0",
34171 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34172 "groupTitle": "Voice_Prefixes"
34176 "url": "/api/voice/prefixes",
34177 "title": "Gets a list of Prefixes",
34180 "title": "Example usage:",
34181 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
34185 "name": "GetPrefixes",
34186 "group": "Voice_Prefixes",
34187 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/prefixes?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/prefixes?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/prefixes?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/prefixes?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/prefixes?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34188 "version": "0.0.0",
34189 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34190 "groupTitle": "Voice_Prefixes"
34194 "url": "/api/voice/prefixes/{id}/users",
34195 "title": "Removes agents from a prefix",
34198 "title": "Example usage:",
34199 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34203 "name": "RemoveAgents",
34204 "group": "Voice_Prefixes",
34205 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34206 "version": "0.0.0",
34207 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34208 "groupTitle": "Voice_Prefixes"
34212 "url": "/api/voice/prefixes/{id}",
34213 "title": "Gets a single Prefix",
34216 "title": "Example usage:",
34217 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
34221 "name": "ShowPrefixes",
34222 "group": "Voice_Prefixes",
34223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34224 "version": "0.0.0",
34225 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34226 "groupTitle": "Voice_Prefixes"
34230 "url": "/api/voice/prefixes/{id}",
34231 "title": "Update an existing prefix",
34234 "title": "Example usage:",
34235 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
34240 "group": "Voice_Prefixes",
34241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34242 "version": "0.0.0",
34243 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34244 "groupTitle": "Voice_Prefixes"
34248 "url": "/api/voice/prefixes",
34249 "title": "Create a prefix",
34252 "title": "Example usage:",
34253 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34258 "group": "Voice_Prefixes",
34259 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34260 "version": "0.0.0",
34261 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voicePrefix/index.js",
34262 "groupTitle": "Voice_Prefixes"
34266 "url": "/CreateVoiceQueueReport",
34267 "title": "Creates a new Queue Report",
34268 "name": "CreateVoiceQueueReport",
34269 "group": "Voice_Queue_Reports",
34270 "version": "0.0.0",
34271 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/voiceQueueReport.rpc.js",
34272 "groupTitle": "Voice_Queue_Reports"
34276 "url": "/api/voice/queues/reports/describe",
34277 "title": "Gets table info about Queue Reports",
34280 "title": "Example usage:",
34281 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
34285 "name": "DescribeQueue_Reports",
34286 "group": "Voice_Queue_Reports",
34287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34288 "version": "0.0.0",
34289 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/index.js",
34290 "groupTitle": "Voice_Queue_Reports"
34294 "url": "/api/voice/queues/reports",
34295 "title": "Gets a list of Queue Reports",
34298 "title": "Example usage:",
34299 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
34303 "name": "GetQueue_Reports",
34304 "group": "Voice_Queue_Reports",
34305 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/queues/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/queues/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/queues/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/queues/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/queues/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34306 "version": "0.0.0",
34307 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/index.js",
34308 "groupTitle": "Voice_Queue_Reports"
34312 "url": "/GetVoiceQueueReport",
34313 "title": "Gets a list of Queue Reports",
34314 "name": "GetVoiceQueueReport",
34315 "group": "Voice_Queue_Reports",
34323 "field": "options.attributes",
34330 "field": "options.where",
34336 "version": "0.0.0",
34337 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/voiceQueueReport.rpc.js",
34338 "groupTitle": "Voice_Queue_Reports"
34342 "url": "/api/voice/queues/reports/{id}",
34343 "title": "Gets a single Queue Report",
34346 "title": "Example usage:",
34347 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
34351 "name": "ShowQueue_Reports",
34352 "group": "Voice_Queue_Reports",
34353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34354 "version": "0.0.0",
34355 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/index.js",
34356 "groupTitle": "Voice_Queue_Reports"
34360 "url": "/UpdateVoiceQueueReport",
34361 "title": "Updates a new Queue Report",
34362 "name": "UpdateVoiceQueueReport",
34363 "group": "Voice_Queue_Reports",
34371 "field": "options.attributes",
34378 "field": "options.where",
34384 "version": "0.0.0",
34385 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/voiceQueueReport.rpc.js",
34386 "groupTitle": "Voice_Queue_Reports"
34390 "url": "/api/voice/queues/reports/index",
34391 "title": "Get Voice Queues Report",
34394 "title": "Example usage:",
34395 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
34399 "name": "getVoiceQueuesReport",
34400 "group": "Voice_Queue_Reports",
34401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34402 "version": "0.0.0",
34403 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueueReport/index.js",
34404 "groupTitle": "Voice_Queue_Reports"
34408 "url": "/api/voice/queues/{id}/users",
34409 "title": "Add agents to queue",
34412 "title": "Example usage:",
34413 "content": "curl https://{domain}/api/voice/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34417 "name": "AddAgents",
34418 "group": "Voice_Queues",
34419 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34420 "version": "0.0.0",
34421 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
34422 "groupTitle": "Voice_Queues"
34426 "url": "/api/voice/queues/{id}/blacklists",
34427 "title": "Add blacklists to a queue",
34430 "title": "Example usage:",
34431 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34435 "name": "AddBlackLists",
34436 "group": "Voice_Queues",
34437 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34438 "version": "0.0.0",
34439 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
34440 "groupTitle": "Voice_Queues"
34444 "url": "/api/voice/queues/{id}/lists",
34445 "title": "Add lists to a queue",
34448 "title": "Example usage:",
34449 "content": "curl https://{domain}/api/voice/queues/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34453 "name": "AddLists",
34454 "group": "Voice_Queues",
34455 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34456 "version": "0.0.0",
34457 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
34458 "groupTitle": "Voice_Queues"
34462 "url": "/api/voice/queues/{id}/teams",
34463 "title": "Add teams to queue",
34466 "title": "Example usage:",
34467 "content": "curl https://{domain}/api/voice/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34471 "name": "AddTeams",
34472 "group": "Voice_Queues",
34473 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34474 "version": "0.0.0",
34475 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
34476 "groupTitle": "Voice_Queues"
34480 "url": "/api/voice/queues/clone",
34481 "title": "Clone an existing Queue",
34484 "title": "Example usage:",
34485 "content": "curl https://{domain}/api/voice/queues/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34489 "name": "CloneQueues",
34490 "group": "Voice_Queues",
34491 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34492 "version": "0.0.0",
34493 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
34494 "groupTitle": "Voice_Queues"
34498 "url": "/api/voice/queues",
34499 "title": "Creates a new Queue",
34502 "title": "Example usage:",
34503 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34507 "name": "CreateQueues",
34508 "group": "Voice_Queues",
34534 "field": "musiconhold",
34541 "field": "announce",
34559 "field": "strategy",
34566 "field": "servicelevel",
34573 "field": "context",
34580 "field": "penaltymemberslimit",
34587 "field": "timeout",
34601 "field": "timeoutpriority",
34615 "field": "wrapuptime",
34626 "field": "autofill",
34638 "field": "autopause",
34645 "field": "autopausedelay",
34656 "field": "autopausebusy",
34667 "field": "autopauseunavail",
34685 "field": "setinterfacevar",
34696 "field": "setqueueentryvar",
34707 "field": "setqueuevar",
34718 "field": "eventmemberstatus",
34725 "field": "membermacro",
34732 "field": "membergosub",
34739 "field": "announce_frequency",
34746 "field": "min_announce_frequency",
34753 "field": "periodic_announce_frequency",
34764 "field": "random_periodic_announce",
34775 "field": "relative_periodic_announce",
34787 "field": "announce_holdtime",
34794 "field": "announce_position",
34805 "field": "announce_to_first_user",
34812 "field": "announce_position_limit",
34827 "field": "announce_round_seconds",
34834 "field": "monitor_format",
34841 "field": "monitor_type",
34848 "field": "queue_youarenext",
34855 "field": "queue_thereare",
34862 "field": "queue_callswaiting",
34869 "field": "queue_holdtime",
34876 "field": "queue_minute",
34883 "field": "queue_minutes",
34890 "field": "queue_seconds",
34897 "field": "queue_thankyou",
34904 "field": "queue_reporthold",
34911 "field": "queue_quantity1",
34918 "field": "queue_quantity2",
34925 "field": "queue_periodic_announce",
34932 "field": "queue_less_than",
34939 "field": "periodic_announce",
34946 "field": "joinempty",
34953 "field": "leavewhenempty",
34964 "field": "reportholdtime",
34975 "field": "ringinuse",
34982 "field": "memberdelay",
34993 "field": "timeoutrestart",
35000 "field": "defaultrule",
35007 "field": "description",
35021 "field": "acwTimeout",
35028 "field": "dialActive",
35029 "description": "<p>Active/Disactive Campaign</p>"
35042 "field": "dialMethod",
35043 "description": "<p>Dial Method.</p>"
35049 "field": "dialLimitChannel",
35050 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
35056 "field": "dialLimitQueue",
35057 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
35063 "field": "dialPowerLevel",
35064 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
35070 "\"agentBusyFactor\"",
35074 "field": "dialPredictiveOptimization",
35075 "description": "<p>Only for predictive method.</p>"
35081 "field": "dialPredictiveOptimizationPercentage",
35082 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
35088 "field": "dialPredictiveInterval",
35089 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
35095 "field": "dialOriginateCallerIdName",
35102 "field": "dialOriginateCallerIdNumber",
35109 "field": "dialOriginateTimeout",
35110 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
35116 "field": "dialQueueOptions",
35117 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
35123 "field": "dialQueueTimeout",
35124 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
35130 "field": "dialQueueProject",
35131 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
35137 "field": "dialCongestionMaxRetry",
35138 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
35144 "field": "dialCongestionRetryFrequency",
35145 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
35151 "field": "dialBusyMaxRetry",
35152 "description": "<p>#Busy Retry (min:1, max:999)</p>"
35158 "field": "dialBusyRetryFrequency",
35159 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
35165 "field": "dialNoAnswerMaxRetry",
35166 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
35172 "field": "dialNoAnswerRetryFrequency",
35173 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
35179 "field": "dialGlobalMaxRetry",
35180 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
35186 "field": "dialTimezone",
35193 "field": "dialGlobalInterval",
35200 "field": "dialPrefix",
35212 "field": "dialCheckDuplicateType",
35219 "field": "dialAMDActive",
35220 "description": "<p>Active/Disactive AMD</p>"
35226 "field": "dialAMDInitialSilence",
35227 "description": "<p>#AMD Initial Silence</p>"
35233 "field": "dialAMDGreeting",
35234 "description": "<p>#AMD Greeting</p>"
35240 "field": "dialAMDAfterGreetingSilence",
35241 "description": "<p>#AMD After Greeting Silence</p>"
35247 "field": "dialAMDTotalAnalysisTime",
35248 "description": "<p>#AMD Total Analysis Time</p>"
35254 "field": "dialAMDMinWordLength",
35255 "description": "<p>#AMD Min Word Length</p>"
35261 "field": "dialAMDBetweenWordsSilence",
35262 "description": "<p>#AMD Between Words Silence</p>"
35268 "field": "dialAMDMaximumNumberOfWords",
35269 "description": "<p>#AMD Maximum Number Of Words</p>"
35275 "field": "dialAMDSilenceThreshold",
35276 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
35282 "field": "dialAMDMaximumWordLength",
35283 "description": "<p>#AMD Maximum Word Length</p>"
35289 "field": "dialRecallMeTimeout",
35290 "description": "<p>#RecallMe Timeout (min:1)</p>"
35296 "field": "dialRecallInQueue",
35297 "description": "<p>Active/Disactive Recall In Queue</p>"
35307 "field": "dialOrderByScheduledAt",
35314 "field": "dialQueueProject2",
35315 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
35321 "field": "dialAgiAfterHangupClient",
35328 "field": "dialAgiAfterHangupAgent",
35335 "field": "dialRandomLastDigitCallerIdNumber",
35336 "description": "<p>Random Last Digit (min:1, max:15)</p>"
35342 "field": "dialCutDigit",
35343 "description": "<p>Cut Digit (min:1, max:15)</p>"
35349 "field": "dialNoSuchNumberMaxRetry",
35350 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
35356 "field": "dialNoSuchNumberRetryFrequency",
35357 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
35363 "field": "dialDropMaxRetry",
35364 "description": "<p>#Drop Retry (min:1, max:999)</p>"
35370 "field": "dialDropRetryFrequency",
35371 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
35377 "field": "dialAbandonedMaxRetry",
35378 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
35384 "field": "dialAbandonedRetryFrequency",
35385 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
35391 "field": "dialMachineMaxRetry",
35392 "description": "<p>#Machine Retry (min:1, max:999)</p>"
35398 "field": "dialMachineRetryFrequency",
35399 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
35405 "field": "dialAgentRejectMaxRetry",
35406 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
35412 "field": "dialAgentRejectRetryFrequency",
35413 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
35419 "field": "mandatoryDispositionPauseId",
35420 "description": "<p>Status to put when mandatory disposition is enabled</p>"
35426 "field": "mandatoryDisposition",
35427 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35433 "field": "dialPredictiveIntervalMaxThreshold",
35440 "field": "dialPredictiveIntervalMinThreshold",
35446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35447 "version": "0.0.0",
35448 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35449 "groupTitle": "Voice_Queues"
35453 "url": "/api/voice/queues/{id}",
35454 "title": "Deletes a Queue",
35457 "title": "Example usage:",
35458 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
35462 "name": "DeleteQueues",
35463 "group": "Voice_Queues",
35464 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35465 "version": "0.0.0",
35466 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35467 "groupTitle": "Voice_Queues"
35471 "url": "/api/voice/queues/{id}/users",
35472 "title": "Gets queue agents",
35475 "title": "Example usage:",
35476 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
35480 "name": "GetAgents",
35481 "group": "Voice_Queues",
35482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35483 "version": "0.0.0",
35484 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35485 "groupTitle": "Voice_Queues"
35489 "url": "/api/voice/queues/{id}/blacklists",
35490 "title": "Get queue blacklists",
35493 "title": "Example usage:",
35494 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
35498 "name": "GetBlackLists",
35499 "group": "Voice_Queues",
35500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35501 "version": "0.0.0",
35502 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35503 "groupTitle": "Voice_Queues"
35507 "url": "/api/voice/queues/{id}/finals",
35508 "title": "Gets queue hopper finals",
35511 "title": "Example usage:",
35512 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
35516 "name": "GetHopperFinals",
35517 "group": "Voice_Queues",
35518 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35519 "version": "0.0.0",
35520 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35521 "groupTitle": "Voice_Queues"
35525 "url": "/api/voice/queues/{id}/hopper_histories",
35526 "title": "Gets queue hopper histories",
35529 "title": "Example usage:",
35530 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
35534 "name": "GetHopperHistories",
35535 "group": "Voice_Queues",
35536 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35537 "version": "0.0.0",
35538 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35539 "groupTitle": "Voice_Queues"
35543 "url": "/api/voice/queues/{id}/hoppers",
35544 "title": "Gets queue hoppers",
35547 "title": "Example usage:",
35548 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
35552 "name": "GetHoppers",
35553 "group": "Voice_Queues",
35554 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35555 "version": "0.0.0",
35556 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35557 "groupTitle": "Voice_Queues"
35561 "url": "/api/voice/queues/{id}/lists",
35562 "title": "Get queue lists",
35565 "title": "Example usage:",
35566 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
35570 "name": "GetLists",
35571 "group": "Voice_Queues",
35572 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35573 "version": "0.0.0",
35574 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35575 "groupTitle": "Voice_Queues"
35579 "url": "/api/voice/queues/{id}/members",
35580 "title": "Gets queue members",
35583 "title": "Example usage:",
35584 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
35588 "name": "GetMembers",
35589 "group": "Voice_Queues",
35590 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35591 "version": "0.0.0",
35592 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35593 "groupTitle": "Voice_Queues"
35597 "url": "/api/voice/queues",
35598 "title": "Gets a list of Queues",
35601 "title": "Example usage:",
35602 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
35606 "name": "GetQueues",
35607 "group": "Voice_Queues",
35608 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35609 "version": "0.0.0",
35610 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35611 "groupTitle": "Voice_Queues"
35615 "url": "/api/voice/queues/{id}/teams",
35616 "title": "Gets queue team",
35619 "title": "Example usage:",
35620 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
35624 "name": "GetTeams",
35625 "group": "Voice_Queues",
35626 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35627 "version": "0.0.0",
35628 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35629 "groupTitle": "Voice_Queues"
35633 "url": "/GetVoiceQueue",
35634 "title": "Gets a list of Queues",
35635 "name": "GetVoiceQueue",
35636 "group": "Voice_Queues",
35644 "field": "options.attributes",
35651 "field": "options.where",
35657 "version": "0.0.0",
35658 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/voiceQueue.rpc.js",
35659 "groupTitle": "Voice_Queues"
35663 "url": "/api/voice/queues/{id}/users",
35664 "title": "Removes agents from a queue",
35667 "title": "Example usage:",
35668 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35672 "name": "RemoveAgents",
35673 "group": "Voice_Queues",
35674 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35675 "version": "0.0.0",
35676 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35677 "groupTitle": "Voice_Queues"
35681 "url": "/api/voice/queues/{id}/blacklists",
35682 "title": "Remove blacklists from a queue",
35685 "title": "Example usage:",
35686 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35690 "name": "RemoveBlackLists",
35691 "group": "Voice_Queues",
35692 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35693 "version": "0.0.0",
35694 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35695 "groupTitle": "Voice_Queues"
35699 "url": "/api/voice/queues/{id}/lists",
35700 "title": "Remove lists from a queue",
35703 "title": "Example usage:",
35704 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35708 "name": "RemoveLists",
35709 "group": "Voice_Queues",
35710 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35711 "version": "0.0.0",
35712 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35713 "groupTitle": "Voice_Queues"
35717 "url": "/api/voice/queues/{id}",
35718 "title": "Gets a single Queue",
35721 "title": "Example usage:",
35722 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
35726 "name": "ShowQueues",
35727 "group": "Voice_Queues",
35728 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35729 "version": "0.0.0",
35730 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35731 "groupTitle": "Voice_Queues"
35735 "url": "/ShowVoiceQueue",
35736 "title": "Gets a single Queue",
35737 "name": "ShowVoiceQueue",
35738 "group": "Voice_Queues",
35746 "field": "options.attributes",
35753 "field": "options.where",
35759 "version": "0.0.0",
35760 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/voiceQueue.rpc.js",
35761 "groupTitle": "Voice_Queues"
35765 "url": "/api/voice/queues/{id}/blacks",
35766 "title": "Gets queue hopper blacks",
35769 "title": "Example usage:",
35770 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
35774 "name": "getHopperBlacks",
35775 "group": "Voice_Queues",
35776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35777 "version": "0.0.0",
35778 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35779 "groupTitle": "Voice_Queues"
35783 "url": "/api/voice/queues/{id}",
35784 "title": "Update an existing Queue",
35787 "title": "Example usage:",
35788 "content": "curl https://{domain}/api/voice/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35792 "name": "updateQueues",
35793 "group": "Voice_Queues",
35794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35795 "version": "0.0.0",
35796 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueue/index.js",
35797 "groupTitle": "Voice_Queues"
35801 "url": "/api/voice/recordings",
35802 "title": "Creates a new Recording",
35805 "title": "Example usage:",
35806 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35810 "name": "CreateRecordings",
35811 "group": "Voice_Recordings",
35826 "field": "uniqueid",
35833 "field": "channel",
35840 "field": "membername",
35847 "field": "calleridnum",
35854 "field": "calleridname",
35861 "field": "connectedlinenum",
35868 "field": "connectedlinename",
35875 "field": "accountcode",
35882 "field": "context",
35924 "field": "userDisposition",
35931 "field": "userSecondDisposition",
35938 "field": "userThirdDisposition",
35945 "field": "location",
35952 "field": "transcribeName",
35959 "field": "transcribeStatus",
35966 "field": "fileUri",
35973 "field": "fileText",
35980 "field": "failureReason",
35987 "field": "sentiment",
35994 "field": "sPositive",
36001 "field": "sNegative",
36008 "field": "sNeutral",
36022 "field": "tempSentiment",
36029 "field": "createdAt",
36036 "field": "updatedAt",
36042 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36043 "version": "0.0.0",
36044 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36045 "groupTitle": "Voice_Recordings"
36049 "url": "/CreateVoiceRecording",
36050 "title": "Creates a new Recording",
36051 "name": "CreateVoiceRecording",
36052 "group": "Voice_Recordings",
36053 "version": "0.0.0",
36054 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/voiceRecording.rpc.js",
36055 "groupTitle": "Voice_Recordings"
36059 "url": "/api/voice/recordings/describe",
36060 "title": "Gets table info about Recordings",
36063 "title": "Example usage:",
36064 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
36068 "name": "DescribeRecordings",
36069 "group": "Voice_Recordings",
36070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36071 "version": "0.0.0",
36072 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36073 "groupTitle": "Voice_Recordings"
36077 "url": "/api/voice/recordings",
36078 "title": "Gets a list of Recordings",
36081 "title": "Example usage:",
36082 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
36086 "name": "GetRecordings",
36087 "group": "Voice_Recordings",
36088 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/recordings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36089 "version": "0.0.0",
36090 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36091 "groupTitle": "Voice_Recordings"
36095 "url": "/api/voice/recordings/{id}",
36096 "title": "Gets a single Recording",
36099 "title": "Example usage:",
36100 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
36104 "name": "ShowRecordings",
36105 "group": "Voice_Recordings",
36106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36107 "version": "0.0.0",
36108 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36109 "groupTitle": "Voice_Recordings"
36113 "url": "/UpdateVoiceRecording",
36114 "title": "Updates a new Recording",
36115 "name": "UpdateVoiceRecording",
36116 "group": "Voice_Recordings",
36124 "field": "options.attributes",
36131 "field": "options.where",
36137 "version": "0.0.0",
36138 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/voiceRecording.rpc.js",
36139 "groupTitle": "Voice_Recordings"
36143 "url": "/api/voice/recordings/{id}",
36144 "title": "Delete voice recording",
36147 "title": "Example usage:",
36148 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
36153 "group": "Voice_Recordings",
36154 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36155 "version": "0.0.0",
36156 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36157 "groupTitle": "Voice_Recordings"
36161 "url": "/api/voice/recordings/{id}/download",
36162 "title": "Download Recording",
36165 "title": "Example usage:",
36166 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
36170 "name": "download",
36171 "group": "Voice_Recordings",
36172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36173 "version": "0.0.0",
36174 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36175 "groupTitle": "Voice_Recordings"
36179 "url": "/api/voice/recordings/{id}/downloads",
36180 "title": "Download Recording",
36183 "title": "Example usage:",
36184 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
36188 "name": "downloads",
36189 "group": "Voice_Recordings",
36190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36191 "version": "0.0.0",
36192 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36193 "groupTitle": "Voice_Recordings"
36197 "url": "/api/voice/recordings/{id}/transcribe",
36198 "title": "Run Transcribe Recording",
36201 "title": "Example usage:",
36202 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
36206 "name": "transcribe",
36207 "group": "Voice_Recordings",
36208 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36209 "version": "0.0.0",
36210 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36211 "groupTitle": "Voice_Recordings"
36215 "url": "/api/voice/recordings/{id}/transcribe",
36216 "title": "Run Transcribe Recording",
36219 "title": "Example usage:",
36220 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
36224 "name": "transcribe",
36225 "group": "Voice_Recordings",
36226 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36227 "version": "0.0.0",
36228 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36229 "groupTitle": "Voice_Recordings"
36233 "url": "/api/voice/recordings/{id}",
36234 "title": "Update an existing Recording",
36237 "title": "Example usage:",
36238 "content": "curl https://{domain}/api/voice/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36242 "name": "updateRecordings",
36243 "group": "Voice_Recordings",
36244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36245 "version": "0.0.0",
36246 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceRecording/index.js",
36247 "groupTitle": "Voice_Recordings"
36251 "url": "/api/voice/transfers/reports",
36252 "title": "Creates a new Transfer Report",
36255 "title": "Example usage:",
36256 "content": "curl https://{domain}/api/voice/transfers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36260 "name": "CreateTransfer_Reports",
36261 "group": "Voice_Transfer_Reports",
36287 "field": "transfererchannel",
36294 "field": "transferercalleridnum",
36301 "field": "transferercalleridname",
36308 "field": "transfererconnectedlinenum",
36315 "field": "transfererconnectedlinename",
36322 "field": "transfereraccountcode",
36329 "field": "transferercontext",
36336 "field": "transfererexten",
36343 "field": "transfererlinkedid",
36350 "field": "transfereechannel",
36357 "field": "transfereecalleridnum",
36364 "field": "transfereecalleridname",
36371 "field": "transfereeconnectedlinenum",
36378 "field": "transfereeconnectedlinename",
36385 "field": "transfereeaccountcode",
36392 "field": "transfereecontext",
36399 "field": "transfereeexten",
36406 "field": "transfereelinkedid",
36417 "field": "isexternal",
36424 "field": "context",
36431 "field": "extension",
36437 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36438 "version": "0.0.0",
36439 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceTransferReport/index.js",
36440 "groupTitle": "Voice_Transfer_Reports"
36444 "url": "/CreateVoiceTransferReport",
36445 "title": "Creates a new Transfer Report",
36446 "name": "CreateVoiceTransferReport",
36447 "group": "Voice_Transfer_Reports",
36448 "version": "0.0.0",
36449 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceTransferReport/voiceTransferReport.rpc.js",
36450 "groupTitle": "Voice_Transfer_Reports"
36454 "url": "/api/voice/transfers/reports/{id}",
36455 "title": "Deletes a Transfer Report",
36458 "title": "Example usage:",
36459 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
36463 "name": "DeleteTransfer_Reports",
36464 "group": "Voice_Transfer_Reports",
36465 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36466 "version": "0.0.0",
36467 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceTransferReport/index.js",
36468 "groupTitle": "Voice_Transfer_Reports"
36472 "url": "/api/voice/transfers/reports",
36473 "title": "Gets a list of Transfer Reports",
36476 "title": "Example usage:",
36477 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
36481 "name": "GetTransfer_Reports",
36482 "group": "Voice_Transfer_Reports",
36483 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/transfers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/transfers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/transfers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/transfers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/transfers/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36484 "version": "0.0.0",
36485 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceTransferReport/index.js",
36486 "groupTitle": "Voice_Transfer_Reports"
36490 "url": "/api/voice/transfers/reports/{id}",
36491 "title": "Gets a single Transfer Report",
36494 "title": "Example usage:",
36495 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
36499 "name": "ShowTransfer_Reports",
36500 "group": "Voice_Transfer_Reports",
36501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36502 "version": "0.0.0",
36503 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceTransferReport/index.js",
36504 "groupTitle": "Voice_Transfer_Reports"
36508 "url": "/api/voice/transfers/reports/{id}",
36509 "title": "Update an existing Transfer Report",
36512 "title": "Example usage:",
36513 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36517 "name": "updateTransfer_Reports",
36518 "group": "Voice_Transfer_Reports",
36519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36520 "version": "0.0.0",
36521 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceTransferReport/index.js",
36522 "groupTitle": "Voice_Transfer_Reports"
36526 "url": "/api/integrations/vtiger/accounts",
36527 "title": "Creates a new Vtiger Account",
36530 "title": "Example usage:",
36531 "content": "curl https://{domain}/api/integrations/vtiger/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36535 "name": "CreateVtiger_Accounts",
36536 "group": "Vtiger_Accounts",
36551 "field": "description",
36558 "field": "username",
36565 "field": "moduleName",
36572 "field": "remoteUri",
36579 "field": "serverUrl",
36586 "field": "accessKey",
36592 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36593 "version": "0.0.0",
36594 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36595 "groupTitle": "Vtiger_Accounts"
36599 "url": "/api/integrations/vtiger/accounts/{id}",
36600 "title": "Deletes a Vtiger Account",
36603 "title": "Example usage:",
36604 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
36608 "name": "DeleteVtiger_Accounts",
36609 "group": "Vtiger_Accounts",
36610 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36611 "version": "0.0.0",
36612 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36613 "groupTitle": "Vtiger_Accounts"
36617 "url": "/GetVtigerAccount",
36618 "title": "Gets a list of Vtiger Accounts",
36619 "name": "GetVtigerAccount",
36620 "group": "Vtiger_Accounts",
36628 "field": "options.attributes",
36635 "field": "options.where",
36641 "version": "0.0.0",
36642 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/intVtigerAccount.rpc.js",
36643 "groupTitle": "Vtiger_Accounts"
36647 "url": "/api/integrations/vtiger/accounts",
36648 "title": "Gets a list of Vtiger Accounts",
36651 "title": "Example usage:",
36652 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
36656 "name": "GetVtiger_Accounts",
36657 "group": "Vtiger_Accounts",
36658 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36659 "version": "0.0.0",
36660 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36661 "groupTitle": "Vtiger_Accounts"
36665 "url": "/ShowVtigerAccount",
36666 "title": "Gets a single Vtiger Account",
36667 "name": "ShowVtigerAccount",
36668 "group": "Vtiger_Accounts",
36676 "field": "options.attributes",
36683 "field": "options.where",
36689 "version": "0.0.0",
36690 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/intVtigerAccount.rpc.js",
36691 "groupTitle": "Vtiger_Accounts"
36695 "url": "/api/integrations/vtiger/accounts/{id}",
36696 "title": "Gets a single Vtiger Account",
36699 "title": "Example usage:",
36700 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
36704 "name": "ShowVtiger_Accounts",
36705 "group": "Vtiger_Accounts",
36706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36707 "version": "0.0.0",
36708 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36709 "groupTitle": "Vtiger_Accounts"
36713 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
36714 "title": "Creates new configuration",
36717 "title": "Example usage:",
36718 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36722 "name": "addConfiguration",
36723 "group": "Vtiger_Accounts",
36724 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36725 "version": "0.0.0",
36726 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36727 "groupTitle": "Vtiger_Accounts"
36731 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
36732 "title": "Gets account configurations",
36735 "title": "Example usage:",
36736 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36740 "name": "getConfigurations",
36741 "group": "Vtiger_Accounts",
36742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36743 "version": "0.0.0",
36744 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36745 "groupTitle": "Vtiger_Accounts"
36749 "url": "/api/integrations/vtiger/accounts/{id}/fields",
36750 "title": "Gets account fields",
36753 "title": "Example usage:",
36754 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
36758 "name": "getFields",
36759 "group": "Vtiger_Accounts",
36760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36761 "version": "0.0.0",
36762 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36763 "groupTitle": "Vtiger_Accounts"
36767 "url": "/api/integrations/vtiger/accounts/{id}",
36768 "title": "Update an existing Vtiger Account",
36771 "title": "Example usage:",
36772 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36776 "name": "updateVtiger_Accounts",
36777 "group": "Vtiger_Accounts",
36778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36779 "version": "0.0.0",
36780 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerAccount/index.js",
36781 "groupTitle": "Vtiger_Accounts"
36785 "url": "/api/integrations/vtiger/configurations",
36786 "title": "Creates a new Vtiger Configuration",
36789 "title": "Example usage:",
36790 "content": "curl https://{domain}/api/integrations/vtiger/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36794 "name": "CreateVtiger_Configurations",
36795 "group": "Vtiger_Configurations",
36810 "field": "description",
36816 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36817 "version": "0.0.0",
36818 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36819 "groupTitle": "Vtiger_Configurations"
36823 "url": "/api/integrations/vtiger/configurations/{id}",
36824 "title": "Deletes a Vtiger Configuration",
36827 "title": "Example usage:",
36828 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
36832 "name": "DeleteVtiger_Configurations",
36833 "group": "Vtiger_Configurations",
36834 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36835 "version": "0.0.0",
36836 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36837 "groupTitle": "Vtiger_Configurations"
36841 "url": "/api/integrations/vtiger/configurations",
36842 "title": "Gets a list of Vtiger Configurations",
36845 "title": "Example usage:",
36846 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
36850 "name": "GetVtiger_Configurations",
36851 "group": "Vtiger_Configurations",
36852 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36853 "version": "0.0.0",
36854 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36855 "groupTitle": "Vtiger_Configurations"
36859 "url": "/api/integrations/vtiger/configurations/{id}",
36860 "title": "Gets a single Vtiger Configuration",
36863 "title": "Example usage:",
36864 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
36868 "name": "ShowVtiger_Configurations",
36869 "group": "Vtiger_Configurations",
36870 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36871 "version": "0.0.0",
36872 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36873 "groupTitle": "Vtiger_Configurations"
36877 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
36878 "title": "Gets configurations descriptions",
36881 "title": "Example usage:",
36882 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36886 "name": "getDescriptions",
36887 "group": "Vtiger_Configurations",
36888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36889 "version": "0.0.0",
36890 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36891 "groupTitle": "Vtiger_Configurations"
36895 "url": "/api/integrations/vtiger/configurations/{id}/fields",
36896 "title": "Gets configurations fields",
36899 "title": "Example usage:",
36900 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
36904 "name": "getFields",
36905 "group": "Vtiger_Configurations",
36906 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36907 "version": "0.0.0",
36908 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36909 "groupTitle": "Vtiger_Configurations"
36913 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
36914 "title": "Gets configurations subjects",
36917 "title": "Example usage:",
36918 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36922 "name": "getSubjects",
36923 "group": "Vtiger_Configurations",
36924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36925 "version": "0.0.0",
36926 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36927 "groupTitle": "Vtiger_Configurations"
36931 "url": "/api/integrations/vtiger/configurations/{id}",
36932 "title": "Update an existing Vtiger Configuration",
36935 "title": "Example usage:",
36936 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36940 "name": "updateVtiger_Configurations",
36941 "group": "Vtiger_Configurations",
36942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36943 "version": "0.0.0",
36944 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerConfiguration/index.js",
36945 "groupTitle": "Vtiger_Configurations"
36949 "url": "/api/integrations/vtiger/fields",
36950 "title": "Creates a new Vtiger Field",
36953 "title": "Example usage:",
36954 "content": "curl https://{domain}/api/integrations/vtiger/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36958 "name": "CreateVtiger_Fields",
36959 "group": "Vtiger_Fields",
36969 "\"customVariable\"",
36980 "field": "content",
36996 "\"customVariable\""
36999 "field": "keyType",
37006 "field": "keyContent",
37013 "field": "idField",
37020 "field": "nameField",
37027 "field": "customField",
37034 "field": "variableName",
37040 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37041 "version": "0.0.0",
37042 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerField/index.js",
37043 "groupTitle": "Vtiger_Fields"
37047 "url": "/api/integrations/vtiger/fields/{id}",
37048 "title": "Deletes a Vtiger Field",
37051 "title": "Example usage:",
37052 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
37056 "name": "DeleteVtiger_Fields",
37057 "group": "Vtiger_Fields",
37058 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37059 "version": "0.0.0",
37060 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerField/index.js",
37061 "groupTitle": "Vtiger_Fields"
37065 "url": "/api/integrations/vtiger/fields",
37066 "title": "Gets a list of Vtiger Fields",
37069 "title": "Example usage:",
37070 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
37074 "name": "GetVtiger_Fields",
37075 "group": "Vtiger_Fields",
37076 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37077 "version": "0.0.0",
37078 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerField/index.js",
37079 "groupTitle": "Vtiger_Fields"
37083 "url": "/api/integrations/vtiger/fields/{id}",
37084 "title": "Gets a single Vtiger Field",
37087 "title": "Example usage:",
37088 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
37092 "name": "ShowVtiger_Fields",
37093 "group": "Vtiger_Fields",
37094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37095 "version": "0.0.0",
37096 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerField/index.js",
37097 "groupTitle": "Vtiger_Fields"
37101 "url": "/api/integrations/vtiger/fields/{id}",
37102 "title": "Update an existing Vtiger Field",
37105 "title": "Example usage:",
37106 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37110 "name": "updateVtiger_Fields",
37111 "group": "Vtiger_Fields",
37112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37113 "version": "0.0.0",
37114 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intVtigerField/index.js",
37115 "groupTitle": "Vtiger_Fields"
37119 "url": "/api/webbar/answer",
37120 "title": "answer webrtc call",
37123 "title": "Example usage:",
37124 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
37128 "name": "Web_Bar_answer",
37137 "field": "sessionId",
37150 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37151 "version": "0.0.0",
37152 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37153 "groupTitle": "WebBar"
37157 "url": "/api/webbar/calls",
37158 "title": "webrtc call list",
37161 "title": "Example usage:",
37162 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
37166 "name": "Web_Bar_calls",
37181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37182 "version": "0.0.0",
37183 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37184 "groupTitle": "WebBar"
37188 "url": "/api/webbar/hangup",
37189 "title": "hangup webrtc call",
37192 "title": "Example usage:",
37193 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
37197 "name": "Web_Bar_hangup",
37206 "field": "sessionId",
37219 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37220 "version": "0.0.0",
37221 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37222 "groupTitle": "WebBar"
37226 "url": "/api/webbar/hold",
37227 "title": "hold webrtc call",
37230 "title": "Example usage:",
37231 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
37235 "name": "Web_Bar_hold",
37244 "field": "sessionId",
37257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37258 "version": "0.0.0",
37259 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37260 "groupTitle": "WebBar"
37264 "url": "/api/webbar/unhold",
37265 "title": "unhold webrtc call",
37268 "title": "Example usage:",
37269 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
37273 "name": "Web_Bar_hold",
37282 "field": "sessionId",
37295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37296 "version": "0.0.0",
37297 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37298 "groupTitle": "WebBar"
37302 "url": "/api/webbar/originate",
37303 "title": "Originate new webrtc call",
37306 "title": "Example usage:",
37307 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
37311 "name": "Web_Bar_originate",
37320 "field": "callNumber",
37334 "field": "callerId",
37341 "field": "callbackUrl",
37347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37348 "version": "0.0.0",
37349 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37350 "groupTitle": "WebBar"
37354 "url": "/api/webbar/transfer",
37355 "title": "blind transfer webrtc call",
37358 "title": "Example usage:",
37359 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
37363 "name": "Web_Bar_transfer",
37379 "field": "sessionId",
37386 "field": "transferNumber",
37392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37393 "version": "0.0.0",
37394 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/webbar/index.js",
37395 "groupTitle": "WebBar"
37399 "url": "/api/whatsapp/accounts/{id}/users",
37400 "title": "Add agents to a whatsapp account",
37403 "title": "Example usage:",
37404 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37408 "name": "AddAgents",
37409 "group": "Whatsapp_Accounts",
37410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37411 "version": "0.0.0",
37412 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37413 "groupTitle": "Whatsapp_Accounts"
37417 "url": "/api/whatsapp/accounts",
37418 "title": "Creates a new Account",
37421 "title": "Example usage:",
37422 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37426 "name": "CreateAccounts",
37427 "group": "Whatsapp_Accounts",
37480 "field": "accountSid",
37487 "field": "authToken",
37494 "field": "notificationTemplate",
37501 "field": "notificationSound",
37508 "field": "notificationShake",
37515 "field": "waitForTheAssignedAgent",
37522 "field": "queueTransfer",
37529 "field": "queueTransferTimeout",
37536 "field": "agentTransfer",
37543 "field": "agentTransferTimeout",
37550 "field": "mandatoryDispositionPauseId",
37551 "description": "<p>Status to put when mandatory disposition is enabled</p>"
37557 "field": "mandatoryDisposition",
37558 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
37564 "field": "description",
37570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37571 "version": "0.0.0",
37572 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37573 "groupTitle": "Whatsapp_Accounts"
37577 "url": "/api/whatsapp/accounts/{id}",
37578 "title": "Deletes a Account",
37581 "title": "Example usage:",
37582 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
37586 "name": "DeleteAccounts",
37587 "group": "Whatsapp_Accounts",
37588 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37589 "version": "0.0.0",
37590 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37591 "groupTitle": "Whatsapp_Accounts"
37595 "url": "/api/whatsapp/accounts/describe",
37596 "title": "Gets table info about Accounts",
37599 "title": "Example usage:",
37600 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
37604 "name": "DescribeAccounts",
37605 "group": "Whatsapp_Accounts",
37606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37607 "version": "0.0.0",
37608 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37609 "groupTitle": "Whatsapp_Accounts"
37613 "url": "/api/whatsapp/accounts",
37614 "title": "Gets a list of Accounts",
37617 "title": "Example usage:",
37618 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
37622 "name": "GetAccounts",
37623 "group": "Whatsapp_Accounts",
37624 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37625 "version": "0.0.0",
37626 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37627 "groupTitle": "Whatsapp_Accounts"
37631 "url": "/api/whatsapp/accounts/{id}/users",
37632 "title": "Gets agents from whatsapp account",
37635 "title": "Example usage:",
37636 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
37640 "name": "GetAgents",
37641 "group": "Whatsapp_Accounts",
37642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37643 "version": "0.0.0",
37644 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37645 "groupTitle": "Whatsapp_Accounts"
37649 "url": "/api/whatsapp/accounts/{id}/users",
37650 "title": "Removes agents from a whatsapp account",
37653 "title": "Example usage:",
37654 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
37658 "name": "RemoveAgents",
37659 "group": "Whatsapp_Accounts",
37660 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37661 "version": "0.0.0",
37662 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37663 "groupTitle": "Whatsapp_Accounts"
37667 "url": "/api/whatsapp/accounts/{id}/canned_answers",
37668 "title": "Removes canned answers from account",
37671 "title": "Example usage:",
37672 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
37676 "name": "RemoveAnswers",
37677 "group": "Whatsapp_Accounts",
37678 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37679 "version": "0.0.0",
37680 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37681 "groupTitle": "Whatsapp_Accounts"
37685 "url": "/api/whatsapp/accounts/{id}/dispositions",
37686 "title": "Removes dispositions from account",
37689 "title": "Example usage:",
37690 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
37694 "name": "RemoveDispositions",
37695 "group": "Whatsapp_Accounts",
37696 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37697 "version": "0.0.0",
37698 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37699 "groupTitle": "Whatsapp_Accounts"
37703 "url": "/api/whatsapp/accounts/{id}",
37704 "title": "Gets a single Account",
37707 "title": "Example usage:",
37708 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
37712 "name": "ShowAccounts",
37713 "group": "Whatsapp_Accounts",
37714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37715 "version": "0.0.0",
37716 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37717 "groupTitle": "Whatsapp_Accounts"
37721 "url": "/ShowWhatsappAccount",
37722 "title": "Gets a single Account",
37723 "name": "ShowWhatsappAccount",
37724 "group": "Whatsapp_Accounts",
37732 "field": "options.attributes",
37739 "field": "options.where",
37745 "version": "0.0.0",
37746 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/whatsappAccount.rpc.js",
37747 "groupTitle": "Whatsapp_Accounts"
37751 "url": "/api/whatsapp/messages/{id}/accept",
37752 "title": "Accepts message",
37755 "title": "Example usage:",
37756 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
37760 "name": "acceptMessage",
37761 "group": "Whatsapp_Accounts",
37762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37763 "version": "0.0.0",
37764 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
37765 "groupTitle": "Whatsapp_Accounts"
37769 "url": "/api/whatsapp/accounts/{id}/canned_answers",
37770 "title": "Creates new canned answer",
37773 "title": "Example usage:",
37774 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37778 "name": "addAnswer",
37779 "group": "Whatsapp_Accounts",
37801 "field": "description",
37814 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37815 "version": "0.0.0",
37816 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37817 "groupTitle": "Whatsapp_Accounts"
37821 "url": "/api/whatsapp/accounts/{id}/applications",
37822 "title": "Creates new applications",
37825 "title": "Example usage:",
37826 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37830 "name": "addApplications",
37831 "group": "Whatsapp_Accounts",
37839 "field": "priority",
37853 "field": "appdata",
37860 "field": "description",
37867 "field": "interval",
37873 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37874 "version": "0.0.0",
37875 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37876 "groupTitle": "Whatsapp_Accounts"
37880 "url": "/api/whatsapp/accounts/{id}/dispositions",
37881 "title": "Creates new disposition",
37884 "title": "Example usage:",
37885 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37889 "name": "addDisposition",
37890 "group": "Whatsapp_Accounts",
37917 "field": "description",
37923 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37924 "version": "0.0.0",
37925 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37926 "groupTitle": "Whatsapp_Accounts"
37930 "url": "/api/whatsapp/accounts/{id}/canned_answers",
37931 "title": "Gets account canned answers",
37934 "title": "Example usage:",
37935 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
37939 "name": "getAnswers",
37940 "group": "Whatsapp_Accounts",
37941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37942 "version": "0.0.0",
37943 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37944 "groupTitle": "Whatsapp_Accounts"
37948 "url": "/api/whatsapp/accounts/{id}/applications",
37949 "title": "Gets account applications",
37952 "title": "Example usage:",
37953 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
37957 "name": "getApplications",
37958 "group": "Whatsapp_Accounts",
37959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37960 "version": "0.0.0",
37961 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37962 "groupTitle": "Whatsapp_Accounts"
37966 "url": "/api/whatsapp/accounts/{id}/dispositions",
37967 "title": "Gets account dispositions",
37970 "title": "Example usage:",
37971 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
37975 "name": "getDispositions",
37976 "group": "Whatsapp_Accounts",
37977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37978 "version": "0.0.0",
37979 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37980 "groupTitle": "Whatsapp_Accounts"
37984 "url": "/api/whatsapp/accounts/{id}/notify",
37985 "title": "Notify new message",
37988 "title": "Example usage:",
37989 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37994 "group": "Whatsapp_Accounts",
37995 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new whatsapp message to be sent to the system.</p>",
37996 "version": "0.0.0",
37997 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
37998 "groupTitle": "Whatsapp_Accounts"
38002 "url": "/api/whatsapp/messages/{id}/reject",
38003 "title": "Rejects message",
38006 "title": "Example usage:",
38007 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
38011 "name": "rejectMessage",
38012 "group": "Whatsapp_Accounts",
38013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38014 "version": "0.0.0",
38015 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38016 "groupTitle": "Whatsapp_Accounts"
38020 "url": "/api/whatsapp/accounts/{id}/send",
38021 "title": "Send new whatsapp message",
38024 "title": "Example usage:",
38025 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
38029 "name": "sendWhatsapp",
38030 "group": "Whatsapp_Accounts",
38031 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38032 "version": "0.0.0",
38033 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
38034 "groupTitle": "Whatsapp_Accounts"
38038 "url": "/api/whatsapp/messages/{id}/status",
38039 "title": "Receive message status",
38042 "title": "Example usage:",
38043 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
38047 "name": "statusMessage",
38048 "group": "Whatsapp_Accounts",
38049 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38050 "version": "0.0.0",
38051 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38052 "groupTitle": "Whatsapp_Accounts"
38056 "url": "/api/whatsapp/accounts/{id}",
38057 "title": "Update an existing Account",
38060 "title": "Example usage:",
38061 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38065 "name": "updateAccounts",
38066 "group": "Whatsapp_Accounts",
38067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38068 "version": "0.0.0",
38069 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappAccount/index.js",
38070 "groupTitle": "Whatsapp_Accounts"
38074 "url": "/api/whatsapp/applications",
38075 "title": "Creates a new Application",
38078 "title": "Example usage:",
38079 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38083 "name": "CreateApplications",
38084 "group": "Whatsapp_Applications",
38092 "field": "priority",
38106 "field": "appdata",
38113 "field": "description",
38120 "field": "interval",
38126 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38127 "version": "0.0.0",
38128 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappApplication/index.js",
38129 "groupTitle": "Whatsapp_Applications"
38133 "url": "/api/whatsapp/applications/{id}",
38134 "title": "Deletes a Application",
38137 "title": "Example usage:",
38138 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
38142 "name": "DeleteApplications",
38143 "group": "Whatsapp_Applications",
38144 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38145 "version": "0.0.0",
38146 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappApplication/index.js",
38147 "groupTitle": "Whatsapp_Applications"
38151 "url": "/api/whatsapp/applications",
38152 "title": "Gets a list of Applications",
38155 "title": "Example usage:",
38156 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
38160 "name": "GetApplications",
38161 "group": "Whatsapp_Applications",
38162 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38163 "version": "0.0.0",
38164 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappApplication/index.js",
38165 "groupTitle": "Whatsapp_Applications"
38169 "url": "/api/whatsapp/applications/{id}",
38170 "title": "Gets a single Application",
38173 "title": "Example usage:",
38174 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
38178 "name": "ShowApplications",
38179 "group": "Whatsapp_Applications",
38180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38181 "version": "0.0.0",
38182 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappApplication/index.js",
38183 "groupTitle": "Whatsapp_Applications"
38187 "url": "/api/whatsapp/applications/{id}",
38188 "title": "Update an existing Application",
38191 "title": "Example usage:",
38192 "content": "curl https://{domain}/api/whatsapp/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38196 "name": "updateApplications",
38197 "group": "Whatsapp_Applications",
38198 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38199 "version": "0.0.0",
38200 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappApplication/index.js",
38201 "groupTitle": "Whatsapp_Applications"
38205 "url": "/api/whatsapp/interactions/{id}/tags",
38206 "title": "Add tags to the interaction",
38209 "title": "Example usage:",
38210 "content": "curl https://{domain}/api/whatsapp/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
38215 "group": "Whatsapp_Interactions",
38216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38217 "version": "0.0.0",
38218 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38219 "groupTitle": "Whatsapp_Interactions"
38223 "url": "/AddTagsToWhatsappInteraction",
38224 "title": "Add Tags to Whatsapp interaction",
38225 "name": "AddTagsToWhatsappInteraction",
38226 "group": "Whatsapp_Interactions",
38234 "field": "options.attributes",
38241 "field": "options.where",
38247 "version": "0.0.0",
38248 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/whatsappInteraction.rpc.js",
38249 "groupTitle": "Whatsapp_Interactions"
38253 "url": "/api/whatsapp/interactions",
38254 "title": "Creates a new Interaction",
38257 "title": "Example usage:",
38258 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38262 "name": "CreateInteractions",
38263 "group": "Whatsapp_Interactions",
38278 "field": "closedAt",
38285 "field": "disposition",
38292 "field": "secondDisposition",
38299 "field": "thirdDisposition",
38320 "field": "read1stAt",
38331 "field": "firstMsgDirection",
38338 "field": "lastMsgAt",
38349 "field": "lastMsgDirection",
38355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38356 "version": "0.0.0",
38357 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38358 "groupTitle": "Whatsapp_Interactions"
38362 "url": "/api/whatsapp/interactions/{id}",
38363 "title": "Deletes a Interaction",
38366 "title": "Example usage:",
38367 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
38371 "name": "DeleteInteractions",
38372 "group": "Whatsapp_Interactions",
38373 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38374 "version": "0.0.0",
38375 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38376 "groupTitle": "Whatsapp_Interactions"
38380 "url": "/api/whatsapp/interactions/describe",
38381 "title": "Gets table info about Interactions",
38384 "title": "Example usage:",
38385 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
38389 "name": "DescribeInteractions",
38390 "group": "Whatsapp_Interactions",
38391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38392 "version": "0.0.0",
38393 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38394 "groupTitle": "Whatsapp_Interactions"
38398 "url": "/api/whatsapp/interactions",
38399 "title": "Gets a list of Interactions",
38402 "title": "Example usage:",
38403 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
38407 "name": "GetInteractions",
38408 "group": "Whatsapp_Interactions",
38409 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38410 "version": "0.0.0",
38411 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38412 "groupTitle": "Whatsapp_Interactions"
38416 "url": "/api/whatsapp/interactions/{id}/tags",
38417 "title": "Removes tags from interaction",
38420 "title": "Example usage:",
38421 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
38425 "name": "RemoveTags",
38426 "group": "Whatsapp_Interactions",
38427 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38428 "version": "0.0.0",
38429 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38430 "groupTitle": "Whatsapp_Interactions"
38434 "url": "/api/whatsapp/interactions/{id}",
38435 "title": "Gets a single Interaction",
38438 "title": "Example usage:",
38439 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
38443 "name": "ShowInteractions",
38444 "group": "Whatsapp_Interactions",
38445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38446 "version": "0.0.0",
38447 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38448 "groupTitle": "Whatsapp_Interactions"
38452 "url": "/UpdateWhatsappInteraction",
38453 "title": "Updates a new Interaction",
38454 "name": "UpdateWhatsappInteraction",
38455 "group": "Whatsapp_Interactions",
38463 "field": "options.attributes",
38470 "field": "options.where",
38476 "version": "0.0.0",
38477 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/whatsappInteraction.rpc.js",
38478 "groupTitle": "Whatsapp_Interactions"
38482 "url": "/api/whatsapp/interactions/{id}/messages",
38483 "title": "Creates new messages",
38486 "title": "Example usage:",
38487 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
38491 "name": "addMessage",
38492 "group": "Whatsapp_Interactions",
38518 "field": "direction",
38525 "field": "messageId",
38553 "field": "providerName",
38560 "field": "providerResponse",
38566 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38567 "version": "0.0.0",
38568 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38569 "groupTitle": "Whatsapp_Interactions"
38573 "url": "/api/whatsapp/interactions/{id}/download",
38574 "title": "Gets interaction",
38577 "title": "Example usage:",
38578 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
38582 "name": "download",
38583 "group": "Whatsapp_Interactions",
38584 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38585 "version": "0.0.0",
38586 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38587 "groupTitle": "Whatsapp_Interactions"
38591 "url": "/api/whatsapp/interactions/{id}/messages",
38592 "title": "Gets interaction messages",
38595 "title": "Example usage:",
38596 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
38600 "name": "getMessages",
38601 "group": "Whatsapp_Interactions",
38602 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38603 "version": "0.0.0",
38604 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38605 "groupTitle": "Whatsapp_Interactions"
38609 "url": "/api/whatsapp/interactions/{id}",
38610 "title": "Update an existing Interaction",
38613 "title": "Example usage:",
38614 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38618 "name": "updateInteractions",
38619 "group": "Whatsapp_Interactions",
38620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38621 "version": "0.0.0",
38622 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappInteraction/index.js",
38623 "groupTitle": "Whatsapp_Interactions"
38627 "url": "/api/whatsapp/messages",
38628 "title": "Creates a new Message",
38631 "title": "Example usage:",
38632 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38636 "name": "CreateMessages",
38637 "group": "Whatsapp_Messages",
38663 "field": "direction",
38670 "field": "messageId",
38698 "field": "providerName",
38705 "field": "providerResponse",
38711 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38712 "version": "0.0.0",
38713 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38714 "groupTitle": "Whatsapp_Messages"
38718 "url": "/CreateWhatsappMessage",
38719 "title": "Creates a new Message",
38720 "name": "CreateWhatsappMessage",
38721 "group": "Whatsapp_Messages",
38722 "version": "0.0.0",
38723 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/whatsappMessage.rpc.js",
38724 "groupTitle": "Whatsapp_Messages"
38728 "url": "/api/whatsapp/messages/{id}",
38729 "title": "Deletes a Message",
38732 "title": "Example usage:",
38733 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
38737 "name": "DeleteMessages",
38738 "group": "Whatsapp_Messages",
38739 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38740 "version": "0.0.0",
38741 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38742 "groupTitle": "Whatsapp_Messages"
38746 "url": "/api/whatsapp/messages/describe",
38747 "title": "Gets table info about Messages",
38750 "title": "Example usage:",
38751 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
38755 "name": "DescribeMessages",
38756 "group": "Whatsapp_Messages",
38757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38758 "version": "0.0.0",
38759 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38760 "groupTitle": "Whatsapp_Messages"
38764 "url": "/api/whatsapp/messages",
38765 "title": "Gets a list of Messages",
38768 "title": "Example usage:",
38769 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
38773 "name": "GetMessages",
38774 "group": "Whatsapp_Messages",
38775 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38776 "version": "0.0.0",
38777 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38778 "groupTitle": "Whatsapp_Messages"
38782 "url": "/api/whatsapp/messages/{id}",
38783 "title": "Gets a single Message",
38786 "title": "Example usage:",
38787 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
38791 "name": "ShowMessages",
38792 "group": "Whatsapp_Messages",
38793 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38794 "version": "0.0.0",
38795 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38796 "groupTitle": "Whatsapp_Messages"
38800 "url": "/api/whatsapp/messages/{id}",
38801 "title": "Update an existing Message",
38804 "title": "Example usage:",
38805 "content": "curl https://{domain}/api/whatsapp/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38809 "name": "updateMessages",
38810 "group": "Whatsapp_Messages",
38811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38812 "version": "0.0.0",
38813 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappMessage/index.js",
38814 "groupTitle": "Whatsapp_Messages"
38818 "url": "/CreateWhatsappQueueReport",
38819 "title": "Creates a new Whatsapp Queue Report",
38820 "name": "CreateWhatsappQueueReport",
38821 "group": "Whatsapp_Queue_Reports",
38822 "version": "0.0.0",
38823 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/whatsappQueueReport.rpc.js",
38824 "groupTitle": "Whatsapp_Queue_Reports"
38828 "url": "/api/whatsapp/reports/queue",
38829 "title": "Creates a new Whatsapp Queue Report",
38832 "title": "Example usage:",
38833 "content": "curl https://{domain}/api/whatsapp/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38837 "name": "CreateWhatsapp_Queue_Reports",
38838 "group": "Whatsapp_Queue_Reports",
38846 "field": "uniqueid",
38867 "field": "leaveAt",
38874 "field": "acceptAt",
38894 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38895 "version": "0.0.0",
38896 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/index.js",
38897 "groupTitle": "Whatsapp_Queue_Reports"
38901 "url": "/api/whatsapp/reports/queue/{id}",
38902 "title": "Deletes a Whatsapp Queue Report",
38905 "title": "Example usage:",
38906 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
38910 "name": "DeleteWhatsapp_Queue_Reports",
38911 "group": "Whatsapp_Queue_Reports",
38912 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38913 "version": "0.0.0",
38914 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/index.js",
38915 "groupTitle": "Whatsapp_Queue_Reports"
38919 "url": "/api/whatsapp/reports/queue/describe",
38920 "title": "Gets table info about Whatsapp Queue Reports",
38923 "title": "Example usage:",
38924 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
38928 "name": "DescribeWhatsapp_Queue_Reports",
38929 "group": "Whatsapp_Queue_Reports",
38930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38931 "version": "0.0.0",
38932 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/index.js",
38933 "groupTitle": "Whatsapp_Queue_Reports"
38937 "url": "/api/whatsapp/reports/queue",
38938 "title": "Gets a list of Whatsapp Queue Reports",
38941 "title": "Example usage:",
38942 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
38946 "name": "GetWhatsapp_Queue_Reports",
38947 "group": "Whatsapp_Queue_Reports",
38948 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38949 "version": "0.0.0",
38950 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/index.js",
38951 "groupTitle": "Whatsapp_Queue_Reports"
38955 "url": "/api/whatsapp/reports/queue/{id}",
38956 "title": "Gets a single Whatsapp Queue Report",
38959 "title": "Example usage:",
38960 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
38964 "name": "ShowWhatsapp_Queue_Reports",
38965 "group": "Whatsapp_Queue_Reports",
38966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38967 "version": "0.0.0",
38968 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/index.js",
38969 "groupTitle": "Whatsapp_Queue_Reports"
38973 "url": "/UpdateWhatsappQueueReport",
38974 "title": "Updates a new Whatsapp Queue Report",
38975 "name": "UpdateWhatsappQueueReport",
38976 "group": "Whatsapp_Queue_Reports",
38984 "field": "options.attributes",
38991 "field": "options.where",
38997 "version": "0.0.0",
38998 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/whatsappQueueReport.rpc.js",
38999 "groupTitle": "Whatsapp_Queue_Reports"
39003 "url": "/api/whatsapp/reports/queue/{id}",
39004 "title": "Update an existing Whatsapp Queue Report",
39007 "title": "Example usage:",
39008 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
39012 "name": "updateWhatsapp_Queue_Reports",
39013 "group": "Whatsapp_Queue_Reports",
39014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39015 "version": "0.0.0",
39016 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueueReport/index.js",
39017 "groupTitle": "Whatsapp_Queue_Reports"
39021 "url": "/api/whatsapp/queues/{id}/users",
39022 "title": "Add agents to a queue",
39025 "title": "Example usage:",
39026 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
39030 "name": "AddAgents",
39031 "group": "Whatsapp_Queues",
39032 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39033 "version": "0.0.0",
39034 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39035 "groupTitle": "Whatsapp_Queues"
39039 "url": "/api/whatsapp/queues/{id}/teams",
39040 "title": "Add teams to a queue",
39043 "title": "Example usage:",
39044 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
39048 "name": "AddTeams",
39049 "group": "Whatsapp_Queues",
39050 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39051 "version": "0.0.0",
39052 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39053 "groupTitle": "Whatsapp_Queues"
39057 "url": "/api/whatsapp/queues",
39058 "title": "Creates a new Queue",
39061 "title": "Example usage:",
39062 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
39066 "name": "CreateQueues",
39067 "group": "Whatsapp_Queues",
39082 "field": "timeout",
39094 "field": "strategy",
39101 "field": "description",
39107 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39108 "version": "0.0.0",
39109 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39110 "groupTitle": "Whatsapp_Queues"
39114 "url": "/api/whatsapp/queues/{id}",
39115 "title": "Deletes a Queue",
39118 "title": "Example usage:",
39119 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
39123 "name": "DeleteQueues",
39124 "group": "Whatsapp_Queues",
39125 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39126 "version": "0.0.0",
39127 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39128 "groupTitle": "Whatsapp_Queues"
39132 "url": "/api/whatsapp/queues/describe",
39133 "title": "Gets table info about Queues",
39136 "title": "Example usage:",
39137 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
39141 "name": "DescribeQueues",
39142 "group": "Whatsapp_Queues",
39143 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39144 "version": "0.0.0",
39145 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39146 "groupTitle": "Whatsapp_Queues"
39150 "url": "/api/whatsapp/queues/{id}/users",
39151 "title": "Gets queue agents",
39154 "title": "Example usage:",
39155 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
39159 "name": "GetAgents",
39160 "group": "Whatsapp_Queues",
39161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39162 "version": "0.0.0",
39163 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39164 "groupTitle": "Whatsapp_Queues"
39168 "url": "/api/whatsapp/queues/{id}/members",
39169 "title": "GetMembers",
39172 "title": "Example usage:",
39173 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
39177 "name": "GetMembers",
39178 "group": "Whatsapp_Queues",
39179 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39180 "version": "0.0.0",
39181 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39182 "groupTitle": "Whatsapp_Queues"
39186 "url": "/api/whatsapp/queues",
39187 "title": "Gets a list of Queues",
39190 "title": "Example usage:",
39191 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
39195 "name": "GetQueues",
39196 "group": "Whatsapp_Queues",
39197 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
39198 "version": "0.0.0",
39199 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39200 "groupTitle": "Whatsapp_Queues"
39204 "url": "/api/whatsapp/queues/{id}/teams",
39205 "title": "Gets queues list",
39208 "title": "Example usage:",
39209 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
39213 "name": "GetTeams",
39214 "group": "Whatsapp_Queues",
39215 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39216 "version": "0.0.0",
39217 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39218 "groupTitle": "Whatsapp_Queues"
39222 "url": "/GetWhatsappQueue",
39223 "title": "Gets a list of Queues",
39224 "name": "GetWhatsappQueue",
39225 "group": "Whatsapp_Queues",
39233 "field": "options.attributes",
39240 "field": "options.where",
39246 "version": "0.0.0",
39247 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/whatsappQueue.rpc.js",
39248 "groupTitle": "Whatsapp_Queues"
39252 "url": "/api/whatsapp/queues/{id}/users",
39253 "title": "Removes agents from a queue",
39256 "title": "Example usage:",
39257 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
39261 "name": "RemoveAgents",
39262 "group": "Whatsapp_Queues",
39263 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39264 "version": "0.0.0",
39265 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39266 "groupTitle": "Whatsapp_Queues"
39270 "url": "/api/whatsapp/queues/{id}",
39271 "title": "Gets a single Queue",
39274 "title": "Example usage:",
39275 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
39279 "name": "ShowQueues",
39280 "group": "Whatsapp_Queues",
39281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39282 "version": "0.0.0",
39283 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39284 "groupTitle": "Whatsapp_Queues"
39288 "url": "/ShowWhatsappQueue",
39289 "title": "Gets a single Queue",
39290 "name": "ShowWhatsappQueue",
39291 "group": "Whatsapp_Queues",
39299 "field": "options.attributes",
39306 "field": "options.where",
39312 "version": "0.0.0",
39313 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/whatsappQueue.rpc.js",
39314 "groupTitle": "Whatsapp_Queues"
39318 "url": "/api/whatsapp/queues/{id}",
39319 "title": "Update an existing Queue",
39322 "title": "Example usage:",
39323 "content": "curl https://{domain}/api/whatsapp/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
39327 "name": "updateQueues",
39328 "group": "Whatsapp_Queues",
39329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39330 "version": "0.0.0",
39331 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappQueue/index.js",
39332 "groupTitle": "Whatsapp_Queues"
39336 "url": "/api/whatsapp/reports/transfer",
39337 "title": "Creates a new Whatsapp Transfer Report",
39340 "title": "Example usage:",
39341 "content": "curl https://{domain}/api/whatsapp/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
39345 "name": "CreateWhatsapp_Transfer_Reports",
39346 "group": "Whatsapp_Transfer_Reports",
39354 "field": "uniqueid",
39373 "field": "transferredAt",
39379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39380 "version": "0.0.0",
39381 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappTransferReport/index.js",
39382 "groupTitle": "Whatsapp_Transfer_Reports"
39386 "url": "/api/whatsapp/reports/transfer/{id}",
39387 "title": "Deletes a Whatsapp Transfer Report",
39390 "title": "Example usage:",
39391 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
39395 "name": "DeleteWhatsapp_Transfer_Reports",
39396 "group": "Whatsapp_Transfer_Reports",
39397 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39398 "version": "0.0.0",
39399 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappTransferReport/index.js",
39400 "groupTitle": "Whatsapp_Transfer_Reports"
39404 "url": "/api/whatsapp/reports/transfer/describe",
39405 "title": "Gets table info about Whatsapp Transfer Reports",
39408 "title": "Example usage:",
39409 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
39413 "name": "DescribeWhatsapp_Transfer_Reports",
39414 "group": "Whatsapp_Transfer_Reports",
39415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39416 "version": "0.0.0",
39417 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappTransferReport/index.js",
39418 "groupTitle": "Whatsapp_Transfer_Reports"
39422 "url": "/api/whatsapp/reports/transfer",
39423 "title": "Gets a list of Whatsapp Transfer Reports",
39426 "title": "Example usage:",
39427 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
39431 "name": "GetWhatsapp_Transfer_Reports",
39432 "group": "Whatsapp_Transfer_Reports",
39433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
39434 "version": "0.0.0",
39435 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappTransferReport/index.js",
39436 "groupTitle": "Whatsapp_Transfer_Reports"
39440 "url": "/api/whatsapp/reports/transfer/{id}",
39441 "title": "Gets a single Whatsapp Transfer Report",
39444 "title": "Example usage:",
39445 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
39449 "name": "ShowWhatsapp_Transfer_Reports",
39450 "group": "Whatsapp_Transfer_Reports",
39451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39452 "version": "0.0.0",
39453 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappTransferReport/index.js",
39454 "groupTitle": "Whatsapp_Transfer_Reports"
39458 "url": "/api/whatsapp/reports/transfer/{id}",
39459 "title": "Update an existing Whatsapp Transfer Report",
39462 "title": "Example usage:",
39463 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
39467 "name": "updateWhatsapp_Transfer_Reports",
39468 "group": "Whatsapp_Transfer_Reports",
39469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39470 "version": "0.0.0",
39471 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/whatsappTransferReport/index.js",
39472 "groupTitle": "Whatsapp_Transfer_Reports"
39476 "url": "/api/integrations/zendesk/accounts",
39477 "title": "Creates a new Zendesk Account",
39480 "title": "Example usage:",
39481 "content": "curl https://{domain}/api/integrations/zendesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
39485 "name": "CreateZendesk_Accounts",
39486 "group": "Zendesk_Accounts",
39501 "field": "description",
39508 "field": "username",
39515 "field": "password",
39529 "field": "remoteUri",
39540 "field": "authType",
39547 "field": "serverUrl",
39554 "\"integrationTab\"",
39564 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39565 "version": "0.0.0",
39566 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39567 "groupTitle": "Zendesk_Accounts"
39571 "url": "/api/integrations/zendesk/accounts/{id}",
39572 "title": "Deletes a Zendesk Account",
39575 "title": "Example usage:",
39576 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
39580 "name": "DeleteZendesk_Accounts",
39581 "group": "Zendesk_Accounts",
39582 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39583 "version": "0.0.0",
39584 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39585 "groupTitle": "Zendesk_Accounts"
39589 "url": "/GetZendeskAccount",
39590 "title": "Gets a list of Zendesk Accounts",
39591 "name": "GetZendeskAccount",
39592 "group": "Zendesk_Accounts",
39600 "field": "options.attributes",
39607 "field": "options.where",
39613 "version": "0.0.0",
39614 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/intZendeskAccount.rpc.js",
39615 "groupTitle": "Zendesk_Accounts"
39619 "url": "/api/integrations/zendesk/accounts",
39620 "title": "Gets a list of Zendesk Accounts",
39623 "title": "Example usage:",
39624 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
39628 "name": "GetZendesk_Accounts",
39629 "group": "Zendesk_Accounts",
39630 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
39631 "version": "0.0.0",
39632 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39633 "groupTitle": "Zendesk_Accounts"
39637 "url": "/ShowZendeskAccount",
39638 "title": "Gets a single Zendesk Account",
39639 "name": "ShowZendeskAccount",
39640 "group": "Zendesk_Accounts",
39648 "field": "options.attributes",
39655 "field": "options.where",
39661 "version": "0.0.0",
39662 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/intZendeskAccount.rpc.js",
39663 "groupTitle": "Zendesk_Accounts"
39667 "url": "/api/integrations/zendesk/accounts/{id}",
39668 "title": "Gets a single Zendesk Account",
39671 "title": "Example usage:",
39672 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
39676 "name": "ShowZendesk_Accounts",
39677 "group": "Zendesk_Accounts",
39678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39679 "version": "0.0.0",
39680 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39681 "groupTitle": "Zendesk_Accounts"
39685 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
39686 "title": "Creates new configuration",
39689 "title": "Example usage:",
39690 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
39694 "name": "addConfiguration",
39695 "group": "Zendesk_Accounts",
39696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39697 "version": "0.0.0",
39698 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39699 "groupTitle": "Zendesk_Accounts"
39703 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
39704 "title": "Gets account configurations",
39707 "title": "Example usage:",
39708 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
39712 "name": "getConfigurations",
39713 "group": "Zendesk_Accounts",
39714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39715 "version": "0.0.0",
39716 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39717 "groupTitle": "Zendesk_Accounts"
39721 "url": "/api/integrations/zendesk/accounts/{id}/fields",
39722 "title": "Gets account fields",
39725 "title": "Example usage:",
39726 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
39730 "name": "getFields",
39731 "group": "Zendesk_Accounts",
39732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39733 "version": "0.0.0",
39734 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39735 "groupTitle": "Zendesk_Accounts"
39739 "url": "/api/integrations/zendesk/accounts/{id}",
39740 "title": "Update an existing Zendesk Account",
39743 "title": "Example usage:",
39744 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
39748 "name": "updateZendesk_Accounts",
39749 "group": "Zendesk_Accounts",
39750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39751 "version": "0.0.0",
39752 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskAccount/index.js",
39753 "groupTitle": "Zendesk_Accounts"
39757 "url": "/api/integrations/zendesk/configurations",
39758 "title": "Creates a new Zendesk Configuration",
39761 "title": "Example usage:",
39762 "content": "curl https://{domain}/api/integrations/zendesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
39766 "name": "CreateZendesk_Configurations",
39767 "group": "Zendesk_Configurations",
39782 "field": "description",
39788 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39789 "version": "0.0.0",
39790 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39791 "groupTitle": "Zendesk_Configurations"
39795 "url": "/api/integrations/zendesk/configurations/{id}",
39796 "title": "Deletes a Zendesk Configuration",
39799 "title": "Example usage:",
39800 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
39804 "name": "DeleteZendesk_Configurations",
39805 "group": "Zendesk_Configurations",
39806 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39807 "version": "0.0.0",
39808 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39809 "groupTitle": "Zendesk_Configurations"
39813 "url": "/api/integrations/zendesk/configurations",
39814 "title": "Gets a list of Zendesk Configurations",
39817 "title": "Example usage:",
39818 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
39822 "name": "GetZendesk_Configurations",
39823 "group": "Zendesk_Configurations",
39824 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
39825 "version": "0.0.0",
39826 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39827 "groupTitle": "Zendesk_Configurations"
39831 "url": "/api/integrations/zendesk/configurations/{id}",
39832 "title": "Gets a single Zendesk Configuration",
39835 "title": "Example usage:",
39836 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
39840 "name": "ShowZendesk_Configurations",
39841 "group": "Zendesk_Configurations",
39842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39843 "version": "0.0.0",
39844 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39845 "groupTitle": "Zendesk_Configurations"
39849 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
39850 "title": "Gets configurations descriptions",
39853 "title": "Example usage:",
39854 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
39858 "name": "getDescriptions",
39859 "group": "Zendesk_Configurations",
39860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39861 "version": "0.0.0",
39862 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39863 "groupTitle": "Zendesk_Configurations"
39867 "url": "/api/integrations/zendesk/configurations/{id}/fields",
39868 "title": "Gets configurations fields",
39871 "title": "Example usage:",
39872 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
39876 "name": "getFields",
39877 "group": "Zendesk_Configurations",
39878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39879 "version": "0.0.0",
39880 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39881 "groupTitle": "Zendesk_Configurations"
39885 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
39886 "title": "Gets configurations subjects",
39889 "title": "Example usage:",
39890 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
39894 "name": "getSubjects",
39895 "group": "Zendesk_Configurations",
39896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39897 "version": "0.0.0",
39898 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39899 "groupTitle": "Zendesk_Configurations"
39903 "url": "/api/integrations/zendesk/configurations/{id}/tags",
39904 "title": "Gets configurations tags",
39907 "title": "Example usage:",
39908 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
39913 "group": "Zendesk_Configurations",
39914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39915 "version": "0.0.0",
39916 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39917 "groupTitle": "Zendesk_Configurations"
39921 "url": "/api/integrations/zendesk/configurations/{id}/tags",
39922 "title": "Sets new tags",
39925 "title": "Example usage:",
39926 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
39931 "group": "Zendesk_Configurations",
39932 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39933 "version": "0.0.0",
39934 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39935 "groupTitle": "Zendesk_Configurations"
39939 "url": "/api/integrations/zendesk/configurations/{id}",
39940 "title": "Update an existing Zendesk Configuration",
39943 "title": "Example usage:",
39944 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
39948 "name": "updateZendesk_Configurations",
39949 "group": "Zendesk_Configurations",
39950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
39951 "version": "0.0.0",
39952 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskConfiguration/index.js",
39953 "groupTitle": "Zendesk_Configurations"
39957 "url": "/api/integrations/zendesk/fields",
39958 "title": "Creates a new Zendesk Field",
39961 "title": "Example usage:",
39962 "content": "curl https://{domain}/api/integrations/zendesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
39966 "name": "CreateZendesk_Fields",
39967 "group": "Zendesk_Fields",
39977 "\"customVariable\"",
39988 "field": "content",
40004 "\"customVariable\""
40007 "field": "keyType",
40014 "field": "keyContent",
40021 "field": "idField",
40028 "field": "nameField",
40035 "field": "customField",
40042 "field": "variableName",
40048 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40049 "version": "0.0.0",
40050 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskField/index.js",
40051 "groupTitle": "Zendesk_Fields"
40055 "url": "/api/integrations/zendesk/fields/{id}",
40056 "title": "Deletes a Zendesk Field",
40059 "title": "Example usage:",
40060 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
40064 "name": "DeleteZendesk_Fields",
40065 "group": "Zendesk_Fields",
40066 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40067 "version": "0.0.0",
40068 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskField/index.js",
40069 "groupTitle": "Zendesk_Fields"
40073 "url": "/api/integrations/zendesk/fields",
40074 "title": "Gets a list of Zendesk Fields",
40077 "title": "Example usage:",
40078 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
40082 "name": "GetZendesk_Fields",
40083 "group": "Zendesk_Fields",
40084 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
40085 "version": "0.0.0",
40086 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskField/index.js",
40087 "groupTitle": "Zendesk_Fields"
40091 "url": "/api/integrations/zendesk/fields/{id}",
40092 "title": "Gets a single Zendesk Field",
40095 "title": "Example usage:",
40096 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
40100 "name": "ShowZendesk_Fields",
40101 "group": "Zendesk_Fields",
40102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40103 "version": "0.0.0",
40104 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskField/index.js",
40105 "groupTitle": "Zendesk_Fields"
40109 "url": "/api/integrations/zendesk/fields/{id}",
40110 "title": "Update an existing Zendesk Field",
40113 "title": "Example usage:",
40114 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
40118 "name": "updateZendesk_Fields",
40119 "group": "Zendesk_Fields",
40120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40121 "version": "0.0.0",
40122 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZendeskField/index.js",
40123 "groupTitle": "Zendesk_Fields"
40127 "url": "/api/integrations/zoho/accounts",
40128 "title": "Creates a new Zoho Account",
40131 "title": "Example usage:",
40132 "content": "curl https://{domain}/api/integrations/zoho/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
40136 "name": "CreateZoho_Accounts",
40137 "group": "Zoho_Accounts",
40152 "field": "description",
40173 "field": "clientId",
40180 "field": "clientSecret",
40187 "field": "serverUrl",
40201 "field": "refreshToken",
40207 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40208 "version": "0.0.0",
40209 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40210 "groupTitle": "Zoho_Accounts"
40214 "url": "/api/integrations/zoho/accounts/{id}",
40215 "title": "Deletes a Zoho Account",
40218 "title": "Example usage:",
40219 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
40223 "name": "DeleteZoho_Accounts",
40224 "group": "Zoho_Accounts",
40225 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40226 "version": "0.0.0",
40227 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40228 "groupTitle": "Zoho_Accounts"
40232 "url": "/GetZohoAccount",
40233 "title": "Gets a list of Zoho Accounts",
40234 "name": "GetZohoAccount",
40235 "group": "Zoho_Accounts",
40243 "field": "options.attributes",
40250 "field": "options.where",
40256 "version": "0.0.0",
40257 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/intZohoAccount.rpc.js",
40258 "groupTitle": "Zoho_Accounts"
40262 "url": "/api/integrations/zoho/accounts",
40263 "title": "Gets a list of Zoho Accounts",
40266 "title": "Example usage:",
40267 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
40271 "name": "GetZoho_Accounts",
40272 "group": "Zoho_Accounts",
40273 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
40274 "version": "0.0.0",
40275 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40276 "groupTitle": "Zoho_Accounts"
40280 "url": "/ShowZohoAccount",
40281 "title": "Gets a single Zoho Account",
40282 "name": "ShowZohoAccount",
40283 "group": "Zoho_Accounts",
40291 "field": "options.attributes",
40298 "field": "options.where",
40304 "version": "0.0.0",
40305 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/intZohoAccount.rpc.js",
40306 "groupTitle": "Zoho_Accounts"
40310 "url": "/api/integrations/zoho/accounts/{id}",
40311 "title": "Gets a single Zoho Account",
40314 "title": "Example usage:",
40315 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
40319 "name": "ShowZoho_Accounts",
40320 "group": "Zoho_Accounts",
40321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40322 "version": "0.0.0",
40323 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40324 "groupTitle": "Zoho_Accounts"
40328 "url": "/api/integrations/zoho/accounts/{id}/configurations",
40329 "title": "Creates new configuration",
40332 "title": "Example usage:",
40333 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
40337 "name": "addConfiguration",
40338 "group": "Zoho_Accounts",
40339 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40340 "version": "0.0.0",
40341 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40342 "groupTitle": "Zoho_Accounts"
40346 "url": "/api/integrations/zoho/accounts/{id}/configurations",
40347 "title": "Gets account configurations",
40350 "title": "Example usage:",
40351 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
40355 "name": "getConfigurations",
40356 "group": "Zoho_Accounts",
40357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40358 "version": "0.0.0",
40359 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40360 "groupTitle": "Zoho_Accounts"
40364 "url": "/api/integrations/zoho/accounts/{id}/fields",
40365 "title": "Gets account fields",
40368 "title": "Example usage:",
40369 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
40373 "name": "getFields",
40374 "group": "Zoho_Accounts",
40375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40376 "version": "0.0.0",
40377 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40378 "groupTitle": "Zoho_Accounts"
40382 "url": "/api/integrations/zoho/accounts/{id}",
40383 "title": "Update an existing Zoho Account",
40386 "title": "Example usage:",
40387 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
40391 "name": "updateZoho_Accounts",
40392 "group": "Zoho_Accounts",
40393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40394 "version": "0.0.0",
40395 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoAccount/index.js",
40396 "groupTitle": "Zoho_Accounts"
40400 "url": "/api/integrations/zoho/configurations",
40401 "title": "Creates a new Zoho Configuration",
40404 "title": "Example usage:",
40405 "content": "curl https://{domain}/api/integrations/zoho/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
40409 "name": "CreateZoho_Configurations",
40410 "group": "Zoho_Configurations",
40430 "field": "moduleCreate",
40437 "\"contact_lead\"",
40442 "field": "moduleSearch",
40449 "field": "description",
40455 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40456 "version": "0.0.0",
40457 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40458 "groupTitle": "Zoho_Configurations"
40462 "url": "/api/integrations/zoho/configurations/{id}",
40463 "title": "Deletes a Zoho Configuration",
40466 "title": "Example usage:",
40467 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
40471 "name": "DeleteZoho_Configurations",
40472 "group": "Zoho_Configurations",
40473 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40474 "version": "0.0.0",
40475 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40476 "groupTitle": "Zoho_Configurations"
40480 "url": "/api/integrations/zoho/configurations",
40481 "title": "Gets a list of Zoho Configurations",
40484 "title": "Example usage:",
40485 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
40489 "name": "GetZoho_Configurations",
40490 "group": "Zoho_Configurations",
40491 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
40492 "version": "0.0.0",
40493 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40494 "groupTitle": "Zoho_Configurations"
40498 "url": "/api/integrations/zoho/configurations/{id}",
40499 "title": "Gets a single Zoho Configuration",
40502 "title": "Example usage:",
40503 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
40507 "name": "ShowZoho_Configurations",
40508 "group": "Zoho_Configurations",
40509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40510 "version": "0.0.0",
40511 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40512 "groupTitle": "Zoho_Configurations"
40516 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
40517 "title": "Gets configurations descriptions",
40520 "title": "Example usage:",
40521 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
40525 "name": "getDescriptions",
40526 "group": "Zoho_Configurations",
40527 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40528 "version": "0.0.0",
40529 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40530 "groupTitle": "Zoho_Configurations"
40534 "url": "/api/integrations/zoho/configurations/{id}/fields",
40535 "title": "Gets configurations fields",
40538 "title": "Example usage:",
40539 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
40543 "name": "getFields",
40544 "group": "Zoho_Configurations",
40545 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40546 "version": "0.0.0",
40547 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40548 "groupTitle": "Zoho_Configurations"
40552 "url": "/api/integrations/zoho/configurations/{id}/subjects",
40553 "title": "Gets configurations subjects",
40556 "title": "Example usage:",
40557 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
40561 "name": "getSubjects",
40562 "group": "Zoho_Configurations",
40563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40564 "version": "0.0.0",
40565 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40566 "groupTitle": "Zoho_Configurations"
40570 "url": "/api/integrations/zoho/configurations/{id}",
40571 "title": "Update an existing Zoho Configuration",
40574 "title": "Example usage:",
40575 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
40579 "name": "updateZoho_Configurations",
40580 "group": "Zoho_Configurations",
40581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40582 "version": "0.0.0",
40583 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoConfiguration/index.js",
40584 "groupTitle": "Zoho_Configurations"
40588 "url": "/api/integrations/zoho/fields",
40589 "title": "Creates a new Zoho Field",
40592 "title": "Example usage:",
40593 "content": "curl https://{domain}/api/integrations/zoho/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
40597 "name": "CreateZoho_Fields",
40598 "group": "Zoho_Fields",
40608 "\"customVariable\"",
40619 "field": "content",
40635 "\"customVariable\""
40638 "field": "keyType",
40645 "field": "keyContent",
40652 "field": "idField",
40659 "field": "nameField",
40666 "field": "customField",
40673 "field": "variableName",
40679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40680 "version": "0.0.0",
40681 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoField/index.js",
40682 "groupTitle": "Zoho_Fields"
40686 "url": "/api/integrations/zoho/fields/{id}",
40687 "title": "Deletes a Zoho Field",
40690 "title": "Example usage:",
40691 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
40695 "name": "DeleteZoho_Fields",
40696 "group": "Zoho_Fields",
40697 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40698 "version": "0.0.0",
40699 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoField/index.js",
40700 "groupTitle": "Zoho_Fields"
40704 "url": "/api/integrations/zoho/fields",
40705 "title": "Gets a list of Zoho Fields",
40708 "title": "Example usage:",
40709 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
40713 "name": "GetZoho_Fields",
40714 "group": "Zoho_Fields",
40715 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
40716 "version": "0.0.0",
40717 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoField/index.js",
40718 "groupTitle": "Zoho_Fields"
40722 "url": "/api/integrations/zoho/fields/{id}",
40723 "title": "Gets a single Zoho Field",
40726 "title": "Example usage:",
40727 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
40731 "name": "ShowZoho_Fields",
40732 "group": "Zoho_Fields",
40733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40734 "version": "0.0.0",
40735 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoField/index.js",
40736 "groupTitle": "Zoho_Fields"
40740 "url": "/api/integrations/zoho/fields/{id}",
40741 "title": "Update an existing Zoho Field",
40744 "title": "Example usage:",
40745 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
40749 "name": "updateZoho_Fields",
40750 "group": "Zoho_Fields",
40751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40752 "version": "0.0.0",
40753 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/intZohoField/index.js",
40754 "groupTitle": "Zoho_Fields"
40759 "title": "Creates a new Cdr",
40762 "title": "Example usage:",
40763 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
40767 "name": "CreateCdrs",
40776 "field": "calldate",
40804 "field": "dcontext",
40811 "field": "channel",
40818 "field": "dstchannel",
40825 "field": "lastapp",
40832 "field": "lastdata",
40839 "field": "duration",
40846 "field": "billsec",
40853 "field": "disposition",
40860 "field": "amaflags",
40867 "field": "accountcode",
40874 "field": "userfield",
40881 "field": "uniqueid",
40888 "field": "linkedid",
40895 "field": "sequence",
40902 "field": "peeraccount",
40922 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40923 "version": "0.0.0",
40924 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cdr/index.js",
40925 "groupTitle": "cdr"
40929 "url": "/api/cdr/{id}",
40930 "title": "Deletes a Cdr",
40933 "title": "Example usage:",
40934 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
40938 "name": "DeleteCdrs",
40940 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40941 "version": "0.0.0",
40942 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cdr/index.js",
40943 "groupTitle": "cdr"
40947 "url": "/api/cdr/describe",
40948 "title": "Gets table info about Cdrs",
40951 "title": "Example usage:",
40952 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
40956 "name": "DescribeCdrs",
40958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40959 "version": "0.0.0",
40960 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cdr/index.js",
40961 "groupTitle": "cdr"
40966 "title": "Gets a list of Cdrs",
40969 "title": "Example usage:",
40970 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
40976 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cdr?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cdr?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cdr?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cdr?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cdr?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
40977 "version": "0.0.0",
40978 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cdr/index.js",
40979 "groupTitle": "cdr"
40983 "url": "/api/cdr/{id}",
40984 "title": "Gets a single Cdr",
40987 "title": "Example usage:",
40988 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
40992 "name": "ShowCdrs",
40994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
40995 "version": "0.0.0",
40996 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cdr/index.js",
40997 "groupTitle": "cdr"
41001 "url": "/api/cdr/{id}",
41002 "title": "Update an existing Cdr",
41005 "title": "Example usage:",
41006 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
41010 "name": "updateCdrs",
41012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
41013 "version": "0.0.0",
41014 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/cdr/index.js",
41015 "groupTitle": "cdr"
41019 "url": "/api/voiceQueuesLog",
41020 "title": "Creates a new VoiceQueuesLog",
41023 "title": "Example usage:",
41024 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
41028 "name": "CreateVoiceQueuesLogs",
41029 "group": "voiceQueuesLog",
41051 "field": "queuename",
41120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
41121 "version": "0.0.0",
41122 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueuesLog/index.js",
41123 "groupTitle": "voiceQueuesLog"
41127 "url": "/api/voiceQueuesLog/{id}",
41128 "title": "Deletes a VoiceQueuesLog",
41131 "title": "Example usage:",
41132 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
41136 "name": "DeleteVoiceQueuesLogs",
41137 "group": "voiceQueuesLog",
41138 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
41139 "version": "0.0.0",
41140 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueuesLog/index.js",
41141 "groupTitle": "voiceQueuesLog"
41145 "url": "/api/voiceQueuesLog",
41146 "title": "Gets a list of VoiceQueuesLogs",
41149 "title": "Example usage:",
41150 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
41154 "name": "GetVoiceQueuesLogs",
41155 "group": "voiceQueuesLog",
41156 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voiceQueuesLog?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voiceQueuesLog?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voiceQueuesLog?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voiceQueuesLog?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voiceQueuesLog?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
41157 "version": "0.0.0",
41158 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueuesLog/index.js",
41159 "groupTitle": "voiceQueuesLog"
41163 "url": "/api/voiceQueuesLog/{id}",
41164 "title": "Gets a single VoiceQueuesLog",
41167 "title": "Example usage:",
41168 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
41172 "name": "ShowVoiceQueuesLogs",
41173 "group": "voiceQueuesLog",
41174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
41175 "version": "0.0.0",
41176 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueuesLog/index.js",
41177 "groupTitle": "voiceQueuesLog"
41181 "url": "/api/voiceQueuesLog/{id}",
41182 "title": "Update an existing VoiceQueuesLog",
41185 "title": "Example usage:",
41186 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
41190 "name": "updateVoiceQueuesLogs",
41191 "group": "voiceQueuesLog",
41192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
41193 "version": "0.0.0",
41194 "filename": "/home/vito/Development/MOTION_V3/motion-server/src/api/voiceQueuesLog/index.js",
41195 "groupTitle": "voiceQueuesLog"