4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "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>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "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",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "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>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "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>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "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",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "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",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "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>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "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>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "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",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "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",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "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>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "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>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "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",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "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",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "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>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "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",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "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>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "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>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "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",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "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>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "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>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "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",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "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",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "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>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "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>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "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",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "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>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "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>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/google",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authGoogle/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/local",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authLocal/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/automations",
1381 "title": "Creates a new Automation",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1389 "name": "CreateAutomations",
1390 "group": "Automations",
1412 "field": "description",
1432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1434 "filename": "server/api/automation/index.js",
1435 "groupTitle": "Automations"
1439 "url": "/api/automations/{id}",
1440 "title": "Deletes a Automation",
1443 "title": "Example usage:",
1444 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1448 "name": "DeleteAutomations",
1449 "group": "Automations",
1450 "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>",
1452 "filename": "server/api/automation/index.js",
1453 "groupTitle": "Automations"
1457 "url": "/api/automations",
1458 "title": "Gets a list of Automations",
1461 "title": "Example usage:",
1462 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1466 "name": "GetAutomations",
1467 "group": "Automations",
1468 "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>",
1470 "filename": "server/api/automation/index.js",
1471 "groupTitle": "Automations"
1475 "url": "/api/automations/{id}",
1476 "title": "Gets a single Automation",
1479 "title": "Example usage:",
1480 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1484 "name": "ShowAutomations",
1485 "group": "Automations",
1486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488 "filename": "server/api/automation/index.js",
1489 "groupTitle": "Automations"
1493 "url": "/api/automations/{id}/actions",
1494 "title": "Creates new actions",
1497 "title": "Example usage:",
1498 "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",
1502 "name": "addActions",
1503 "group": "Automations",
1519 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1526 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1533 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1540 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1575 "filename": "server/api/automation/index.js",
1576 "groupTitle": "Automations"
1580 "url": "/api/automations/{id}/conditions",
1581 "title": "Creates new conditions",
1584 "title": "Example usage:",
1585 "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",
1589 "name": "addConditions",
1590 "group": "Automations",
1612 "field": "operator",
1625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1627 "filename": "server/api/automation/index.js",
1628 "groupTitle": "Automations"
1632 "url": "/api/automations/{id}/actions",
1633 "title": "Gets Automation Actions",
1636 "title": "Example usage:",
1637 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1641 "name": "getActions",
1642 "group": "Automations",
1643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1645 "filename": "server/api/automation/index.js",
1646 "groupTitle": "Automations"
1650 "url": "/api/automations/{id}/conditions",
1651 "title": "Gets Automation Conditions",
1654 "title": "Example usage:",
1655 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1659 "name": "getConditions",
1660 "group": "Automations",
1661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1663 "filename": "server/api/automation/index.js",
1664 "groupTitle": "Automations"
1668 "url": "/api/automations/{id}",
1669 "title": "Update an existing Automation",
1672 "title": "Example usage:",
1673 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1677 "name": "updateAutomations",
1678 "group": "Automations",
1679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/canned_answers",
1687 "title": "Create a new canned answer",
1690 "title": "Example usage:",
1691 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1696 "group": "Canned_Answers",
1697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699 "filename": "server/api/cannedAnswer/index.js",
1700 "groupTitle": "Canned_Answers"
1704 "url": "/api/canned_answers/{id}",
1705 "title": "Deletes a Canned Answer",
1708 "title": "Example usage:",
1709 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1713 "name": "DeleteCanned_Answers",
1714 "group": "Canned_Answers",
1715 "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>",
1717 "filename": "server/api/cannedAnswer/index.js",
1718 "groupTitle": "Canned_Answers"
1722 "url": "/api/canned_answers",
1723 "title": "Gets a list of Canned Answers",
1726 "title": "Example usage:",
1727 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1731 "name": "GetCanned_Answers",
1732 "group": "Canned_Answers",
1733 "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>",
1735 "filename": "server/api/cannedAnswer/index.js",
1736 "groupTitle": "Canned_Answers"
1740 "url": "/api/canned_answers/{id}",
1741 "title": "Gets a single Canned Answer",
1744 "title": "Example usage:",
1745 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1749 "name": "ShowCanned_Answers",
1750 "group": "Canned_Answers",
1751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753 "filename": "server/api/cannedAnswer/index.js",
1754 "groupTitle": "Canned_Answers"
1758 "url": "/api/canned_answers/{id}",
1759 "title": "Update an existing Canned Answer",
1762 "title": "Example usage:",
1763 "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",
1767 "name": "updateCanned_Answers",
1768 "group": "Canned_Answers",
1769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771 "filename": "server/api/cannedAnswer/index.js",
1772 "groupTitle": "Canned_Answers"
1776 "url": "/chat/internal/users",
1777 "title": "Gets Users Last Messages",
1780 "title": "Example usage:",
1781 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1785 "name": "getLastUsersMessages",
1786 "group": "ChatInternalMessage",
1787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1789 "filename": "server/api/chatInternalMessage/index.js",
1790 "groupTitle": "ChatInternalMessage"
1794 "url": "/api/chat/applications/{id}",
1795 "title": "Deletes a Application",
1798 "title": "Example usage:",
1799 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1803 "name": "DeleteApplications",
1804 "group": "Chat_Applications",
1805 "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>",
1807 "filename": "server/api/chatApplication/index.js",
1808 "groupTitle": "Chat_Applications"
1812 "url": "/api/chat/applications/{id}",
1813 "title": "Gets a single Application",
1816 "title": "Example usage:",
1817 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1821 "name": "ShowApplications",
1822 "group": "Chat_Applications",
1823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825 "filename": "server/api/chatApplication/index.js",
1826 "groupTitle": "Chat_Applications"
1830 "url": "/api/chat/applications/{id}",
1831 "title": "Update an existing Application",
1834 "title": "Example usage:",
1835 "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",
1839 "name": "updateApplications",
1840 "group": "Chat_Applications",
1841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843 "filename": "server/api/chatApplication/index.js",
1844 "groupTitle": "Chat_Applications"
1848 "url": "/api/chat/groups",
1849 "title": "Creates a new Group",
1852 "title": "Example usage:",
1853 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1857 "name": "CreateGroups",
1858 "group": "Chat_Groups",
1873 "field": "description",
1886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1888 "filename": "server/api/chatGroup/index.js",
1889 "groupTitle": "Chat_Groups"
1893 "url": "/api/chat/groups/{id}",
1894 "title": "Deletes a Group",
1897 "title": "Example usage:",
1898 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1902 "name": "DeleteGroups",
1903 "group": "Chat_Groups",
1904 "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>",
1906 "filename": "server/api/chatGroup/index.js",
1907 "groupTitle": "Chat_Groups"
1911 "url": "/api/chat/groups/describe",
1912 "title": "Gets table info about Groups",
1915 "title": "Example usage:",
1916 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1920 "name": "DescribeGroups",
1921 "group": "Chat_Groups",
1922 "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>",
1924 "filename": "server/api/chatGroup/index.js",
1925 "groupTitle": "Chat_Groups"
1929 "url": "/api/chat/groups",
1930 "title": "Gets a list of Groups",
1933 "title": "Example usage:",
1934 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1938 "name": "GetGroups",
1939 "group": "Chat_Groups",
1940 "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>",
1942 "filename": "server/api/chatGroup/index.js",
1943 "groupTitle": "Chat_Groups"
1947 "url": "/api/chat/groups/{id}/members",
1948 "title": "Removes members from a group",
1951 "title": "Example usage:",
1952 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1956 "name": "RemoveMembers",
1957 "group": "Chat_Groups",
1958 "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>",
1960 "filename": "server/api/chatGroup/index.js",
1961 "groupTitle": "Chat_Groups"
1965 "url": "/api/chat/groups/{id}",
1966 "title": "Gets a single Group",
1969 "title": "Example usage:",
1970 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1974 "name": "ShowGroups",
1975 "group": "Chat_Groups",
1976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978 "filename": "server/api/chatGroup/index.js",
1979 "groupTitle": "Chat_Groups"
1983 "url": "/api/chat/groups/{id}/members",
1984 "title": "Add members to chat group",
1987 "title": "Example usage:",
1988 "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",
1992 "name": "addMembers",
1993 "group": "Chat_Groups",
1994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1996 "filename": "server/api/chatGroup/index.js",
1997 "groupTitle": "Chat_Groups"
2001 "url": "/api/chat/groups/{id}/messages",
2002 "title": "Creates a new group message",
2005 "title": "Example usage:",
2006 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2010 "name": "addMessage",
2011 "group": "Chat_Groups",
2012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014 "filename": "server/api/chatGroup/index.js",
2015 "groupTitle": "Chat_Groups"
2019 "url": "/api/chat/groups/{id}/members",
2020 "title": "Gets Members",
2023 "title": "Example usage:",
2024 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2028 "name": "getMembers",
2029 "group": "Chat_Groups",
2030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032 "filename": "server/api/chatGroup/index.js",
2033 "groupTitle": "Chat_Groups"
2037 "url": "/api/chat/groups/{id}/messages",
2038 "title": "Gets Messages",
2041 "title": "Example usage:",
2042 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2046 "name": "getMessages",
2047 "group": "Chat_Groups",
2048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050 "filename": "server/api/chatGroup/index.js",
2051 "groupTitle": "Chat_Groups"
2055 "url": "/api/chat/groups/{id}/unread",
2056 "title": "Get unread chat group messages",
2059 "title": "Example usage:",
2060 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2065 "group": "Chat_Groups",
2066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068 "filename": "server/api/chatGroup/index.js",
2069 "groupTitle": "Chat_Groups"
2073 "url": "/api/chat/groups/{id}",
2074 "title": "Update an existing Group",
2077 "title": "Example usage:",
2078 "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",
2082 "name": "updateGroups",
2083 "group": "Chat_Groups",
2084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086 "filename": "server/api/chatGroup/index.js",
2087 "groupTitle": "Chat_Groups"
2091 "url": "/api/chat/interactions/{id}/tags",
2092 "title": "Add tags to the interaction",
2095 "title": "Example usage:",
2096 "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",
2101 "group": "Chat_Interactions",
2102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104 "filename": "server/api/chatInteraction/index.js",
2105 "groupTitle": "Chat_Interactions"
2109 "url": "/api/chat/interactions",
2110 "title": "Creates a new Interaction",
2113 "title": "Example usage:",
2114 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2118 "name": "CreateInteractions",
2119 "group": "Chat_Interactions",
2134 "field": "ratingValue",
2145 "field": "ratingType",
2152 "field": "ratingMessage",
2159 "field": "pathTranscript",
2166 "field": "mailTranscript",
2173 "field": "closedAt",
2180 "field": "disposition",
2194 "field": "browserName",
2201 "field": "browserVersion",
2215 "field": "osVersion",
2222 "field": "deviceModel",
2229 "field": "deviceVendor",
2236 "field": "deviceType",
2250 "field": "customerIp",
2257 "field": "formData",
2264 "field": "read1stAt",
2271 "field": "lastMsgAt",
2282 "field": "lastMsgDirection",
2289 "field": "closeReason",
2296 "field": "customerPort",
2303 "field": "vidaooSessionId",
2309 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2311 "filename": "server/api/chatInteraction/index.js",
2312 "groupTitle": "Chat_Interactions"
2316 "url": "/api/chat/interactions/{id}",
2317 "title": "Deletes a Interaction",
2320 "title": "Example usage:",
2321 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2325 "name": "DeleteInteractions",
2326 "group": "Chat_Interactions",
2327 "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>",
2329 "filename": "server/api/chatInteraction/index.js",
2330 "groupTitle": "Chat_Interactions"
2334 "url": "/api/chat/interactions/describe",
2335 "title": "Gets table info about Interactions",
2338 "title": "Example usage:",
2339 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2343 "name": "DescribeInteractions",
2344 "group": "Chat_Interactions",
2345 "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>",
2347 "filename": "server/api/chatInteraction/index.js",
2348 "groupTitle": "Chat_Interactions"
2352 "url": "/api/chat/interactions",
2353 "title": "Gets a list of Interactions",
2356 "title": "Example usage:",
2357 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2361 "name": "GetInteractions",
2362 "group": "Chat_Interactions",
2363 "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>",
2365 "filename": "server/api/chatInteraction/index.js",
2366 "groupTitle": "Chat_Interactions"
2370 "url": "/api/chat/interactions/{id}/tags",
2371 "title": "Removes tags from interaction",
2374 "title": "Example usage:",
2375 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2379 "name": "RemoveTags",
2380 "group": "Chat_Interactions",
2381 "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>",
2383 "filename": "server/api/chatInteraction/index.js",
2384 "groupTitle": "Chat_Interactions"
2388 "url": "/api/chat/interactions/{id}",
2389 "title": "Gets a single Interaction",
2392 "title": "Example usage:",
2393 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2397 "name": "ShowInteractions",
2398 "group": "Chat_Interactions",
2399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2401 "filename": "server/api/chatInteraction/index.js",
2402 "groupTitle": "Chat_Interactions"
2406 "url": "/api/chat/interactions/{id}/abandon",
2407 "title": "Abandon interaction",
2410 "title": "Example usage:",
2411 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2416 "group": "Chat_Interactions",
2417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2419 "filename": "server/api/chatInteraction/index.js",
2420 "groupTitle": "Chat_Interactions"
2424 "url": "/api/chat/interactions/{id}/close",
2425 "title": "Close Interaction",
2428 "title": "Example usage:",
2429 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2433 "name": "addMessage",
2434 "group": "Chat_Interactions",
2435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2437 "filename": "server/api/chatInteraction/index.js",
2438 "groupTitle": "Chat_Interactions"
2442 "url": "/api/chat/interactions/{id}/messages",
2443 "title": "Creates new messages",
2446 "title": "Example usage:",
2447 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2451 "name": "addMessage",
2452 "group": "Chat_Interactions",
2485 "field": "direction",
2498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2500 "filename": "server/api/chatInteraction/index.js",
2501 "groupTitle": "Chat_Interactions"
2505 "url": "/api/chat/interactions/{id}/attachment_upload",
2506 "title": "Add attachment",
2509 "title": "Example usage:",
2510 "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",
2514 "name": "attachmentUpload",
2515 "group": "Chat_Interactions",
2516 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2518 "filename": "server/api/chatInteraction/index.js",
2519 "groupTitle": "Chat_Interactions"
2523 "url": "/api/chat/interactions/{id}/vidaoo",
2524 "title": "Create Vidaoo Session",
2527 "title": "Example usage:",
2528 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2532 "name": "createVidaooSession",
2533 "group": "Chat_Interactions",
2534 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2536 "filename": "server/api/chatInteraction/index.js",
2537 "groupTitle": "Chat_Interactions"
2541 "url": "/api/chat/interactions/{id}/custom_update",
2542 "title": "Update interaction",
2545 "title": "Example usage:",
2546 "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",
2550 "name": "customUpdate",
2551 "group": "Chat_Interactions",
2552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2554 "filename": "server/api/chatInteraction/index.js",
2555 "groupTitle": "Chat_Interactions"
2559 "url": "/api/chat/interactions/{id}/download",
2560 "title": "Gets interaction",
2563 "title": "Example usage:",
2564 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2569 "group": "Chat_Interactions",
2570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2572 "filename": "server/api/chatInteraction/index.js",
2573 "groupTitle": "Chat_Interactions"
2577 "url": "/api/chat/interactions/{id}/messages",
2578 "title": "Gets interaction messages",
2581 "title": "Example usage:",
2582 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2586 "name": "getMessages",
2587 "group": "Chat_Interactions",
2588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2590 "filename": "server/api/chatInteraction/index.js",
2591 "groupTitle": "Chat_Interactions"
2595 "url": "/api/chat/interactions/{id}/my_messages",
2596 "title": "Gets interaction messages",
2599 "title": "Example usage:",
2600 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2604 "name": "getMyMessages",
2605 "group": "Chat_Interactions",
2606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2608 "filename": "server/api/chatInteraction/index.js",
2609 "groupTitle": "Chat_Interactions"
2613 "url": "/api/chat/interactions/{id}",
2614 "title": "Update an existing Interaction",
2617 "title": "Example usage:",
2618 "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",
2622 "name": "updateInteractions",
2623 "group": "Chat_Interactions",
2624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2626 "filename": "server/api/chatInteraction/index.js",
2627 "groupTitle": "Chat_Interactions"
2631 "url": "/api/chat/internal/messages",
2632 "title": "Creates a new Message",
2635 "title": "Example usage:",
2636 "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",
2640 "name": "CreateMessages",
2641 "group": "Chat_Internal_Messages",
2663 "field": "ChatInternalMessageId",
2669 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2671 "filename": "server/api/chatInternalMessage/index.js",
2672 "groupTitle": "Chat_Internal_Messages"
2676 "url": "/api/chat/internal/messages/{id}",
2677 "title": "Deletes a Message",
2680 "title": "Example usage:",
2681 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2685 "name": "DeleteMessages",
2686 "group": "Chat_Internal_Messages",
2687 "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>",
2689 "filename": "server/api/chatInternalMessage/index.js",
2690 "groupTitle": "Chat_Internal_Messages"
2694 "url": "/api/chat/internal/messages/describe",
2695 "title": "Gets table info about Messages",
2698 "title": "Example usage:",
2699 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2703 "name": "DescribeMessages",
2704 "group": "Chat_Internal_Messages",
2705 "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>",
2707 "filename": "server/api/chatInternalMessage/index.js",
2708 "groupTitle": "Chat_Internal_Messages"
2712 "url": "/api/chat/internal/messages",
2713 "title": "Gets a list of Messages",
2716 "title": "Example usage:",
2717 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2721 "name": "GetMessages",
2722 "group": "Chat_Internal_Messages",
2723 "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>",
2725 "filename": "server/api/chatInternalMessage/index.js",
2726 "groupTitle": "Chat_Internal_Messages"
2730 "url": "/api/chat/internal/messages/{id}",
2731 "title": "Gets a single Message",
2734 "title": "Example usage:",
2735 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2739 "name": "ShowMessages",
2740 "group": "Chat_Internal_Messages",
2741 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2743 "filename": "server/api/chatInternalMessage/index.js",
2744 "groupTitle": "Chat_Internal_Messages"
2748 "url": "/api/chat/internal/messages/{id}",
2749 "title": "Update an existing Message",
2752 "title": "Example usage:",
2753 "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",
2757 "name": "updateMessages",
2758 "group": "Chat_Internal_Messages",
2759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2761 "filename": "server/api/chatInternalMessage/index.js",
2762 "groupTitle": "Chat_Internal_Messages"
2766 "url": "/api/chat/messages",
2767 "title": "Creates a new Message",
2770 "title": "Example usage:",
2771 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2775 "name": "CreateMessages",
2776 "group": "Chat_Messages",
2809 "field": "direction",
2822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2824 "filename": "server/api/chatMessage/index.js",
2825 "groupTitle": "Chat_Messages"
2829 "url": "/api/chat/messages/{id}",
2830 "title": "Deletes a Message",
2833 "title": "Example usage:",
2834 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2838 "name": "DeleteMessages",
2839 "group": "Chat_Messages",
2840 "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>",
2842 "filename": "server/api/chatMessage/index.js",
2843 "groupTitle": "Chat_Messages"
2847 "url": "/api/chat/messages/describe",
2848 "title": "Gets table info about Messages",
2851 "title": "Example usage:",
2852 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2856 "name": "DescribeMessages",
2857 "group": "Chat_Messages",
2858 "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>",
2860 "filename": "server/api/chatMessage/index.js",
2861 "groupTitle": "Chat_Messages"
2865 "url": "/api/chat/messages",
2866 "title": "Gets a list of Messages",
2869 "title": "Example usage:",
2870 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2874 "name": "GetMessages",
2875 "group": "Chat_Messages",
2876 "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>",
2878 "filename": "server/api/chatMessage/index.js",
2879 "groupTitle": "Chat_Messages"
2883 "url": "/api/chat/messages/{id}",
2884 "title": "Gets a single Message",
2887 "title": "Example usage:",
2888 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2892 "name": "ShowMessages",
2893 "group": "Chat_Messages",
2894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2896 "filename": "server/api/chatMessage/index.js",
2897 "groupTitle": "Chat_Messages"
2901 "url": "/api/chat/messages/{id}",
2902 "title": "Update an existing Message",
2905 "title": "Example usage:",
2906 "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",
2910 "name": "updateMessages",
2911 "group": "Chat_Messages",
2912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2914 "filename": "server/api/chatMessage/index.js",
2915 "groupTitle": "Chat_Messages"
2919 "url": "/api/chat/offline_messages",
2920 "title": "Creates a new OfflineMessage",
2923 "title": "Example usage:",
2924 "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",
2928 "name": "CreateOfflineMessages",
2929 "group": "Chat_Offline_Messages",
2943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2945 "filename": "server/api/chatOfflineMessage/index.js",
2946 "groupTitle": "Chat_Offline_Messages"
2950 "url": "/api/chat/offline_messages/{id}",
2951 "title": "Deletes a OfflineMessage",
2954 "title": "Example usage:",
2955 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2959 "name": "DeleteOfflineMessages",
2960 "group": "Chat_Offline_Messages",
2961 "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>",
2963 "filename": "server/api/chatOfflineMessage/index.js",
2964 "groupTitle": "Chat_Offline_Messages"
2968 "url": "/api/chat/offline_messages/describe",
2969 "title": "Gets table info about OfflineMessages",
2972 "title": "Example usage:",
2973 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
2977 "name": "DescribeOfflineMessages",
2978 "group": "Chat_Offline_Messages",
2979 "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>",
2981 "filename": "server/api/chatOfflineMessage/index.js",
2982 "groupTitle": "Chat_Offline_Messages"
2986 "url": "/api/chat/offline_messages",
2987 "title": "Gets a list of OfflineMessages",
2990 "title": "Example usage:",
2991 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
2995 "name": "GetOfflineMessages",
2996 "group": "Chat_Offline_Messages",
2997 "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>",
2999 "filename": "server/api/chatOfflineMessage/index.js",
3000 "groupTitle": "Chat_Offline_Messages"
3004 "url": "/api/chat/offline_messages/{id}",
3005 "title": "Gets a single OfflineMessage",
3008 "title": "Example usage:",
3009 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3013 "name": "ShowOfflineMessages",
3014 "group": "Chat_Offline_Messages",
3015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3017 "filename": "server/api/chatOfflineMessage/index.js",
3018 "groupTitle": "Chat_Offline_Messages"
3022 "url": "/api/chat/offline_messages/{id}",
3023 "title": "Update an existing OfflineMessage",
3026 "title": "Example usage:",
3027 "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",
3031 "name": "updateOfflineMessages",
3032 "group": "Chat_Offline_Messages",
3033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3035 "filename": "server/api/chatOfflineMessage/index.js",
3036 "groupTitle": "Chat_Offline_Messages"
3040 "url": "/api/chat/proactive_actions",
3041 "title": "Creates a new Proactive Action",
3044 "title": "Example usage:",
3045 "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",
3049 "name": "CreateProactive_Actions",
3050 "group": "Chat_Proactive_Actions",
3076 "field": "selector",
3089 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3091 "filename": "server/api/chatProactiveAction/index.js",
3092 "groupTitle": "Chat_Proactive_Actions"
3096 "url": "/api/chat/proactive_actions/{id}",
3097 "title": "Deletes a Proactive Action",
3100 "title": "Example usage:",
3101 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3105 "name": "DeleteProactive_Actions",
3106 "group": "Chat_Proactive_Actions",
3107 "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>",
3109 "filename": "server/api/chatProactiveAction/index.js",
3110 "groupTitle": "Chat_Proactive_Actions"
3114 "url": "/api/chat/proactive_actions/{id}",
3115 "title": "Gets a single Proactive Action",
3118 "title": "Example usage:",
3119 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3123 "name": "ShowProactive_Actions",
3124 "group": "Chat_Proactive_Actions",
3125 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3127 "filename": "server/api/chatProactiveAction/index.js",
3128 "groupTitle": "Chat_Proactive_Actions"
3132 "url": "/api/chat/proactive_actions/{id}",
3133 "title": "Update an existing Proactive Action",
3136 "title": "Example usage:",
3137 "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",
3141 "name": "updateProactive_Actions",
3142 "group": "Chat_Proactive_Actions",
3143 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3145 "filename": "server/api/chatProactiveAction/index.js",
3146 "groupTitle": "Chat_Proactive_Actions"
3150 "url": "/api/chat/reports/queue",
3151 "title": "Creates a new Chat Queue Report",
3154 "title": "Example usage:",
3155 "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",
3159 "name": "CreateChat_Queue_Reports",
3160 "group": "Chat_Queue_Reports",
3168 "field": "uniqueid",
3196 "field": "acceptAt",
3216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3218 "filename": "server/api/chatQueueReport/index.js",
3219 "groupTitle": "Chat_Queue_Reports"
3223 "url": "/api/chat/reports/queue/{id}",
3224 "title": "Deletes a Chat Queue Report",
3227 "title": "Example usage:",
3228 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3232 "name": "DeleteChat_Queue_Reports",
3233 "group": "Chat_Queue_Reports",
3234 "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>",
3236 "filename": "server/api/chatQueueReport/index.js",
3237 "groupTitle": "Chat_Queue_Reports"
3241 "url": "/api/chat/reports/queue/describe",
3242 "title": "Gets table info about Chat Queue Reports",
3245 "title": "Example usage:",
3246 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3250 "name": "DescribeChat_Queue_Reports",
3251 "group": "Chat_Queue_Reports",
3252 "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>",
3254 "filename": "server/api/chatQueueReport/index.js",
3255 "groupTitle": "Chat_Queue_Reports"
3259 "url": "/api/chat/reports/queue",
3260 "title": "Gets a list of Chat Queue Reports",
3263 "title": "Example usage:",
3264 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3268 "name": "GetChat_Queue_Reports",
3269 "group": "Chat_Queue_Reports",
3270 "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>",
3272 "filename": "server/api/chatQueueReport/index.js",
3273 "groupTitle": "Chat_Queue_Reports"
3277 "url": "/api/chat/reports/queue/{id}",
3278 "title": "Gets a single Chat Queue Report",
3281 "title": "Example usage:",
3282 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3286 "name": "ShowChat_Queue_Reports",
3287 "group": "Chat_Queue_Reports",
3288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3290 "filename": "server/api/chatQueueReport/index.js",
3291 "groupTitle": "Chat_Queue_Reports"
3295 "url": "/api/chat/reports/queue/{id}",
3296 "title": "Update an existing Chat Queue Report",
3299 "title": "Example usage:",
3300 "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",
3304 "name": "updateChat_Queue_Reports",
3305 "group": "Chat_Queue_Reports",
3306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3308 "filename": "server/api/chatQueueReport/index.js",
3309 "groupTitle": "Chat_Queue_Reports"
3313 "url": "/api/chat/queues/{id}/users",
3314 "title": "Add agents to a queue",
3317 "title": "Example usage:",
3318 "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",
3322 "name": "AddAgents",
3323 "group": "Chat_Queues",
3324 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3326 "filename": "server/api/chatQueue/index.js",
3327 "groupTitle": "Chat_Queues"
3331 "url": "/api/chat/queues/{id}/teams",
3332 "title": "Add teams to a queue",
3335 "title": "Example usage:",
3336 "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",
3341 "group": "Chat_Queues",
3342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3344 "filename": "server/api/chatQueue/index.js",
3345 "groupTitle": "Chat_Queues"
3349 "url": "/api/chat/queues",
3350 "title": "Creates a new Queue",
3353 "title": "Example usage:",
3354 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3358 "name": "CreateQueues",
3359 "group": "Chat_Queues",
3374 "field": "description",
3393 "field": "strategy",
3399 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3401 "filename": "server/api/chatQueue/index.js",
3402 "groupTitle": "Chat_Queues"
3406 "url": "/api/chat/queues/{id}",
3407 "title": "Deletes a Queue",
3410 "title": "Example usage:",
3411 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3415 "name": "DeleteQueues",
3416 "group": "Chat_Queues",
3417 "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>",
3419 "filename": "server/api/chatQueue/index.js",
3420 "groupTitle": "Chat_Queues"
3424 "url": "/api/chat/queues/describe",
3425 "title": "Gets table info about Queues",
3428 "title": "Example usage:",
3429 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3433 "name": "DescribeQueues",
3434 "group": "Chat_Queues",
3435 "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>",
3437 "filename": "server/api/chatQueue/index.js",
3438 "groupTitle": "Chat_Queues"
3442 "url": "/api/chat/queues/{id}/users",
3443 "title": "Gets queue agents",
3446 "title": "Example usage:",
3447 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3451 "name": "GetAgents",
3452 "group": "Chat_Queues",
3453 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3455 "filename": "server/api/chatQueue/index.js",
3456 "groupTitle": "Chat_Queues"
3460 "url": "/api/chat/queues/{id}/members",
3461 "title": "GetMembers",
3464 "title": "Example usage:",
3465 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3469 "name": "GetMembers",
3470 "group": "Chat_Queues",
3471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3473 "filename": "server/api/chatQueue/index.js",
3474 "groupTitle": "Chat_Queues"
3478 "url": "/api/chat/queues",
3479 "title": "Gets a list of Queues",
3482 "title": "Example usage:",
3483 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3487 "name": "GetQueues",
3488 "group": "Chat_Queues",
3489 "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>",
3491 "filename": "server/api/chatQueue/index.js",
3492 "groupTitle": "Chat_Queues"
3496 "url": "/api/chat/queues/{id}/teams",
3497 "title": "Gets queues list",
3500 "title": "Example usage:",
3501 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3506 "group": "Chat_Queues",
3507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3509 "filename": "server/api/chatQueue/index.js",
3510 "groupTitle": "Chat_Queues"
3514 "url": "/api/chat/queues/{id}/users",
3515 "title": "Removes agents from a queue",
3518 "title": "Example usage:",
3519 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3523 "name": "RemoveAgents",
3524 "group": "Chat_Queues",
3525 "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>",
3527 "filename": "server/api/chatQueue/index.js",
3528 "groupTitle": "Chat_Queues"
3532 "url": "/api/chat/queues/{id}",
3533 "title": "Gets a single Queue",
3536 "title": "Example usage:",
3537 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3541 "name": "ShowQueues",
3542 "group": "Chat_Queues",
3543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3545 "filename": "server/api/chatQueue/index.js",
3546 "groupTitle": "Chat_Queues"
3550 "url": "/api/chat/queues/{id}",
3551 "title": "Update an existing Queue",
3554 "title": "Example usage:",
3555 "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",
3559 "name": "updateQueues",
3560 "group": "Chat_Queues",
3561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3563 "filename": "server/api/chatQueue/index.js",
3564 "groupTitle": "Chat_Queues"
3568 "url": "/api/chat/reports/transfer",
3569 "title": "Creates a new Chat Transfer Report",
3572 "title": "Example usage:",
3573 "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",
3577 "name": "CreateChat_Transfer_Reports",
3578 "group": "Chat_Transfer_Reports",
3586 "field": "uniqueid",
3605 "field": "transferredAt",
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": "server/api/chatTransferReport/index.js",
3614 "groupTitle": "Chat_Transfer_Reports"
3618 "url": "/api/chat/reports/transfer/{id}",
3619 "title": "Deletes a Chat Transfer Report",
3622 "title": "Example usage:",
3623 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3627 "name": "DeleteChat_Transfer_Reports",
3628 "group": "Chat_Transfer_Reports",
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": "server/api/chatTransferReport/index.js",
3632 "groupTitle": "Chat_Transfer_Reports"
3636 "url": "/api/chat/reports/transfer/describe",
3637 "title": "Gets table info about Chat Transfer Reports",
3640 "title": "Example usage:",
3641 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3645 "name": "DescribeChat_Transfer_Reports",
3646 "group": "Chat_Transfer_Reports",
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": "server/api/chatTransferReport/index.js",
3650 "groupTitle": "Chat_Transfer_Reports"
3654 "url": "/api/chat/reports/transfer",
3655 "title": "Gets a list of Chat Transfer Reports",
3658 "title": "Example usage:",
3659 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3663 "name": "GetChat_Transfer_Reports",
3664 "group": "Chat_Transfer_Reports",
3665 "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>",
3667 "filename": "server/api/chatTransferReport/index.js",
3668 "groupTitle": "Chat_Transfer_Reports"
3672 "url": "/api/chat/reports/transfer/{id}",
3673 "title": "Gets a single Chat Transfer Report",
3676 "title": "Example usage:",
3677 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3681 "name": "ShowChat_Transfer_Reports",
3682 "group": "Chat_Transfer_Reports",
3683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3685 "filename": "server/api/chatTransferReport/index.js",
3686 "groupTitle": "Chat_Transfer_Reports"
3690 "url": "/api/chat/reports/transfer/{id}",
3691 "title": "Update an existing Chat Transfer Report",
3694 "title": "Example usage:",
3695 "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",
3699 "name": "updateChat_Transfer_Reports",
3700 "group": "Chat_Transfer_Reports",
3701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3703 "filename": "server/api/chatTransferReport/index.js",
3704 "groupTitle": "Chat_Transfer_Reports"
3708 "url": "/api/chat/websites/{id}/users",
3709 "title": "Add agents to a website",
3712 "title": "Example usage:",
3713 "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",
3717 "name": "AddAgents",
3718 "group": "Chat_Websites",
3719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3721 "filename": "server/api/chatWebsite/index.js",
3722 "groupTitle": "Chat_Websites"
3726 "url": "/api/chat/websites",
3727 "title": "Creates a new Website",
3730 "title": "Example usage:",
3731 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3735 "name": "CreateWebsites",
3736 "group": "Chat_Websites",
3758 "field": "description",
3772 "field": "mapKeyOffline",
3786 "field": "agentAlias",
3793 "field": "customerAlias",
3807 "field": "color_button",
3814 "field": "textColor",
3821 "field": "fontSize",
3835 "field": "animation",
3846 "field": "header_shape",
3853 "field": "header_online",
3860 "field": "start_chat_button",
3867 "field": "offline_chat_button",
3874 "field": "header_offline",
3881 "field": "download_transcript",
3895 "field": "whiteLabel",
3902 "field": "defaultWhiteLabel",
3916 "field": "closingQuestion",
3923 "field": "formSubmitSuccessMessage",
3930 "field": "formSubmitFailureMessage",
3937 "field": "noteTitle",
3944 "field": "placeholderMessage",
3951 "field": "closingMessage",
3958 "field": "closingMessageButton",
3965 "field": "skipMessageButton",
3972 "field": "conditionAgreement",
3979 "field": "enableRating",
3986 "field": "enableFeedback",
3993 "field": "enableSendButton",
4000 "field": "feedbackTitle",
4011 "field": "ratingType",
4018 "field": "ratingStarsNumber",
4025 "field": "onlineForm",
4032 "field": "offlineForm",
4046 "field": "autoclose",
4053 "field": "enableCustomerWriting",
4060 "field": "forwardTranscript",
4067 "field": "forwardTranscriptMessage",
4074 "field": "forwardOffline",
4081 "field": "forwardOfflineAddress",
4088 "field": "waitingTitle",
4095 "field": "waitingMessage",
4102 "field": "offlineMessageSubject",
4109 "field": "offlineMessageBody",
4116 "field": "enableUnmanagedNote",
4123 "field": "unmanagedMessage",
4130 "field": "skipUnmanaged",
4137 "field": "sendUnmanaged",
4144 "field": "enableCustomerAttachment",
4151 "field": "enableCustomerCheckmarks",
4158 "field": "agentAvatar",
4165 "field": "showAgentAvatar",
4172 "field": "timezone",
4179 "field": "notificationTemplate",
4186 "field": "notificationSound",
4193 "field": "notificationShake",
4200 "field": "hideWhenOffline",
4207 "field": "agentIdentifier",
4214 "field": "waitForTheAssignedAgent",
4221 "field": "alignment",
4228 "field": "verticalAlignment",
4235 "field": "messagesAlignment",
4242 "field": "defaultTitle",
4249 "field": "customerAvatar",
4256 "field": "showCustomerAvatar",
4263 "field": "messageFontSize",
4270 "field": "backgroundColor",
4277 "field": "queueTransfer",
4284 "field": "queueTransferTimeout",
4291 "field": "agentTransfer",
4298 "field": "agentTransferTimeout",
4305 "field": "systemAlias",
4312 "field": "systemAvatar",
4319 "field": "mandatoryDispositionPauseId",
4320 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4326 "field": "mandatoryDisposition",
4327 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4333 "field": "vidaooEscalation",
4340 "field": "vidaooApiKey",
4346 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4348 "filename": "server/api/chatWebsite/index.js",
4349 "groupTitle": "Chat_Websites"
4353 "url": "/api/chat/websites/{id}",
4354 "title": "Deletes a Website",
4357 "title": "Example usage:",
4358 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4362 "name": "DeleteWebsites",
4363 "group": "Chat_Websites",
4364 "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>",
4366 "filename": "server/api/chatWebsite/index.js",
4367 "groupTitle": "Chat_Websites"
4371 "url": "/api/chat/websites/describe",
4372 "title": "Gets table info about Websites",
4375 "title": "Example usage:",
4376 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4380 "name": "DescribeWebsites",
4381 "group": "Chat_Websites",
4382 "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>",
4384 "filename": "server/api/chatWebsite/index.js",
4385 "groupTitle": "Chat_Websites"
4389 "url": "/api/chat/websites/{id}/users",
4390 "title": "Gets agents from website",
4393 "title": "Example usage:",
4394 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4398 "name": "GetAgents",
4399 "group": "Chat_Websites",
4400 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4402 "filename": "server/api/chatWebsite/index.js",
4403 "groupTitle": "Chat_Websites"
4407 "url": "/api/chat/websites",
4408 "title": "Gets a list of Websites",
4411 "title": "Example usage:",
4412 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4416 "name": "GetWebsites",
4417 "group": "Chat_Websites",
4418 "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>",
4420 "filename": "server/api/chatWebsite/index.js",
4421 "groupTitle": "Chat_Websites"
4425 "url": "/api/chat/websites/{id}/users",
4426 "title": "Removes agents from a website",
4429 "title": "Example usage:",
4430 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4434 "name": "RemoveAgents",
4435 "group": "Chat_Websites",
4436 "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>",
4438 "filename": "server/api/chatWebsite/index.js",
4439 "groupTitle": "Chat_Websites"
4443 "url": "/api/chat/websites/{id}/canned_answers",
4444 "title": "Removes canned answers from account",
4447 "title": "Example usage:",
4448 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4452 "name": "RemoveAnswers",
4453 "group": "Chat_Websites",
4454 "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>",
4456 "filename": "server/api/chatWebsite/index.js",
4457 "groupTitle": "Chat_Websites"
4461 "url": "/api/chat/websites/{id}/dispositions",
4462 "title": "Removes canned answers from account",
4465 "title": "Example usage:",
4466 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4470 "name": "RemoveDispositions",
4471 "group": "Chat_Websites",
4472 "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>",
4474 "filename": "server/api/chatWebsite/index.js",
4475 "groupTitle": "Chat_Websites"
4479 "url": "/api/chat/websites/{id}",
4480 "title": "Gets a single Website",
4483 "title": "Example usage:",
4484 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4488 "name": "ShowWebsites",
4489 "group": "Chat_Websites",
4490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4492 "filename": "server/api/chatWebsite/index.js",
4493 "groupTitle": "Chat_Websites"
4497 "url": "/api/chat/messages/{id}/accept",
4498 "title": "Accepts message",
4501 "title": "Example usage:",
4502 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4506 "name": "acceptMessage",
4507 "group": "Chat_Websites",
4508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4510 "filename": "server/api/chatMessage/index.js",
4511 "groupTitle": "Chat_Websites"
4515 "url": "/api/chat/websites/{id}/canned_answers",
4516 "title": "Creates new canned answer",
4519 "title": "Example usage:",
4520 "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",
4524 "name": "addAnswer",
4525 "group": "Chat_Websites",
4547 "field": "description",
4560 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4562 "filename": "server/api/chatWebsite/index.js",
4563 "groupTitle": "Chat_Websites"
4567 "url": "/api/chat/websites/{id}/applications",
4568 "title": "Creates new applications",
4571 "title": "Example usage:",
4572 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4576 "name": "addApplications",
4577 "group": "Chat_Websites",
4585 "field": "priority",
4606 "field": "description",
4613 "field": "interval",
4619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4621 "filename": "server/api/chatWebsite/index.js",
4622 "groupTitle": "Chat_Websites"
4626 "url": "/api/chat/websites/{id}/avatar",
4627 "title": "Add avatar",
4630 "title": "Example usage:",
4631 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4635 "name": "addAvatar",
4636 "group": "Chat_Websites",
4637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4639 "filename": "server/api/chatWebsite/index.js",
4640 "groupTitle": "Chat_Websites"
4644 "url": "/api/chat/websites/{id}/customer_avatar",
4645 "title": "Add customer avatar",
4648 "title": "Example usage:",
4649 "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",
4653 "name": "addCustomerAvatar",
4654 "group": "Chat_Websites",
4655 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4657 "filename": "server/api/chatWebsite/index.js",
4658 "groupTitle": "Chat_Websites"
4662 "url": "/api/chat/websites/{id}/dispositions",
4663 "title": "Creates new disposition",
4666 "title": "Example usage:",
4667 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4671 "name": "addDisposition",
4672 "group": "Chat_Websites",
4686 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4688 "filename": "server/api/chatWebsite/index.js",
4689 "groupTitle": "Chat_Websites"
4693 "url": "/api/chat/accounts/{id}/interactions",
4694 "title": "Creates new interactions",
4697 "title": "Example usage:",
4698 "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",
4702 "name": "addInteraction",
4703 "group": "Chat_Websites",
4718 "field": "ratingValue",
4729 "field": "ratingType",
4736 "field": "ratingMessage",
4743 "field": "pathTranscript",
4750 "field": "mailTranscript",
4757 "field": "closedAt",
4764 "field": "disposition",
4778 "field": "browserName",
4785 "field": "browserVersion",
4799 "field": "osVersion",
4806 "field": "deviceModel",
4813 "field": "deviceVendor",
4820 "field": "deviceType",
4834 "field": "customerIp",
4841 "field": "formData",
4848 "field": "read1stAt",
4855 "field": "lastMsgAt",
4866 "field": "lastMsgDirection",
4873 "field": "closeReason",
4880 "field": "customerPort",
4887 "field": "vidaooSessionId",
4893 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4895 "filename": "server/api/chatWebsite/index.js",
4896 "groupTitle": "Chat_Websites"
4900 "url": "/api/chat/websites/{id}/logo",
4901 "title": "Add logo",
4904 "title": "Example usage:",
4905 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4910 "group": "Chat_Websites",
4911 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4913 "filename": "server/api/chatWebsite/index.js",
4914 "groupTitle": "Chat_Websites"
4918 "url": "/api/chat/websites/{id}/proactive_actions",
4919 "title": "Creates new Proactive Actions",
4922 "title": "Example usage:",
4923 "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",
4927 "name": "addProactiveActions",
4928 "group": "Chat_Websites",
4954 "field": "selector",
4967 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4969 "filename": "server/api/chatWebsite/index.js",
4970 "groupTitle": "Chat_Websites"
4974 "url": "/api/chat/websites/{id}/system_avatar",
4975 "title": "Add system avatar",
4978 "title": "Example usage:",
4979 "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",
4983 "name": "addSystemAvatar",
4984 "group": "Chat_Websites",
4985 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4987 "filename": "server/api/chatWebsite/index.js",
4988 "groupTitle": "Chat_Websites"
4992 "url": "/api/chat/websites/{id}/canned_answers",
4993 "title": "Gets account canned answers",
4996 "title": "Example usage:",
4997 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5001 "name": "getAnswers",
5002 "group": "Chat_Websites",
5003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5005 "filename": "server/api/chatWebsite/index.js",
5006 "groupTitle": "Chat_Websites"
5010 "url": "/api/chat/websites/{id}/applications",
5011 "title": "Gets Website Applications",
5014 "title": "Example usage:",
5015 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5019 "name": "getApplications",
5020 "group": "Chat_Websites",
5021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5023 "filename": "server/api/chatWebsite/index.js",
5024 "groupTitle": "Chat_Websites"
5028 "url": "/api/chat/websites/{id}/avatar",
5029 "title": "Get avatar",
5032 "title": "Example usage:",
5033 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5037 "name": "getAvatar",
5038 "group": "Chat_Websites",
5039 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5041 "filename": "server/api/chatWebsite/index.js",
5042 "groupTitle": "Chat_Websites"
5046 "url": "/api/chat/websites/{id}/customer_avatar",
5047 "title": "Get Customer Avatar",
5050 "title": "Example usage:",
5051 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5055 "name": "getCustomerAvatar",
5056 "group": "Chat_Websites",
5057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5059 "filename": "server/api/chatWebsite/index.js",
5060 "groupTitle": "Chat_Websites"
5064 "url": "/api/chat/websites/{id}/dispositions",
5065 "title": "Gets account dispositions",
5068 "title": "Example usage:",
5069 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5073 "name": "getDispositions",
5074 "group": "Chat_Websites",
5075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5077 "filename": "server/api/chatWebsite/index.js",
5078 "groupTitle": "Chat_Websites"
5082 "url": "/api/chat/websites/{id}/fields",
5083 "title": "Gets Website Fields",
5086 "title": "Example usage:",
5087 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5091 "name": "getFields",
5092 "group": "Chat_Websites",
5093 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5095 "filename": "server/api/chatWebsite/index.js",
5096 "groupTitle": "Chat_Websites"
5100 "url": "/api/chat/websites/{id}/interactions",
5101 "title": "Gets Website Interactions",
5104 "title": "Example usage:",
5105 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5109 "name": "getInteraction",
5110 "group": "Chat_Websites",
5111 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5113 "filename": "server/api/chatWebsite/index.js",
5114 "groupTitle": "Chat_Websites"
5118 "url": "/api/chat/websites/{id}/logo",
5119 "title": "Get logo",
5122 "title": "Example usage:",
5123 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5128 "group": "Chat_Websites",
5129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5131 "filename": "server/api/chatWebsite/index.js",
5132 "groupTitle": "Chat_Websites"
5136 "url": "/api/chat/websites/{id}/offline_messages",
5137 "title": "Gets Website Offline Messages",
5140 "title": "Example usage:",
5141 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5145 "name": "getOfflineMessages",
5146 "group": "Chat_Websites",
5147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5149 "filename": "server/api/chatWebsite/index.js",
5150 "groupTitle": "Chat_Websites"
5154 "url": "/api/chat/websites/{id}/proactive_actions",
5155 "title": "Gets Website Proactive Actions",
5158 "title": "Example usage:",
5159 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5163 "name": "getProactiveActions",
5164 "group": "Chat_Websites",
5165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5167 "filename": "server/api/chatWebsite/index.js",
5168 "groupTitle": "Chat_Websites"
5172 "url": "/api/chat/websites/{id}/snippet",
5173 "title": "Gets Website Snippet",
5176 "title": "Example usage:",
5177 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5181 "name": "getSnippet",
5182 "group": "Chat_Websites",
5183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5185 "filename": "server/api/chatWebsite/index.js",
5186 "groupTitle": "Chat_Websites"
5190 "url": "/api/chat/websites/{id}/system_avatar",
5191 "title": "Get System Avatar",
5194 "title": "Example usage:",
5195 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5199 "name": "getSystemAvatar",
5200 "group": "Chat_Websites",
5201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5203 "filename": "server/api/chatWebsite/index.js",
5204 "groupTitle": "Chat_Websites"
5208 "url": "/api/chat/websites/{id}/notify",
5209 "title": "Notify new message",
5212 "title": "Example usage:",
5213 "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",
5218 "group": "Chat_Websites",
5219 "description": "<p>Motion 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>",
5221 "filename": "server/api/chatWebsite/index.js",
5222 "groupTitle": "Chat_Websites"
5226 "url": "/api/chat/websites/{id}/offline",
5227 "title": "Offline message",
5230 "title": "Example usage:",
5231 "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",
5236 "group": "Chat_Websites",
5237 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5239 "filename": "server/api/chatWebsite/index.js",
5240 "groupTitle": "Chat_Websites"
5244 "url": "/api/chat/messages/{id}/reject",
5245 "title": "Rejects message",
5248 "title": "Example usage:",
5249 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5253 "name": "rejectMessage",
5254 "group": "Chat_Websites",
5255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5257 "filename": "server/api/chatMessage/index.js",
5258 "groupTitle": "Chat_Websites"
5262 "url": "/api/chat/websites/{id}",
5263 "title": "Update an existing Website",
5266 "title": "Example usage:",
5267 "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",
5271 "name": "updateWebsites",
5272 "group": "Chat_Websites",
5273 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5275 "filename": "server/api/chatWebsite/index.js",
5276 "groupTitle": "Chat_Websites"
5280 "url": "/api/cloudProviders",
5281 "title": "Creates a new CloudProvider",
5284 "title": "Example usage:",
5285 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5289 "name": "CreateCloudProviders",
5290 "group": "CloudProviders",
5329 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5331 "filename": "server/api/cloudProvider/index.js",
5332 "groupTitle": "CloudProviders"
5336 "url": "/api/cloudProviders/{id}",
5337 "title": "Deletes a CloudProvider",
5340 "title": "Example usage:",
5341 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5345 "name": "DeleteCloudProviders",
5346 "group": "CloudProviders",
5347 "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>",
5349 "filename": "server/api/cloudProvider/index.js",
5350 "groupTitle": "CloudProviders"
5354 "url": "/api/cloudProviders",
5355 "title": "Gets a list of CloudProviders",
5358 "title": "Example usage:",
5359 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5363 "name": "GetCloudProviders",
5364 "group": "CloudProviders",
5365 "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>",
5367 "filename": "server/api/cloudProvider/index.js",
5368 "groupTitle": "CloudProviders"
5372 "url": "/api/cloudProviders/{id}",
5373 "title": "Gets a single CloudProvider",
5376 "title": "Example usage:",
5377 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5381 "name": "ShowCloudProviders",
5382 "group": "CloudProviders",
5383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5385 "filename": "server/api/cloudProvider/index.js",
5386 "groupTitle": "CloudProviders"
5390 "url": "/api/cloudProviders/{id}",
5391 "title": "Update an existing CloudProvider",
5394 "title": "Example usage:",
5395 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5399 "name": "updateCloudProviders",
5400 "group": "CloudProviders",
5401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5403 "filename": "server/api/cloudProvider/index.js",
5404 "groupTitle": "CloudProviders"
5408 "url": "/api/cm/companies",
5409 "title": "Creates a new Company",
5412 "title": "Example usage:",
5413 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5417 "name": "CreateCompanies",
5418 "group": "Cm_Companies",
5440 "field": "companyId",
5482 "field": "postalCode",
5510 "field": "emailDomain",
5524 "field": "sPostalCode",
5538 "field": "sCountry",
5545 "field": "description",
5551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5553 "filename": "server/api/cmCompany/index.js",
5554 "groupTitle": "Cm_Companies"
5558 "url": "/api/cm/companies/{id}",
5559 "title": "Deletes a Company",
5562 "title": "Example usage:",
5563 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5567 "name": "DeleteCompanies",
5568 "group": "Cm_Companies",
5569 "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>",
5571 "filename": "server/api/cmCompany/index.js",
5572 "groupTitle": "Cm_Companies"
5576 "url": "/api/cm/companies/describe",
5577 "title": "Gets table info about Companies",
5580 "title": "Example usage:",
5581 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5585 "name": "DescribeCompanies",
5586 "group": "Cm_Companies",
5587 "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>",
5589 "filename": "server/api/cmCompany/index.js",
5590 "groupTitle": "Cm_Companies"
5594 "url": "/api/cm/companies",
5595 "title": "Gets a list of Companies",
5598 "title": "Example usage:",
5599 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5603 "name": "GetCompanies",
5604 "group": "Cm_Companies",
5605 "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>",
5607 "filename": "server/api/cmCompany/index.js",
5608 "groupTitle": "Cm_Companies"
5612 "url": "/api/cm/companies/{id}",
5613 "title": "Gets a single Company",
5616 "title": "Example usage:",
5617 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5621 "name": "ShowCompanies",
5622 "group": "Cm_Companies",
5623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5625 "filename": "server/api/cmCompany/index.js",
5626 "groupTitle": "Cm_Companies"
5630 "url": "/api/cm/companies/{id}/contacts",
5631 "title": "Creates new contacts",
5634 "title": "Example usage:",
5635 "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",
5639 "name": "addContacts",
5640 "group": "Cm_Companies",
5648 "field": "firstName",
5655 "field": "lastName",
5669 "field": "postalCode",
5690 "field": "dateOfBirth",
5697 "field": "description",
5739 "field": "facebook",
5795 "field": "telegram",
5809 "field": "priority",
5816 "field": "scheduledat",
5822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5824 "filename": "server/api/cmCompany/index.js",
5825 "groupTitle": "Cm_Companies"
5829 "url": "/api/cm/companies/{id}/contacts",
5830 "title": "Gets List Contacts",
5833 "title": "Example usage:",
5834 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5838 "name": "getContacts",
5839 "group": "Cm_Companies",
5840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5842 "filename": "server/api/cmCompany/index.js",
5843 "groupTitle": "Cm_Companies"
5847 "url": "/api/cm/companies/{id}",
5848 "title": "Update an existing Company",
5851 "title": "Example usage:",
5852 "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",
5856 "name": "updateCompanies",
5857 "group": "Cm_Companies",
5858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5860 "filename": "server/api/cmCompany/index.js",
5861 "groupTitle": "Cm_Companies"
5865 "url": "/api/cm/contacts/{id}",
5866 "title": "Deletes a Contact",
5869 "title": "Example usage:",
5870 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5874 "name": "DeleteContacts",
5875 "group": "Cm_Contacts",
5876 "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>",
5878 "filename": "server/api/cmContact/index.js",
5879 "groupTitle": "Cm_Contacts"
5883 "url": "/api/cm/contacts/describe",
5884 "title": "Gets table info about Contacts",
5887 "title": "Example usage:",
5888 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5892 "name": "DescribeContacts",
5893 "group": "Cm_Contacts",
5894 "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>",
5896 "filename": "server/api/cmContact/index.js",
5897 "groupTitle": "Cm_Contacts"
5901 "url": "/api/cm/contacts",
5902 "title": "Gets a list of Contacts",
5905 "title": "Example usage:",
5906 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5910 "name": "GetContacts",
5911 "group": "Cm_Contacts",
5912 "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>",
5914 "filename": "server/api/cmContact/index.js",
5915 "groupTitle": "Cm_Contacts"
5919 "url": "/api/cm/contacts/{id}/finals",
5920 "title": "Gets contact hopper finals",
5923 "title": "Example usage:",
5924 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
5928 "name": "GetHopperFinals",
5929 "group": "Cm_Contacts",
5930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5932 "filename": "server/api/cmContact/index.js",
5933 "groupTitle": "Cm_Contacts"
5937 "url": "/api/cm/contacts/{id}/hopper_histories",
5938 "title": "Gets contact hopper histories",
5941 "title": "Example usage:",
5942 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
5946 "name": "GetHopperHistories",
5947 "group": "Cm_Contacts",
5948 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5950 "filename": "server/api/cmContact/index.js",
5951 "groupTitle": "Cm_Contacts"
5955 "url": "/api/cm/contacts/{id}/hoppers",
5956 "title": "Gets contact hoppers",
5959 "title": "Example usage:",
5960 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
5964 "name": "GetHoppers",
5965 "group": "Cm_Contacts",
5966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5968 "filename": "server/api/cmContact/index.js",
5969 "groupTitle": "Cm_Contacts"
5973 "url": "/api/cm/contacts/create_many",
5974 "title": "Create Contacts",
5977 "title": "Example usage:",
5978 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
5982 "name": "bulkCreate",
5983 "group": "Cm_Contacts",
5984 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5986 "filename": "server/api/cmContact/index.js",
5987 "groupTitle": "Cm_Contacts"
5991 "url": "/api/cm/contacts",
5992 "title": "Create Contact",
5995 "title": "Example usage:",
5996 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6001 "group": "Cm_Contacts",
6002 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6004 "filename": "server/api/cmContact/index.js",
6005 "groupTitle": "Cm_Contacts"
6009 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6010 "title": "Gets contact hopper blacks",
6013 "title": "Example usage:",
6014 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6018 "name": "getJscriptySessions",
6019 "group": "Cm_Contacts",
6020 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6022 "filename": "server/api/cmContact/index.js",
6023 "groupTitle": "Cm_Contacts"
6027 "url": "/api/cm/contacts/{id}/tags",
6028 "title": "Gets configurations tags",
6031 "title": "Example usage:",
6032 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6037 "group": "Cm_Contacts",
6038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6040 "filename": "server/api/cmContact/index.js",
6041 "groupTitle": "Cm_Contacts"
6045 "url": "/api/cm/contacts/merge",
6046 "title": "Merge Contact",
6049 "title": "Example usage:",
6050 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6055 "group": "Cm_Contacts",
6056 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6058 "filename": "server/api/cmContact/index.js",
6059 "groupTitle": "Cm_Contacts"
6063 "url": "/api/cm/contacts/{id}/tags",
6064 "title": "Sets new tags",
6067 "title": "Example usage:",
6068 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6073 "group": "Cm_Contacts",
6074 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6076 "filename": "server/api/cmContact/index.js",
6077 "groupTitle": "Cm_Contacts"
6081 "url": "/api/cm/contacts/{id}",
6082 "title": "Gets a single Contact",
6085 "title": "Example usage:",
6086 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6091 "group": "Cm_Contacts",
6092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6094 "filename": "server/api/cmContact/index.js",
6095 "groupTitle": "Cm_Contacts"
6099 "url": "/api/cm/contacts/{id}",
6100 "title": "Update a single Contact",
6103 "title": "Example usage:",
6104 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6109 "group": "Cm_Contacts",
6110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6112 "filename": "server/api/cmContact/index.js",
6113 "groupTitle": "Cm_Contacts"
6117 "url": "/api/cm/custom_fields/{id}",
6118 "title": "Deletes a Custom Field",
6121 "title": "Example usage:",
6122 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6126 "name": "DeleteCustom_Fields",
6127 "group": "Cm_Custom_Fields",
6128 "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>",
6130 "filename": "server/api/cmCustomField/index.js",
6131 "groupTitle": "Cm_Custom_Fields"
6135 "url": "/api/cm/custom_fields",
6136 "title": "Gets a list of Custom Fields",
6139 "title": "Example usage:",
6140 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6144 "name": "GetCustom_Fields",
6145 "group": "Cm_Custom_Fields",
6146 "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>",
6148 "filename": "server/api/cmCustomField/index.js",
6149 "groupTitle": "Cm_Custom_Fields"
6153 "url": "/api/cm/custom_fields/{id}",
6154 "title": "Gets a single Custom Field",
6157 "title": "Example usage:",
6158 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6162 "name": "ShowCustom_Fields",
6163 "group": "Cm_Custom_Fields",
6164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6166 "filename": "server/api/cmCustomField/index.js",
6167 "groupTitle": "Cm_Custom_Fields"
6171 "url": "/api/cm/custom_fields/{id}",
6172 "title": "Update an existing Custom Field",
6175 "title": "Example usage:",
6176 "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",
6180 "name": "updateCustom_Fields",
6181 "group": "Cm_Custom_Fields",
6182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6184 "filename": "server/api/cmCustomField/index.js",
6185 "groupTitle": "Cm_Custom_Fields"
6189 "url": "/api/cm/hopper",
6190 "title": "Creates a new Hopper",
6193 "title": "Example usage:",
6194 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6198 "name": "CreateHopper",
6199 "group": "Cm_Hopper",
6221 "field": "scheduledat",
6228 "field": "countbusyretry",
6235 "field": "countcongestionretry",
6242 "field": "countnoanswerretry",
6249 "field": "callback",
6256 "field": "callbackuniqueid",
6263 "field": "callbackat",
6270 "field": "priority",
6277 "field": "recallme",
6284 "field": "ContactId",
6305 "field": "VoiceQueueId",
6312 "field": "CampaignId",
6318 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6320 "filename": "server/api/cmHopper/index.js",
6321 "groupTitle": "Cm_Hopper"
6325 "url": "/api/cm/hopper/describe",
6326 "title": "Gets table info about Hopper",
6329 "title": "Example usage:",
6330 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6334 "name": "DescribeHopper",
6335 "group": "Cm_Hopper",
6336 "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>",
6338 "filename": "server/api/cmHopper/index.js",
6339 "groupTitle": "Cm_Hopper"
6343 "url": "/api/cm/hopper",
6344 "title": "Gets a list of Hopper",
6347 "title": "Example usage:",
6348 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6352 "name": "GetHopper",
6353 "group": "Cm_Hopper",
6354 "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>",
6356 "filename": "server/api/cmHopper/index.js",
6357 "groupTitle": "Cm_Hopper"
6361 "url": "/api/cm/hopper/{id}",
6362 "title": "Gets a single Hopper",
6365 "title": "Example usage:",
6366 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6370 "name": "ShowHopper",
6371 "group": "Cm_Hopper",
6372 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6374 "filename": "server/api/cmHopper/index.js",
6375 "groupTitle": "Cm_Hopper"
6379 "url": "/api/cm/hopper_black/{id}",
6380 "title": "Deletes a Hopper Black",
6383 "title": "Example usage:",
6384 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6388 "name": "DeleteHopper_Black",
6389 "group": "Cm_Hopper_Black",
6390 "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>",
6392 "filename": "server/api/cmHopperBlack/index.js",
6393 "groupTitle": "Cm_Hopper_Black"
6397 "url": "/api/cm/hopper_black/describe",
6398 "title": "Gets table info about Hopper Black",
6401 "title": "Example usage:",
6402 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6406 "name": "DescribeHopper_Black",
6407 "group": "Cm_Hopper_Black",
6408 "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>",
6410 "filename": "server/api/cmHopperBlack/index.js",
6411 "groupTitle": "Cm_Hopper_Black"
6415 "url": "/api/cm/hopper_black",
6416 "title": "Gets a list of Hopper Black",
6419 "title": "Example usage:",
6420 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6424 "name": "GetHopper_Black",
6425 "group": "Cm_Hopper_Black",
6426 "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>",
6428 "filename": "server/api/cmHopperBlack/index.js",
6429 "groupTitle": "Cm_Hopper_Black"
6433 "url": "/api/cm/hopper_black/{id}",
6434 "title": "Gets a single Hopper Black",
6437 "title": "Example usage:",
6438 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6442 "name": "ShowHopper_Black",
6443 "group": "Cm_Hopper_Black",
6444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6446 "filename": "server/api/cmHopperBlack/index.js",
6447 "groupTitle": "Cm_Hopper_Black"
6451 "url": "/api/cm/hopper_black/{id}",
6452 "title": "Update an existing Hopper Black",
6455 "title": "Example usage:",
6456 "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",
6460 "name": "updateHopper_Black",
6461 "group": "Cm_Hopper_Black",
6462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6464 "filename": "server/api/cmHopperBlack/index.js",
6465 "groupTitle": "Cm_Hopper_Black"
6469 "url": "/api/cm/hopper_final/checkContactHopper",
6470 "title": "Check if contact is in hopper",
6473 "title": "Example usage:",
6474 "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",
6478 "name": "/checkContactHopper",
6479 "group": "Cm_Hopper_Final",
6480 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6482 "filename": "server/api/cmHopperFinal/index.js",
6483 "groupTitle": "Cm_Hopper_Final"
6487 "url": "/api/cm/hopper_final/describe",
6488 "title": "Gets table info about HopperFinal",
6491 "title": "Example usage:",
6492 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6496 "name": "DescribeHopperFinal",
6497 "group": "Cm_Hopper_Final",
6498 "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>",
6500 "filename": "server/api/cmHopperFinal/index.js",
6501 "groupTitle": "Cm_Hopper_Final"
6505 "url": "/api/cm/hopper_final",
6506 "title": "Gets a list of HopperFinal",
6509 "title": "Example usage:",
6510 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6514 "name": "GetHopperFinal",
6515 "group": "Cm_Hopper_Final",
6516 "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>",
6518 "filename": "server/api/cmHopperFinal/index.js",
6519 "groupTitle": "Cm_Hopper_Final"
6523 "url": "/api/cm/hopper_final/{id}",
6524 "title": "Gets a single HopperFinal",
6527 "title": "Example usage:",
6528 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6532 "name": "ShowHopperFinal",
6533 "group": "Cm_Hopper_Final",
6534 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6536 "filename": "server/api/cmHopperFinal/index.js",
6537 "groupTitle": "Cm_Hopper_Final"
6541 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6542 "title": "Return number contacts for attributes",
6545 "title": "Example usage:",
6546 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6550 "name": "countContactsIvrCampaignHopperFinal",
6551 "group": "Cm_Hopper_Final",
6552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6554 "filename": "server/api/cmHopperFinal/index.js",
6555 "groupTitle": "Cm_Hopper_Final"
6559 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6560 "title": "Return number contacts for attributes",
6563 "title": "Example usage:",
6564 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6568 "name": "countContactsQueueCampaignHopperFinal",
6569 "group": "Cm_Hopper_Final",
6570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6572 "filename": "server/api/cmHopperFinal/index.js",
6573 "groupTitle": "Cm_Hopper_Final"
6577 "url": "/api/cm/hopper_final/campaign/{id}",
6578 "title": "Move contacts in hopper",
6581 "title": "Example usage:",
6582 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6586 "name": "moveContactsIvrCampaignHopperFinal",
6587 "group": "Cm_Hopper_Final",
6588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6590 "filename": "server/api/cmHopperFinal/index.js",
6591 "groupTitle": "Cm_Hopper_Final"
6595 "url": "/api/cm/hopper_final/voice/queue/{id}",
6596 "title": "Move contacts in hopper",
6599 "title": "Example usage:",
6600 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6604 "name": "moveContactsQueueCampaignHopperFinal",
6605 "group": "Cm_Hopper_Final",
6606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6608 "filename": "server/api/cmHopperFinal/index.js",
6609 "groupTitle": "Cm_Hopper_Final"
6613 "url": "/api/cm/hopper_final/{id}",
6614 "title": "Update a single hopper final",
6617 "title": "Example usage:",
6618 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6623 "group": "Cm_Hopper_Final",
6624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6626 "filename": "server/api/cmHopperFinal/index.js",
6627 "groupTitle": "Cm_Hopper_Final"
6631 "url": "/api/cm/hopper_history",
6632 "title": "Creates a new HopperHistory",
6635 "title": "Example usage:",
6636 "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",
6640 "name": "CreateHopperHistory",
6641 "group": "Cm_Hopper_History",
6656 "field": "statedesc",
6663 "field": "scheduledat",
6670 "field": "countbusyretry",
6677 "field": "countcongestionretry",
6684 "field": "countnoanswerretry",
6691 "field": "countglobal",
6698 "field": "uniqueid",
6705 "field": "originatecalleridnum",
6712 "field": "originatecalleridname",
6719 "field": "calleridnum",
6726 "field": "calleridname",
6733 "field": "starttime",
6740 "field": "responsetime",
6747 "field": "answertime",
6754 "field": "droptime",
6768 "field": "ringtime",
6775 "field": "holdtime",
6782 "field": "talktime",
6789 "field": "followuptime",
6796 "field": "dropreason",
6803 "field": "campaign",
6810 "field": "campaigntype",
6817 "field": "membername",
6845 "field": "callback",
6852 "field": "callbackuniqueid",
6859 "field": "callbackat",
6866 "field": "recallme",
6873 "field": "editedat",
6886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6888 "filename": "server/api/cmHopperHistory/index.js",
6889 "groupTitle": "Cm_Hopper_History"
6893 "url": "/api/cm/hopper_history/describe",
6894 "title": "Gets table info about HopperHistory",
6897 "title": "Example usage:",
6898 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
6902 "name": "DescribeHopperHistory",
6903 "group": "Cm_Hopper_History",
6904 "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>",
6906 "filename": "server/api/cmHopperHistory/index.js",
6907 "groupTitle": "Cm_Hopper_History"
6911 "url": "/api/cm/hopper_history",
6912 "title": "Gets a list of HopperHistory",
6915 "title": "Example usage:",
6916 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
6920 "name": "GetHopperHistory",
6921 "group": "Cm_Hopper_History",
6922 "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>",
6924 "filename": "server/api/cmHopperHistory/index.js",
6925 "groupTitle": "Cm_Hopper_History"
6929 "url": "/api/cm/hopper_history/{id}",
6930 "title": "Gets a single HopperHistory",
6933 "title": "Example usage:",
6934 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
6938 "name": "ShowHopperHistory",
6939 "group": "Cm_Hopper_History",
6940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6942 "filename": "server/api/cmHopperHistory/index.js",
6943 "groupTitle": "Cm_Hopper_History"
6947 "url": "/api/cm/hopper_history/{id}",
6948 "title": "Update a single hopper history",
6951 "title": "Example usage:",
6952 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6957 "group": "Cm_Hopper_History",
6958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6960 "filename": "server/api/cmHopperHistory/index.js",
6961 "groupTitle": "Cm_Hopper_History"
6965 "url": "/api/cm/hopper/{id}",
6966 "title": "Delete Hopper",
6969 "title": "Example usage:",
6970 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
6975 "group": "Cm_Hopper",
6976 "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>",
6978 "filename": "server/api/cmHopper/index.js",
6979 "groupTitle": "Cm_Hopper"
6983 "url": "/api/cm/hopper/opencontacts",
6984 "title": "Gets Open Contacts",
6987 "title": "Example usage:",
6988 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
6992 "name": "getOpenContacts",
6993 "group": "Cm_Hopper",
6994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6996 "filename": "server/api/cmHopper/index.js",
6997 "groupTitle": "Cm_Hopper"
7001 "url": "/api/cm/hopper/preview",
7002 "title": "Gets Preview Dialer Contacts",
7005 "title": "Example usage:",
7006 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7010 "name": "getPreview",
7011 "group": "Cm_Hopper",
7012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7014 "filename": "server/api/cmHopper/index.js",
7015 "groupTitle": "Cm_Hopper"
7019 "url": "/api/cm/hopper/{id}",
7020 "title": "Update an existing Hopper",
7023 "title": "Example usage:",
7024 "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",
7028 "name": "updateHopper",
7029 "group": "Cm_Hopper",
7030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7032 "filename": "server/api/cmHopper/index.js",
7033 "groupTitle": "Cm_Hopper"
7037 "url": "/api/cm/lists",
7038 "title": "Creates a new List",
7041 "title": "Example usage:",
7042 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7046 "name": "CreateLists",
7047 "group": "Cm_Lists",
7062 "field": "description",
7069 "field": "dialPrefix",
7075 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7077 "filename": "server/api/cmList/index.js",
7078 "groupTitle": "Cm_Lists"
7082 "url": "/api/cm/lists/{id}",
7083 "title": "Deletes a List",
7086 "title": "Example usage:",
7087 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7091 "name": "DeleteLists",
7092 "group": "Cm_Lists",
7093 "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>",
7095 "filename": "server/api/cmList/index.js",
7096 "groupTitle": "Cm_Lists"
7100 "url": "/api/cm/lists/describe",
7101 "title": "Gets table info about Lists",
7104 "title": "Example usage:",
7105 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7109 "name": "DescribeLists",
7110 "group": "Cm_Lists",
7111 "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>",
7113 "filename": "server/api/cmList/index.js",
7114 "groupTitle": "Cm_Lists"
7118 "url": "/api/cm/lists/{id}/users",
7119 "title": "Gets agents from list",
7122 "title": "Example usage:",
7123 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7127 "name": "GetAgents",
7128 "group": "Cm_Lists",
7129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7131 "filename": "server/api/cmList/index.js",
7132 "groupTitle": "Cm_Lists"
7136 "url": "/api/cm/lists",
7137 "title": "Gets a list of Lists",
7140 "title": "Example usage:",
7141 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7146 "group": "Cm_Lists",
7147 "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>",
7149 "filename": "server/api/cmList/index.js",
7150 "groupTitle": "Cm_Lists"
7154 "url": "/api/cm/lists/{id}/users",
7155 "title": "Removes agents from a list",
7158 "title": "Example usage:",
7159 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7163 "name": "RemoveAgents",
7164 "group": "Cm_Lists",
7165 "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>",
7167 "filename": "server/api/cmList/index.js",
7168 "groupTitle": "Cm_Lists"
7172 "url": "/api/cm/lists/{id}/dispositions",
7173 "title": "Removes dispositions from account",
7176 "title": "Example usage:",
7177 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7181 "name": "RemoveDispositions",
7182 "group": "Cm_Lists",
7183 "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>",
7185 "filename": "server/api/cmList/index.js",
7186 "groupTitle": "Cm_Lists"
7190 "url": "/api/cm/lists/{id}",
7191 "title": "Gets a single List",
7194 "title": "Example usage:",
7195 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7199 "name": "ShowLists",
7200 "group": "Cm_Lists",
7201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7203 "filename": "server/api/cmList/index.js",
7204 "groupTitle": "Cm_Lists"
7208 "url": "/api/cm/lists/{id}/users",
7209 "title": "Adds agents to a list",
7212 "title": "Example usage:",
7213 "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",
7217 "name": "addAgents",
7218 "group": "Cm_Lists",
7219 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7221 "filename": "server/api/cmList/index.js",
7222 "groupTitle": "Cm_Lists"
7226 "url": "/api/cm/lists/{id}/contacts",
7227 "title": "Creates new contacts",
7230 "title": "Example usage:",
7231 "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",
7235 "name": "addContacts",
7236 "group": "Cm_Lists",
7244 "field": "firstName",
7251 "field": "lastName",
7265 "field": "postalCode",
7286 "field": "dateOfBirth",
7293 "field": "description",
7335 "field": "facebook",
7391 "field": "telegram",
7405 "field": "priority",
7412 "field": "scheduledat",
7418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7420 "filename": "server/api/cmList/index.js",
7421 "groupTitle": "Cm_Lists"
7425 "url": "/api/cm/lists/{id}/fields",
7426 "title": "Creates a new custom field",
7429 "title": "Example usage:",
7430 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7434 "name": "addCustomField",
7435 "group": "Cm_Lists",
7436 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7438 "filename": "server/api/cmList/index.js",
7439 "groupTitle": "Cm_Lists"
7443 "url": "/api/cm/lists/{id}/dispositions",
7444 "title": "Creates new disposition",
7447 "title": "Example usage:",
7448 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7452 "name": "addDisposition",
7453 "group": "Cm_Lists",
7467 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7469 "filename": "server/api/cmList/index.js",
7470 "groupTitle": "Cm_Lists"
7474 "url": "/api/cm/lists/{id}/contacts",
7475 "title": "Gets List Contacts",
7478 "title": "Example usage:",
7479 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7483 "name": "getContacts",
7484 "group": "Cm_Lists",
7485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7487 "filename": "server/api/cmList/index.js",
7488 "groupTitle": "Cm_Lists"
7492 "url": "/api/cm/lists/{id}/fields",
7493 "title": "Gets Custom Fields",
7496 "title": "Example usage:",
7497 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7501 "name": "getCustomFields",
7502 "group": "Cm_Lists",
7503 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7505 "filename": "server/api/cmList/index.js",
7506 "groupTitle": "Cm_Lists"
7510 "url": "/api/cm/lists/{id}/dispositions",
7511 "title": "Gets list dispositions",
7514 "title": "Example usage:",
7515 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7519 "name": "getDispositions",
7520 "group": "Cm_Lists",
7521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7523 "filename": "server/api/cmList/index.js",
7524 "groupTitle": "Cm_Lists"
7528 "url": "/api/cm/lists/{id}/contacts/csv",
7529 "title": "Gets CSV List Contacts",
7532 "title": "Example usage:",
7533 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7538 "group": "Cm_Lists",
7539 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7541 "filename": "server/api/cmList/index.js",
7542 "groupTitle": "Cm_Lists"
7546 "url": "/api/cm/lists/{id}",
7547 "title": "Update an existing List",
7550 "title": "Example usage:",
7551 "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",
7555 "name": "updateLists",
7556 "group": "Cm_Lists",
7557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7559 "filename": "server/api/cmList/index.js",
7560 "groupTitle": "Cm_Lists"
7564 "url": "/api/cm/contacts/upload/:id",
7565 "title": "Import new contacts by csv",
7568 "title": "Example usage:",
7569 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7574 "group": "Cm_contacts",
7575 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7577 "filename": "server/api/cmContact/index.js",
7578 "groupTitle": "Cm_contacts"
7582 "url": "/api/cm/contacts/upload",
7583 "title": "Upload csv",
7586 "title": "Example usage:",
7587 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7592 "group": "Cm_contacts",
7593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7595 "filename": "server/api/cmContact/index.js",
7596 "groupTitle": "Cm_contacts"
7600 "url": "/api/cm/contacts/csv",
7601 "title": "Create new contacts by csv",
7604 "title": "Example usage:",
7605 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7609 "name": "uploadCsv",
7610 "group": "Cm_contacts",
7611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7613 "filename": "server/api/cmContact/index.js",
7614 "groupTitle": "Cm_contacts"
7618 "url": "/api/conditions/{id}",
7619 "title": "Deletes a Condition",
7622 "title": "Example usage:",
7623 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7627 "name": "DeleteConditions",
7628 "group": "Conditions",
7629 "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>",
7631 "filename": "server/api/condition/index.js",
7632 "groupTitle": "Conditions"
7636 "url": "/api/conditions/{id}",
7637 "title": "Update an existing Condition",
7640 "title": "Example usage:",
7641 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7645 "name": "updateConditions",
7646 "group": "Conditions",
7647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7649 "filename": "server/api/condition/index.js",
7650 "groupTitle": "Conditions"
7654 "url": "/api/cm/custom_field",
7655 "title": "Create a new custom field",
7658 "title": "Example usage:",
7659 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7663 "name": "CreateCustomField",
7664 "group": "Custom_Fields",
7665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7667 "filename": "server/api/cmCustomField/index.js",
7668 "groupTitle": "Custom_Fields"
7672 "url": "/api/dashboards/items",
7673 "title": "Create dasboard item",
7676 "title": "Example usage:",
7677 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7682 "group": "Dashboard_Items",
7683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7685 "filename": "server/api/dashboardItem/index.js",
7686 "groupTitle": "Dashboard_Items"
7690 "url": "/api/dashboards/items/{id}",
7691 "title": "Deletes a Dashboard Item",
7694 "title": "Example usage:",
7695 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7699 "name": "DeleteDashboard_Items",
7700 "group": "Dashboard_Items",
7701 "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>",
7703 "filename": "server/api/dashboardItem/index.js",
7704 "groupTitle": "Dashboard_Items"
7708 "url": "/api/dashboards/items/{id}",
7709 "title": "Gets a single Dashboard Item",
7712 "title": "Example usage:",
7713 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7717 "name": "ShowDashboard_Items",
7718 "group": "Dashboard_Items",
7719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7721 "filename": "server/api/dashboardItem/index.js",
7722 "groupTitle": "Dashboard_Items"
7726 "url": "/api/dashboards/items/{id}",
7727 "title": "Update an existing item",
7730 "title": "Example usage:",
7731 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7736 "group": "Dashboard_Items",
7737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7739 "filename": "server/api/dashboardItem/index.js",
7740 "groupTitle": "Dashboard_Items"
7744 "url": "/api/dashboards/clone",
7745 "title": "Clone an existing Dashboard",
7748 "title": "Example usage:",
7749 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7753 "name": "CloneDashboards",
7754 "group": "Dashboards",
7755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7757 "filename": "server/api/dashboard/index.js",
7758 "groupTitle": "Dashboards"
7762 "url": "/api/dashboards",
7763 "title": "Creates a new Dashboard",
7766 "title": "Example usage:",
7767 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7771 "name": "CreateDashboards",
7772 "group": "Dashboards",
7787 "field": "description",
7793 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7795 "filename": "server/api/dashboard/index.js",
7796 "groupTitle": "Dashboards"
7800 "url": "/api/dashboards/{id}",
7801 "title": "Deletes a Dashboard",
7804 "title": "Example usage:",
7805 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7809 "name": "DeleteDashboards",
7810 "group": "Dashboards",
7811 "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>",
7813 "filename": "server/api/dashboard/index.js",
7814 "groupTitle": "Dashboards"
7818 "url": "/api/dashboards",
7819 "title": "Gets a list of Dashboards",
7822 "title": "Example usage:",
7823 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7827 "name": "GetDashboards",
7828 "group": "Dashboards",
7829 "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>",
7831 "filename": "server/api/dashboard/index.js",
7832 "groupTitle": "Dashboards"
7836 "url": "/api/dashboards/{id}",
7837 "title": "Gets a single Dashboard",
7840 "title": "Example usage:",
7841 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
7845 "name": "ShowDashboards",
7846 "group": "Dashboards",
7847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7849 "filename": "server/api/dashboard/index.js",
7850 "groupTitle": "Dashboards"
7854 "url": "/api/dashboards/{id}/items",
7855 "title": "Creates new item",
7858 "title": "Example usage:",
7859 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7864 "group": "Dashboards",
7865 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7867 "filename": "server/api/dashboard/index.js",
7868 "groupTitle": "Dashboards"
7872 "url": "/api/dashboards/{id}/items",
7873 "title": "Gets items",
7876 "title": "Example usage:",
7877 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
7882 "group": "Dashboards",
7883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7885 "filename": "server/api/dashboard/index.js",
7886 "groupTitle": "Dashboards"
7890 "url": "/api/dashboards/{id}",
7891 "title": "Update an existing Dashboard",
7894 "title": "Example usage:",
7895 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7899 "name": "updateDashboards",
7900 "group": "Dashboards",
7901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7903 "filename": "server/api/dashboard/index.js",
7904 "groupTitle": "Dashboards"
7908 "url": "/api/integrations/desk/accounts",
7909 "title": "Creates a new Desk Account",
7912 "title": "Example usage:",
7913 "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",
7917 "name": "CreateDesk_Accounts",
7918 "group": "Desk_Accounts",
7933 "field": "description",
7940 "field": "username",
7947 "field": "remoteUri",
7957 "field": "authType",
7964 "field": "password",
7971 "field": "consumerKey",
7978 "field": "consumerSecret",
7992 "field": "tokenSecret",
7999 "field": "serverUrl",
8006 "\"integrationTab\"",
8016 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8018 "filename": "server/api/intDeskAccount/index.js",
8019 "groupTitle": "Desk_Accounts"
8023 "url": "/api/integrations/desk/accounts/{id}",
8024 "title": "Deletes a Desk Account",
8027 "title": "Example usage:",
8028 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8032 "name": "DeleteDesk_Accounts",
8033 "group": "Desk_Accounts",
8034 "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>",
8036 "filename": "server/api/intDeskAccount/index.js",
8037 "groupTitle": "Desk_Accounts"
8041 "url": "/api/integrations/desk/accounts",
8042 "title": "Gets a list of Desk Accounts",
8045 "title": "Example usage:",
8046 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8050 "name": "GetDesk_Accounts",
8051 "group": "Desk_Accounts",
8052 "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>",
8054 "filename": "server/api/intDeskAccount/index.js",
8055 "groupTitle": "Desk_Accounts"
8059 "url": "/api/integrations/desk/accounts/{id}",
8060 "title": "Gets a single Desk Account",
8063 "title": "Example usage:",
8064 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8068 "name": "ShowDesk_Accounts",
8069 "group": "Desk_Accounts",
8070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8072 "filename": "server/api/intDeskAccount/index.js",
8073 "groupTitle": "Desk_Accounts"
8077 "url": "/api/integrations/desk/accounts/{id}/configurations",
8078 "title": "Creates new configuration",
8081 "title": "Example usage:",
8082 "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",
8086 "name": "addConfiguration",
8087 "group": "Desk_Accounts",
8088 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8090 "filename": "server/api/intDeskAccount/index.js",
8091 "groupTitle": "Desk_Accounts"
8095 "url": "/api/integrations/desk/accounts/{id}/configurations",
8096 "title": "Gets account configurations",
8099 "title": "Example usage:",
8100 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8104 "name": "getConfigurations",
8105 "group": "Desk_Accounts",
8106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8108 "filename": "server/api/intDeskAccount/index.js",
8109 "groupTitle": "Desk_Accounts"
8113 "url": "/api/integrations/desk/accounts/{id}/fields",
8114 "title": "Gets account fields",
8117 "title": "Example usage:",
8118 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8122 "name": "getFields",
8123 "group": "Desk_Accounts",
8124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8126 "filename": "server/api/intDeskAccount/index.js",
8127 "groupTitle": "Desk_Accounts"
8131 "url": "/api/integrations/desk/accounts/{id}",
8132 "title": "Update an existing Desk Account",
8135 "title": "Example usage:",
8136 "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",
8140 "name": "updateDesk_Accounts",
8141 "group": "Desk_Accounts",
8142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8144 "filename": "server/api/intDeskAccount/index.js",
8145 "groupTitle": "Desk_Accounts"
8149 "url": "/api/integrations/desk/configurations",
8150 "title": "Creates a new Desk Configuration",
8153 "title": "Example usage:",
8154 "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",
8158 "name": "CreateDesk_Configurations",
8159 "group": "Desk_Configurations",
8174 "field": "description",
8180 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8182 "filename": "server/api/intDeskConfiguration/index.js",
8183 "groupTitle": "Desk_Configurations"
8187 "url": "/api/integrations/desk/configurations/{id}",
8188 "title": "Deletes a Desk Configuration",
8191 "title": "Example usage:",
8192 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8196 "name": "DeleteDesk_Configurations",
8197 "group": "Desk_Configurations",
8198 "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>",
8200 "filename": "server/api/intDeskConfiguration/index.js",
8201 "groupTitle": "Desk_Configurations"
8205 "url": "/api/integrations/desk/configurations",
8206 "title": "Gets a list of Desk Configurations",
8209 "title": "Example usage:",
8210 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8214 "name": "GetDesk_Configurations",
8215 "group": "Desk_Configurations",
8216 "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>",
8218 "filename": "server/api/intDeskConfiguration/index.js",
8219 "groupTitle": "Desk_Configurations"
8223 "url": "/api/integrations/desk/configurations/{id}",
8224 "title": "Gets a single Desk Configuration",
8227 "title": "Example usage:",
8228 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8232 "name": "ShowDesk_Configurations",
8233 "group": "Desk_Configurations",
8234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8236 "filename": "server/api/intDeskConfiguration/index.js",
8237 "groupTitle": "Desk_Configurations"
8241 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8242 "title": "Gets configurations descriptions",
8245 "title": "Example usage:",
8246 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8250 "name": "getDescriptions",
8251 "group": "Desk_Configurations",
8252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8254 "filename": "server/api/intDeskConfiguration/index.js",
8255 "groupTitle": "Desk_Configurations"
8259 "url": "/api/integrations/desk/configurations/{id}/fields",
8260 "title": "Gets configurations fields",
8263 "title": "Example usage:",
8264 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8268 "name": "getFields",
8269 "group": "Desk_Configurations",
8270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8272 "filename": "server/api/intDeskConfiguration/index.js",
8273 "groupTitle": "Desk_Configurations"
8277 "url": "/api/integrations/desk/configurations/{id}/subjects",
8278 "title": "Gets configurations subjects",
8281 "title": "Example usage:",
8282 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8286 "name": "getSubjects",
8287 "group": "Desk_Configurations",
8288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8290 "filename": "server/api/intDeskConfiguration/index.js",
8291 "groupTitle": "Desk_Configurations"
8295 "url": "/api/integrations/desk/configurations/{id}/tags",
8296 "title": "Gets configurations tags",
8299 "title": "Example usage:",
8300 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8305 "group": "Desk_Configurations",
8306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8308 "filename": "server/api/intDeskConfiguration/index.js",
8309 "groupTitle": "Desk_Configurations"
8313 "url": "/api/integrations/desk/configurations/{id}/tags",
8314 "title": "Sets new tags",
8317 "title": "Example usage:",
8318 "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",
8323 "group": "Desk_Configurations",
8324 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8326 "filename": "server/api/intDeskConfiguration/index.js",
8327 "groupTitle": "Desk_Configurations"
8331 "url": "/api/integrations/desk/configurations/{id}",
8332 "title": "Update an existing Desk Configuration",
8335 "title": "Example usage:",
8336 "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",
8340 "name": "updateDesk_Configurations",
8341 "group": "Desk_Configurations",
8342 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8344 "filename": "server/api/intDeskConfiguration/index.js",
8345 "groupTitle": "Desk_Configurations"
8349 "url": "/api/integrations/desk/fields",
8350 "title": "Creates a new Desk Field",
8353 "title": "Example usage:",
8354 "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",
8358 "name": "CreateDesk_Fields",
8359 "group": "Desk_Fields",
8369 "\"customVariable\"",
8396 "\"customVariable\""
8406 "field": "keyContent",
8420 "field": "nameField",
8427 "field": "customField",
8434 "field": "variableName",
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": "server/api/intDeskField/index.js",
8443 "groupTitle": "Desk_Fields"
8447 "url": "/api/integrations/desk/fields/{id}",
8448 "title": "Deletes a Desk Field",
8451 "title": "Example usage:",
8452 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8456 "name": "DeleteDesk_Fields",
8457 "group": "Desk_Fields",
8458 "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>",
8460 "filename": "server/api/intDeskField/index.js",
8461 "groupTitle": "Desk_Fields"
8465 "url": "/api/integrations/desk/fields",
8466 "title": "Gets a list of Desk Fields",
8469 "title": "Example usage:",
8470 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8474 "name": "GetDesk_Fields",
8475 "group": "Desk_Fields",
8476 "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>",
8478 "filename": "server/api/intDeskField/index.js",
8479 "groupTitle": "Desk_Fields"
8483 "url": "/api/integrations/desk/fields/{id}",
8484 "title": "Gets a single Desk Field",
8487 "title": "Example usage:",
8488 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8492 "name": "ShowDesk_Fields",
8493 "group": "Desk_Fields",
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": "server/api/intDeskField/index.js",
8497 "groupTitle": "Desk_Fields"
8501 "url": "/api/integrations/desk/fields/{id}",
8502 "title": "Update an existing Desk Field",
8505 "title": "Example usage:",
8506 "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",
8510 "name": "updateDesk_Fields",
8511 "group": "Desk_Fields",
8512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8514 "filename": "server/api/intDeskField/index.js",
8515 "groupTitle": "Desk_Fields"
8519 "url": "/api/dispositions",
8520 "title": "Creates a new Disposition",
8523 "title": "Example usage:",
8524 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8528 "name": "CreateDispositions",
8529 "group": "Dispositions",
8543 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8545 "filename": "server/api/disposition/index.js",
8546 "groupTitle": "Dispositions"
8550 "url": "/api/dispositions/{id}",
8551 "title": "Deletes a Disposition",
8554 "title": "Example usage:",
8555 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8559 "name": "DeleteDispositions",
8560 "group": "Dispositions",
8561 "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>",
8563 "filename": "server/api/disposition/index.js",
8564 "groupTitle": "Dispositions"
8568 "url": "/api/dispositions",
8569 "title": "Gets a list of Dispositions",
8572 "title": "Example usage:",
8573 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8577 "name": "GetDispositions",
8578 "group": "Dispositions",
8579 "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>",
8581 "filename": "server/api/disposition/index.js",
8582 "groupTitle": "Dispositions"
8586 "url": "/api/dispositions/{id}",
8587 "title": "Gets a single Disposition",
8590 "title": "Example usage:",
8591 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8595 "name": "ShowDispositions",
8596 "group": "Dispositions",
8597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8599 "filename": "server/api/disposition/index.js",
8600 "groupTitle": "Dispositions"
8604 "url": "/api/dispositions/{id}",
8605 "title": "Update an existing Disposition",
8608 "title": "Example usage:",
8609 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8613 "name": "updateDispositions",
8614 "group": "Dispositions",
8615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8617 "filename": "server/api/disposition/index.js",
8618 "groupTitle": "Dispositions"
8622 "url": "/api/integrations/dynamics365/accounts",
8623 "title": "Creates a new Dynamics365 Account",
8626 "title": "Example usage:",
8627 "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",
8631 "name": "CreateDynamics365_Accounts",
8632 "group": "Dynamics365_Accounts",
8647 "field": "username",
8654 "field": "password",
8661 "field": "remoteUri",
8668 "field": "tenantId",
8675 "field": "clientId",
8682 "field": "clientSecret",
8689 "field": "serverUrl",
8696 "field": "description",
8702 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8704 "filename": "server/api/intDynamics365Account/index.js",
8705 "groupTitle": "Dynamics365_Accounts"
8709 "url": "/api/integrations/dynamics365/accounts/{id}",
8710 "title": "Deletes a Dynamics365 Account",
8713 "title": "Example usage:",
8714 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8718 "name": "DeleteDynamics365_Accounts",
8719 "group": "Dynamics365_Accounts",
8720 "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>",
8722 "filename": "server/api/intDynamics365Account/index.js",
8723 "groupTitle": "Dynamics365_Accounts"
8727 "url": "/api/integrations/dynamics365/accounts",
8728 "title": "Gets a list of Dynamics365 Accounts",
8731 "title": "Example usage:",
8732 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8736 "name": "GetDynamics365_Accounts",
8737 "group": "Dynamics365_Accounts",
8738 "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>",
8740 "filename": "server/api/intDynamics365Account/index.js",
8741 "groupTitle": "Dynamics365_Accounts"
8745 "url": "/api/integrations/dynamics365/accounts/{id}",
8746 "title": "Gets a single Dynamics365 Account",
8749 "title": "Example usage:",
8750 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8754 "name": "ShowDynamics365_Accounts",
8755 "group": "Dynamics365_Accounts",
8756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8758 "filename": "server/api/intDynamics365Account/index.js",
8759 "groupTitle": "Dynamics365_Accounts"
8763 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8764 "title": "Creates new configuration",
8767 "title": "Example usage:",
8768 "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",
8772 "name": "addConfiguration",
8773 "group": "Dynamics365_Accounts",
8774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8776 "filename": "server/api/intDynamics365Account/index.js",
8777 "groupTitle": "Dynamics365_Accounts"
8781 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8782 "title": "Gets account configurations",
8785 "title": "Example usage:",
8786 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8790 "name": "getConfigurations",
8791 "group": "Dynamics365_Accounts",
8792 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8794 "filename": "server/api/intDynamics365Account/index.js",
8795 "groupTitle": "Dynamics365_Accounts"
8799 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8800 "title": "Gets account fields",
8803 "title": "Example usage:",
8804 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8808 "name": "getFields",
8809 "group": "Dynamics365_Accounts",
8810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8812 "filename": "server/api/intDynamics365Account/index.js",
8813 "groupTitle": "Dynamics365_Accounts"
8817 "url": "/api/integrations/dynamics365/accounts/{id}",
8818 "title": "Update an existing Dynamics365 Account",
8821 "title": "Example usage:",
8822 "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",
8826 "name": "updateDynamics365_Accounts",
8827 "group": "Dynamics365_Accounts",
8828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8830 "filename": "server/api/intDynamics365Account/index.js",
8831 "groupTitle": "Dynamics365_Accounts"
8835 "url": "/api/integrations/dynamics365/configurations",
8836 "title": "Creates a new Dynamics365 Configuration",
8839 "title": "Example usage:",
8840 "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",
8844 "name": "CreateDynamics365_Configurations",
8845 "group": "Dynamics365_Configurations",
8860 "field": "description",
8871 "field": "ticketType",
8877 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8879 "filename": "server/api/intDynamics365Configuration/index.js",
8880 "groupTitle": "Dynamics365_Configurations"
8884 "url": "/api/integrations/dynamics365/configurations/{id}",
8885 "title": "Deletes a Dynamics365 Configuration",
8888 "title": "Example usage:",
8889 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
8893 "name": "DeleteDynamics365_Configurations",
8894 "group": "Dynamics365_Configurations",
8895 "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>",
8897 "filename": "server/api/intDynamics365Configuration/index.js",
8898 "groupTitle": "Dynamics365_Configurations"
8902 "url": "/api/integrations/dynamics365/configurations",
8903 "title": "Gets a list of Dynamics365 Configurations",
8906 "title": "Example usage:",
8907 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
8911 "name": "GetDynamics365_Configurations",
8912 "group": "Dynamics365_Configurations",
8913 "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>",
8915 "filename": "server/api/intDynamics365Configuration/index.js",
8916 "groupTitle": "Dynamics365_Configurations"
8920 "url": "/api/integrations/dynamics365/configurations/{id}",
8921 "title": "Gets a single Dynamics365 Configuration",
8924 "title": "Example usage:",
8925 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
8929 "name": "ShowDynamics365_Configurations",
8930 "group": "Dynamics365_Configurations",
8931 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8933 "filename": "server/api/intDynamics365Configuration/index.js",
8934 "groupTitle": "Dynamics365_Configurations"
8938 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
8939 "title": "Gets configurations descriptions",
8942 "title": "Example usage:",
8943 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8947 "name": "getDescriptions",
8948 "group": "Dynamics365_Configurations",
8949 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8951 "filename": "server/api/intDynamics365Configuration/index.js",
8952 "groupTitle": "Dynamics365_Configurations"
8956 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
8957 "title": "Gets configurations fields",
8960 "title": "Example usage:",
8961 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
8965 "name": "getFields",
8966 "group": "Dynamics365_Configurations",
8967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8969 "filename": "server/api/intDynamics365Configuration/index.js",
8970 "groupTitle": "Dynamics365_Configurations"
8974 "url": "/api/integrations/zoho/configurations/{id}/subjects",
8975 "title": "Gets configurations subjects",
8978 "title": "Example usage:",
8979 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8983 "name": "getSubjects",
8984 "group": "Dynamics365_Configurations",
8985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8987 "filename": "server/api/intDynamics365Configuration/index.js",
8988 "groupTitle": "Dynamics365_Configurations"
8992 "url": "/api/integrations/dynamics365/configurations/{id}",
8993 "title": "Update an existing Dynamics365 Configuration",
8996 "title": "Example usage:",
8997 "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",
9001 "name": "updateDynamics365_Configurations",
9002 "group": "Dynamics365_Configurations",
9003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9005 "filename": "server/api/intDynamics365Configuration/index.js",
9006 "groupTitle": "Dynamics365_Configurations"
9010 "url": "/api/integrations/dynamics365/fields",
9011 "title": "Creates a new Dynamics365 Field",
9014 "title": "Example usage:",
9015 "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",
9019 "name": "CreateDynamics365_Fields",
9020 "group": "Dynamics365_Fields",
9030 "\"customVariable\"",
9057 "\"customVariable\""
9067 "field": "keyContent",
9081 "field": "nameField",
9088 "field": "customField",
9095 "field": "variableName",
9101 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9103 "filename": "server/api/intDynamics365Field/index.js",
9104 "groupTitle": "Dynamics365_Fields"
9108 "url": "/api/integrations/dynamics365/fields/{id}",
9109 "title": "Deletes a Dynamics365 Field",
9112 "title": "Example usage:",
9113 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9117 "name": "DeleteDynamics365_Fields",
9118 "group": "Dynamics365_Fields",
9119 "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>",
9121 "filename": "server/api/intDynamics365Field/index.js",
9122 "groupTitle": "Dynamics365_Fields"
9126 "url": "/api/integrations/dynamics365/fields",
9127 "title": "Gets a list of Dynamics365 Fields",
9130 "title": "Example usage:",
9131 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9135 "name": "GetDynamics365_Fields",
9136 "group": "Dynamics365_Fields",
9137 "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>",
9139 "filename": "server/api/intDynamics365Field/index.js",
9140 "groupTitle": "Dynamics365_Fields"
9144 "url": "/api/integrations/dynamics365/fields/{id}",
9145 "title": "Gets a single Dynamics365 Field",
9148 "title": "Example usage:",
9149 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9153 "name": "ShowDynamics365_Fields",
9154 "group": "Dynamics365_Fields",
9155 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9157 "filename": "server/api/intDynamics365Field/index.js",
9158 "groupTitle": "Dynamics365_Fields"
9162 "url": "/api/integrations/dynamics365/fields/{id}",
9163 "title": "Update an existing Dynamics365 Field",
9166 "title": "Example usage:",
9167 "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",
9171 "name": "updateDynamics365_Fields",
9172 "group": "Dynamics365_Fields",
9173 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9175 "filename": "server/api/intDynamics365Field/index.js",
9176 "groupTitle": "Dynamics365_Fields"
9180 "url": "/api/fax/accounts/{id}/users",
9181 "title": "Add agents to a fax account",
9184 "title": "Example usage:",
9185 "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",
9189 "name": "AddAgents",
9190 "group": "Fax_Accounts",
9191 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9193 "filename": "server/api/faxAccount/index.js",
9194 "groupTitle": "Fax_Accounts"
9198 "url": "/api/fax/accounts",
9199 "title": "Creates a new Account",
9202 "title": "Example usage:",
9203 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9207 "name": "CreateAccounts",
9208 "group": "Fax_Accounts",
9223 "field": "description",
9241 "field": "headerinfo",
9248 "field": "localstationid",
9299 "field": "faxdetect",
9306 "field": "t38timeout",
9333 "field": "notificationTemplate",
9340 "field": "notificationSound",
9347 "field": "notificationShake",
9354 "field": "waitForTheAssignedAgent",
9361 "field": "queueTransfer",
9368 "field": "queueTransferTimeout",
9375 "field": "agentTransfer",
9382 "field": "agentTransferTimeout",
9389 "field": "mandatoryDispositionPauseId",
9390 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9396 "field": "mandatoryDisposition",
9397 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9402 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9404 "filename": "server/api/faxAccount/index.js",
9405 "groupTitle": "Fax_Accounts"
9409 "url": "/api/fax/accounts/{id}",
9410 "title": "Deletes a Account",
9413 "title": "Example usage:",
9414 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9418 "name": "DeleteAccounts",
9419 "group": "Fax_Accounts",
9420 "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>",
9422 "filename": "server/api/faxAccount/index.js",
9423 "groupTitle": "Fax_Accounts"
9427 "url": "/api/fax/accounts/describe",
9428 "title": "Gets table info about Accounts",
9431 "title": "Example usage:",
9432 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9436 "name": "DescribeAccounts",
9437 "group": "Fax_Accounts",
9438 "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>",
9440 "filename": "server/api/faxAccount/index.js",
9441 "groupTitle": "Fax_Accounts"
9445 "url": "/api/fax/accounts",
9446 "title": "Gets a list of Accounts",
9449 "title": "Example usage:",
9450 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9454 "name": "GetAccounts",
9455 "group": "Fax_Accounts",
9456 "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>",
9458 "filename": "server/api/faxAccount/index.js",
9459 "groupTitle": "Fax_Accounts"
9463 "url": "/api/fax/accounts/{id}/users",
9464 "title": "Gets agents from fax account",
9467 "title": "Example usage:",
9468 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9472 "name": "GetAgents",
9473 "group": "Fax_Accounts",
9474 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9476 "filename": "server/api/faxAccount/index.js",
9477 "groupTitle": "Fax_Accounts"
9481 "url": "/api/fax/accounts/{id}/users",
9482 "title": "Removes agents from a fax account",
9485 "title": "Example usage:",
9486 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9490 "name": "RemoveAgents",
9491 "group": "Fax_Accounts",
9492 "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>",
9494 "filename": "server/api/faxAccount/index.js",
9495 "groupTitle": "Fax_Accounts"
9499 "url": "/api/fax/accounts/{id}/canned_answers",
9500 "title": "Removes canned answers from account",
9503 "title": "Example usage:",
9504 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9508 "name": "RemoveAnswers",
9509 "group": "Fax_Accounts",
9510 "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>",
9512 "filename": "server/api/faxAccount/index.js",
9513 "groupTitle": "Fax_Accounts"
9517 "url": "/api/fax/accounts/{id}/dispositions",
9518 "title": "Removes dispositions from account",
9521 "title": "Example usage:",
9522 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9526 "name": "RemoveDispositions",
9527 "group": "Fax_Accounts",
9528 "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>",
9530 "filename": "server/api/faxAccount/index.js",
9531 "groupTitle": "Fax_Accounts"
9535 "url": "/api/fax/accounts/{id}",
9536 "title": "Gets a single Account",
9539 "title": "Example usage:",
9540 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9544 "name": "ShowAccounts",
9545 "group": "Fax_Accounts",
9546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9548 "filename": "server/api/faxAccount/index.js",
9549 "groupTitle": "Fax_Accounts"
9553 "url": "/api/fax/accounts/{id}/canned_answers",
9554 "title": "Creates new canned answer",
9557 "title": "Example usage:",
9558 "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",
9562 "name": "addAnswer",
9563 "group": "Fax_Accounts",
9585 "field": "description",
9598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9600 "filename": "server/api/faxAccount/index.js",
9601 "groupTitle": "Fax_Accounts"
9605 "url": "/api/fax/accounts/addaccountapplications",
9606 "title": "Creates new account and applications",
9609 "title": "Example usage:",
9610 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9614 "name": "addApplications",
9615 "group": "Fax_Accounts",
9623 "field": "priority",
9644 "field": "description",
9651 "field": "interval",
9657 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9659 "filename": "server/api/faxAccount/index.js",
9660 "groupTitle": "Fax_Accounts"
9664 "url": "/api/fax/accounts/{id}/applications",
9665 "title": "Creates new applications",
9668 "title": "Example usage:",
9669 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9673 "name": "addApplications",
9674 "group": "Fax_Accounts",
9682 "field": "priority",
9703 "field": "description",
9710 "field": "interval",
9716 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9718 "filename": "server/api/faxAccount/index.js",
9719 "groupTitle": "Fax_Accounts"
9723 "url": "/api/fax/accounts/{id}/dispositions",
9724 "title": "Creates new disposition",
9727 "title": "Example usage:",
9728 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9732 "name": "addDisposition",
9733 "group": "Fax_Accounts",
9747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9749 "filename": "server/api/faxAccount/index.js",
9750 "groupTitle": "Fax_Accounts"
9754 "url": "/api/fax/accounts/{id}/interactions",
9755 "title": "Creates new interactions",
9758 "title": "Example usage:",
9759 "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",
9763 "name": "addInteraction",
9764 "group": "Fax_Accounts",
9779 "field": "closedAt",
9786 "field": "disposition",
9800 "field": "read1stAt",
9818 "field": "firstMsgDirection",
9825 "field": "lastMsgAt",
9836 "field": "lastMsgDirection",
9842 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9844 "filename": "server/api/faxAccount/index.js",
9845 "groupTitle": "Fax_Accounts"
9849 "url": "/api/fax/accounts/{id}/canned_answers",
9850 "title": "Gets account canned answers",
9853 "title": "Example usage:",
9854 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
9858 "name": "getAnswers",
9859 "group": "Fax_Accounts",
9860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9862 "filename": "server/api/faxAccount/index.js",
9863 "groupTitle": "Fax_Accounts"
9867 "url": "/api/fax/accounts/{id}/applications",
9868 "title": "Gets account pplications",
9871 "title": "Example usage:",
9872 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
9876 "name": "getApplications",
9877 "group": "Fax_Accounts",
9878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9880 "filename": "server/api/faxAccount/index.js",
9881 "groupTitle": "Fax_Accounts"
9885 "url": "/api/fax/accounts/{id}/dispositions",
9886 "title": "Gets account dispositions",
9889 "title": "Example usage:",
9890 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
9894 "name": "getDispositions",
9895 "group": "Fax_Accounts",
9896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9898 "filename": "server/api/faxAccount/index.js",
9899 "groupTitle": "Fax_Accounts"
9903 "url": "/api/fax/accounts/{id}/interactions",
9904 "title": "Gets account interactions",
9907 "title": "Example usage:",
9908 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
9912 "name": "getInteraction",
9913 "group": "Fax_Accounts",
9914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9916 "filename": "server/api/faxAccount/index.js",
9917 "groupTitle": "Fax_Accounts"
9921 "url": "/api/fax/accounts/{id}/messages",
9922 "title": "Gets account messages",
9925 "title": "Example usage:",
9926 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
9930 "name": "getMessages",
9931 "group": "Fax_Accounts",
9932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9934 "filename": "server/api/faxAccount/index.js",
9935 "groupTitle": "Fax_Accounts"
9939 "url": "/api/fax/accounts/{id}/send",
9940 "title": "Send new fax",
9943 "title": "Example usage:",
9944 "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",
9949 "group": "Fax_Accounts",
9950 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9952 "filename": "server/api/faxAccount/index.js",
9953 "groupTitle": "Fax_Accounts"
9957 "url": "/api/fax/accounts/{id}",
9958 "title": "Update an existing Account",
9961 "title": "Example usage:",
9962 "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",
9966 "name": "updateAccounts",
9967 "group": "Fax_Accounts",
9968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9970 "filename": "server/api/faxAccount/index.js",
9971 "groupTitle": "Fax_Accounts"
9975 "url": "/api/fax/accounts/updateaccountapplications",
9976 "title": "Update account and applications",
9979 "title": "Example usage:",
9980 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9984 "name": "updateApplications",
9985 "group": "Fax_Accounts",
9993 "field": "priority",
10007 "field": "appdata",
10014 "field": "description",
10021 "field": "interval",
10027 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10028 "version": "0.0.0",
10029 "filename": "server/api/faxAccount/index.js",
10030 "groupTitle": "Fax_Accounts"
10034 "url": "/api/fax/applications",
10035 "title": "Creates a new Application",
10038 "title": "Example usage:",
10039 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10043 "name": "CreateApplications",
10044 "group": "Fax_Applications",
10052 "field": "priority",
10066 "field": "appdata",
10073 "field": "description",
10080 "field": "interval",
10086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10087 "version": "0.0.0",
10088 "filename": "server/api/faxApplication/index.js",
10089 "groupTitle": "Fax_Applications"
10093 "url": "/api/fax/applications/{id}",
10094 "title": "Deletes a Application",
10097 "title": "Example usage:",
10098 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10102 "name": "DeleteApplications",
10103 "group": "Fax_Applications",
10104 "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>",
10105 "version": "0.0.0",
10106 "filename": "server/api/faxApplication/index.js",
10107 "groupTitle": "Fax_Applications"
10111 "url": "/api/fax/applications",
10112 "title": "Gets a list of Applications",
10115 "title": "Example usage:",
10116 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10120 "name": "GetApplications",
10121 "group": "Fax_Applications",
10122 "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>",
10123 "version": "0.0.0",
10124 "filename": "server/api/faxApplication/index.js",
10125 "groupTitle": "Fax_Applications"
10129 "url": "/api/fax/applications/{id}",
10130 "title": "Gets a single Application",
10133 "title": "Example usage:",
10134 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10138 "name": "ShowApplications",
10139 "group": "Fax_Applications",
10140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10141 "version": "0.0.0",
10142 "filename": "server/api/faxApplication/index.js",
10143 "groupTitle": "Fax_Applications"
10147 "url": "/api/fax/applications/{id}",
10148 "title": "Update an existing Application",
10151 "title": "Example usage:",
10152 "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",
10156 "name": "updateApplications",
10157 "group": "Fax_Applications",
10158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10159 "version": "0.0.0",
10160 "filename": "server/api/faxApplication/index.js",
10161 "groupTitle": "Fax_Applications"
10165 "url": "/api/fax/interactions/{id}/tags",
10166 "title": "Add tags to the interaction",
10169 "title": "Example usage:",
10170 "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",
10175 "group": "Fax_Interactions",
10176 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10177 "version": "0.0.0",
10178 "filename": "server/api/faxInteraction/index.js",
10179 "groupTitle": "Fax_Interactions"
10183 "url": "/api/fax/interactions",
10184 "title": "Creates a new Interaction",
10187 "title": "Example usage:",
10188 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10192 "name": "CreateInteractions",
10193 "group": "Fax_Interactions",
10208 "field": "closedAt",
10215 "field": "disposition",
10229 "field": "read1stAt",
10247 "field": "firstMsgDirection",
10254 "field": "lastMsgAt",
10265 "field": "lastMsgDirection",
10271 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10272 "version": "0.0.0",
10273 "filename": "server/api/faxInteraction/index.js",
10274 "groupTitle": "Fax_Interactions"
10278 "url": "/api/fax/interactions/{id}",
10279 "title": "Deletes a Interaction",
10282 "title": "Example usage:",
10283 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10287 "name": "DeleteInteractions",
10288 "group": "Fax_Interactions",
10289 "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>",
10290 "version": "0.0.0",
10291 "filename": "server/api/faxInteraction/index.js",
10292 "groupTitle": "Fax_Interactions"
10296 "url": "/api/fax/interactions/describe",
10297 "title": "Gets table info about Interactions",
10300 "title": "Example usage:",
10301 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10305 "name": "DescribeInteractions",
10306 "group": "Fax_Interactions",
10307 "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>",
10308 "version": "0.0.0",
10309 "filename": "server/api/faxInteraction/index.js",
10310 "groupTitle": "Fax_Interactions"
10314 "url": "/api/fax/interactions",
10315 "title": "Gets a list of Interactions",
10318 "title": "Example usage:",
10319 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10323 "name": "GetInteractions",
10324 "group": "Fax_Interactions",
10325 "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>",
10326 "version": "0.0.0",
10327 "filename": "server/api/faxInteraction/index.js",
10328 "groupTitle": "Fax_Interactions"
10332 "url": "/api/fax/interactions/{id}/tags",
10333 "title": "Removes tags from interaction",
10336 "title": "Example usage:",
10337 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10341 "name": "RemoveTags",
10342 "group": "Fax_Interactions",
10343 "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>",
10344 "version": "0.0.0",
10345 "filename": "server/api/faxInteraction/index.js",
10346 "groupTitle": "Fax_Interactions"
10350 "url": "/api/fax/interactions/{id}",
10351 "title": "Gets a single Interaction",
10354 "title": "Example usage:",
10355 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10359 "name": "ShowInteractions",
10360 "group": "Fax_Interactions",
10361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10362 "version": "0.0.0",
10363 "filename": "server/api/faxInteraction/index.js",
10364 "groupTitle": "Fax_Interactions"
10368 "url": "/api/fax/interactions/{id}/messages",
10369 "title": "Creates new messages",
10372 "title": "Example usage:",
10373 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10377 "name": "addMessage",
10378 "group": "Fax_Interactions",
10404 "field": "direction",
10411 "field": "failMessage",
10424 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10425 "version": "0.0.0",
10426 "filename": "server/api/faxInteraction/index.js",
10427 "groupTitle": "Fax_Interactions"
10431 "url": "/api/fax/interactions/{id}/download",
10432 "title": "Get interactions",
10435 "title": "Example usage:",
10436 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10440 "name": "download",
10441 "group": "Fax_Interactions",
10442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10443 "version": "0.0.0",
10444 "filename": "server/api/faxInteraction/index.js",
10445 "groupTitle": "Fax_Interactions"
10449 "url": "/api/fax/interactions/{id}/messages",
10450 "title": "Gets interaction messages",
10453 "title": "Example usage:",
10454 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10458 "name": "getMessages",
10459 "group": "Fax_Interactions",
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": "server/api/faxInteraction/index.js",
10463 "groupTitle": "Fax_Interactions"
10467 "url": "/api/fax/interactions/{id}",
10468 "title": "Update an existing Interaction",
10471 "title": "Example usage:",
10472 "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",
10476 "name": "updateInteractions",
10477 "group": "Fax_Interactions",
10478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10479 "version": "0.0.0",
10480 "filename": "server/api/faxInteraction/index.js",
10481 "groupTitle": "Fax_Interactions"
10485 "url": "/api/fax/messages/{id}/download",
10486 "title": "Get message",
10489 "title": "Example usage:",
10490 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10494 "name": "download",
10495 "group": "Fax_Message",
10496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10497 "version": "0.0.0",
10498 "filename": "server/api/faxMessage/index.js",
10499 "groupTitle": "Fax_Message"
10503 "url": "/api/fax/messages/{id}",
10504 "title": "Deletes a Message",
10507 "title": "Example usage:",
10508 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10512 "name": "DeleteMessages",
10513 "group": "Fax_Messages",
10514 "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>",
10515 "version": "0.0.0",
10516 "filename": "server/api/faxMessage/index.js",
10517 "groupTitle": "Fax_Messages"
10521 "url": "/api/fax/messages/describe",
10522 "title": "Gets table info about Messages",
10525 "title": "Example usage:",
10526 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10530 "name": "DescribeMessages",
10531 "group": "Fax_Messages",
10532 "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>",
10533 "version": "0.0.0",
10534 "filename": "server/api/faxMessage/index.js",
10535 "groupTitle": "Fax_Messages"
10539 "url": "/api/fax/messages",
10540 "title": "Gets a list of Messages",
10543 "title": "Example usage:",
10544 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10548 "name": "GetMessages",
10549 "group": "Fax_Messages",
10550 "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>",
10551 "version": "0.0.0",
10552 "filename": "server/api/faxMessage/index.js",
10553 "groupTitle": "Fax_Messages"
10557 "url": "/api/fax/messages/{id}",
10558 "title": "Gets a single Message",
10561 "title": "Example usage:",
10562 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10566 "name": "ShowMessages",
10567 "group": "Fax_Messages",
10568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10569 "version": "0.0.0",
10570 "filename": "server/api/faxMessage/index.js",
10571 "groupTitle": "Fax_Messages"
10575 "url": "/api/fax/messages/{id}/accept",
10576 "title": "Accepts message",
10579 "title": "Example usage:",
10580 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10584 "name": "acceptMessage",
10585 "group": "Fax_Messages",
10586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10587 "version": "0.0.0",
10588 "filename": "server/api/faxMessage/index.js",
10589 "groupTitle": "Fax_Messages"
10593 "url": "/api/fax/messages/{id}/reject",
10594 "title": "Rejects message",
10597 "title": "Example usage:",
10598 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10602 "name": "rejectMessage",
10603 "group": "Fax_Messages",
10604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10605 "version": "0.0.0",
10606 "filename": "server/api/faxMessage/index.js",
10607 "groupTitle": "Fax_Messages"
10611 "url": "/api/fax/messages",
10612 "title": "Create message and send Fax",
10615 "title": "Example usage:",
10616 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10620 "name": "rejectMessage",
10621 "group": "Fax_Messages",
10622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10623 "version": "0.0.0",
10624 "filename": "server/api/faxMessage/index.js",
10625 "groupTitle": "Fax_Messages"
10629 "url": "/api/fax/messages/{id}",
10630 "title": "Update an existing Message",
10633 "title": "Example usage:",
10634 "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",
10638 "name": "updateMessages",
10639 "group": "Fax_Messages",
10640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10641 "version": "0.0.0",
10642 "filename": "server/api/faxMessage/index.js",
10643 "groupTitle": "Fax_Messages"
10647 "url": "/api/fax/reports/queue",
10648 "title": "Creates a new Fax Queue Report",
10651 "title": "Example usage:",
10652 "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",
10656 "name": "CreateFax_Queue_Reports",
10657 "group": "Fax_Queue_Reports",
10665 "field": "uniqueid",
10686 "field": "leaveAt",
10693 "field": "acceptAt",
10713 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10714 "version": "0.0.0",
10715 "filename": "server/api/faxQueueReport/index.js",
10716 "groupTitle": "Fax_Queue_Reports"
10720 "url": "/api/fax/reports/queue/{id}",
10721 "title": "Deletes a Fax Queue Report",
10724 "title": "Example usage:",
10725 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10729 "name": "DeleteFax_Queue_Reports",
10730 "group": "Fax_Queue_Reports",
10731 "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>",
10732 "version": "0.0.0",
10733 "filename": "server/api/faxQueueReport/index.js",
10734 "groupTitle": "Fax_Queue_Reports"
10738 "url": "/api/fax/reports/queue/describe",
10739 "title": "Gets table info about Fax Queue Reports",
10742 "title": "Example usage:",
10743 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10747 "name": "DescribeFax_Queue_Reports",
10748 "group": "Fax_Queue_Reports",
10749 "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>",
10750 "version": "0.0.0",
10751 "filename": "server/api/faxQueueReport/index.js",
10752 "groupTitle": "Fax_Queue_Reports"
10756 "url": "/api/fax/reports/queue",
10757 "title": "Gets a list of Fax Queue Reports",
10760 "title": "Example usage:",
10761 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10765 "name": "GetFax_Queue_Reports",
10766 "group": "Fax_Queue_Reports",
10767 "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>",
10768 "version": "0.0.0",
10769 "filename": "server/api/faxQueueReport/index.js",
10770 "groupTitle": "Fax_Queue_Reports"
10774 "url": "/api/fax/reports/queue/{id}",
10775 "title": "Gets a single Fax Queue Report",
10778 "title": "Example usage:",
10779 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
10783 "name": "ShowFax_Queue_Reports",
10784 "group": "Fax_Queue_Reports",
10785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10786 "version": "0.0.0",
10787 "filename": "server/api/faxQueueReport/index.js",
10788 "groupTitle": "Fax_Queue_Reports"
10792 "url": "/api/fax/reports/queue/{id}",
10793 "title": "Update an existing Fax Queue Report",
10796 "title": "Example usage:",
10797 "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",
10801 "name": "updateFax_Queue_Reports",
10802 "group": "Fax_Queue_Reports",
10803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10804 "version": "0.0.0",
10805 "filename": "server/api/faxQueueReport/index.js",
10806 "groupTitle": "Fax_Queue_Reports"
10810 "url": "/api/fax/queues/{id}/users",
10811 "title": "Add agents to a queue",
10814 "title": "Example usage:",
10815 "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",
10819 "name": "AddAgents",
10820 "group": "Fax_Queues",
10821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10822 "version": "0.0.0",
10823 "filename": "server/api/faxQueue/index.js",
10824 "groupTitle": "Fax_Queues"
10828 "url": "/api/fax/queues/{id}/teams",
10829 "title": "Add teams to a queue",
10832 "title": "Example usage:",
10833 "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",
10837 "name": "AddTeams",
10838 "group": "Fax_Queues",
10839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10840 "version": "0.0.0",
10841 "filename": "server/api/faxQueue/index.js",
10842 "groupTitle": "Fax_Queues"
10846 "url": "/api/fax/queues",
10847 "title": "Creates a new Queue",
10850 "title": "Example usage:",
10851 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10855 "name": "CreateQueues",
10856 "group": "Fax_Queues",
10871 "field": "description",
10878 "field": "timeout",
10890 "field": "strategy",
10897 "field": "lastAgent",
10903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10904 "version": "0.0.0",
10905 "filename": "server/api/faxQueue/index.js",
10906 "groupTitle": "Fax_Queues"
10910 "url": "/api/fax/queues/{id}",
10911 "title": "Deletes a Queue",
10914 "title": "Example usage:",
10915 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
10919 "name": "DeleteQueues",
10920 "group": "Fax_Queues",
10921 "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>",
10922 "version": "0.0.0",
10923 "filename": "server/api/faxQueue/index.js",
10924 "groupTitle": "Fax_Queues"
10928 "url": "/api/fax/queues/describe",
10929 "title": "Gets table info about Queues",
10932 "title": "Example usage:",
10933 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
10937 "name": "DescribeQueues",
10938 "group": "Fax_Queues",
10939 "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>",
10940 "version": "0.0.0",
10941 "filename": "server/api/faxQueue/index.js",
10942 "groupTitle": "Fax_Queues"
10946 "url": "/api/fax/queues/{id}/users",
10947 "title": "Gets queue agents",
10950 "title": "Example usage:",
10951 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
10955 "name": "GetAgents",
10956 "group": "Fax_Queues",
10957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10958 "version": "0.0.0",
10959 "filename": "server/api/faxQueue/index.js",
10960 "groupTitle": "Fax_Queues"
10964 "url": "/api/fax/queues/{id}/members",
10965 "title": "GetMembers",
10968 "title": "Example usage:",
10969 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
10973 "name": "GetMembers",
10974 "group": "Fax_Queues",
10975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10976 "version": "0.0.0",
10977 "filename": "server/api/faxQueue/index.js",
10978 "groupTitle": "Fax_Queues"
10982 "url": "/api/fax/queues",
10983 "title": "Gets a list of Queues",
10986 "title": "Example usage:",
10987 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
10991 "name": "GetQueues",
10992 "group": "Fax_Queues",
10993 "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>",
10994 "version": "0.0.0",
10995 "filename": "server/api/faxQueue/index.js",
10996 "groupTitle": "Fax_Queues"
11000 "url": "/api/fax/queues/{id}/teams",
11001 "title": "Gets queues list",
11004 "title": "Example usage:",
11005 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11009 "name": "GetTeams",
11010 "group": "Fax_Queues",
11011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11012 "version": "0.0.0",
11013 "filename": "server/api/faxQueue/index.js",
11014 "groupTitle": "Fax_Queues"
11018 "url": "/api/fax/queues/{id}/users",
11019 "title": "Removes agents from a queue",
11022 "title": "Example usage:",
11023 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11027 "name": "RemoveAgents",
11028 "group": "Fax_Queues",
11029 "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>",
11030 "version": "0.0.0",
11031 "filename": "server/api/faxQueue/index.js",
11032 "groupTitle": "Fax_Queues"
11036 "url": "/api/fax/queues/{id}",
11037 "title": "Gets a single Queue",
11040 "title": "Example usage:",
11041 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11045 "name": "ShowQueues",
11046 "group": "Fax_Queues",
11047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11048 "version": "0.0.0",
11049 "filename": "server/api/faxQueue/index.js",
11050 "groupTitle": "Fax_Queues"
11054 "url": "/api/fax/queues/{id}",
11055 "title": "Update an existing Queue",
11058 "title": "Example usage:",
11059 "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",
11063 "name": "updateQueues",
11064 "group": "Fax_Queues",
11065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11066 "version": "0.0.0",
11067 "filename": "server/api/faxQueue/index.js",
11068 "groupTitle": "Fax_Queues"
11072 "url": "/api/fax/reports/transfer",
11073 "title": "Creates a new Fax Transfer Report",
11076 "title": "Example usage:",
11077 "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",
11081 "name": "CreateFax_Transfer_Reports",
11082 "group": "Fax_Transfer_Reports",
11090 "field": "uniqueid",
11109 "field": "transferredAt",
11115 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11116 "version": "0.0.0",
11117 "filename": "server/api/faxTransferReport/index.js",
11118 "groupTitle": "Fax_Transfer_Reports"
11122 "url": "/api/fax/reports/transfer/{id}",
11123 "title": "Deletes a Fax Transfer Report",
11126 "title": "Example usage:",
11127 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11131 "name": "DeleteFax_Transfer_Reports",
11132 "group": "Fax_Transfer_Reports",
11133 "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>",
11134 "version": "0.0.0",
11135 "filename": "server/api/faxTransferReport/index.js",
11136 "groupTitle": "Fax_Transfer_Reports"
11140 "url": "/api/fax/reports/transfer/describe",
11141 "title": "Gets table info about Fax Transfer Reports",
11144 "title": "Example usage:",
11145 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11149 "name": "DescribeFax_Transfer_Reports",
11150 "group": "Fax_Transfer_Reports",
11151 "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>",
11152 "version": "0.0.0",
11153 "filename": "server/api/faxTransferReport/index.js",
11154 "groupTitle": "Fax_Transfer_Reports"
11158 "url": "/api/fax/reports/transfer",
11159 "title": "Gets a list of Fax Transfer Reports",
11162 "title": "Example usage:",
11163 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11167 "name": "GetFax_Transfer_Reports",
11168 "group": "Fax_Transfer_Reports",
11169 "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>",
11170 "version": "0.0.0",
11171 "filename": "server/api/faxTransferReport/index.js",
11172 "groupTitle": "Fax_Transfer_Reports"
11176 "url": "/api/fax/reports/transfer/{id}",
11177 "title": "Gets a single Fax Transfer Report",
11180 "title": "Example usage:",
11181 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11185 "name": "ShowFax_Transfer_Reports",
11186 "group": "Fax_Transfer_Reports",
11187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11188 "version": "0.0.0",
11189 "filename": "server/api/faxTransferReport/index.js",
11190 "groupTitle": "Fax_Transfer_Reports"
11194 "url": "/api/fax/reports/transfer/{id}",
11195 "title": "Update an existing Fax Transfer Report",
11198 "title": "Example usage:",
11199 "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",
11203 "name": "updateFax_Transfer_Reports",
11204 "group": "Fax_Transfer_Reports",
11205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11206 "version": "0.0.0",
11207 "filename": "server/api/faxTransferReport/index.js",
11208 "groupTitle": "Fax_Transfer_Reports"
11212 "url": "/api/integrations/freshdesk/accounts",
11213 "title": "Creates a new Freshdesk Account",
11216 "title": "Example usage:",
11217 "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",
11221 "name": "CreateFreshdesk_Accounts",
11222 "group": "Freshdesk_Accounts",
11237 "field": "description",
11244 "field": "username",
11258 "field": "remoteUri",
11265 "field": "serverUrl",
11271 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11272 "version": "0.0.0",
11273 "filename": "server/api/intFreshdeskAccount/index.js",
11274 "groupTitle": "Freshdesk_Accounts"
11278 "url": "/api/integrations/freshdesk/accounts/{id}",
11279 "title": "Deletes a Freshdesk Account",
11282 "title": "Example usage:",
11283 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11287 "name": "DeleteFreshdesk_Accounts",
11288 "group": "Freshdesk_Accounts",
11289 "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>",
11290 "version": "0.0.0",
11291 "filename": "server/api/intFreshdeskAccount/index.js",
11292 "groupTitle": "Freshdesk_Accounts"
11296 "url": "/api/integrations/freshdesk/accounts",
11297 "title": "Gets a list of Freshdesk Accounts",
11300 "title": "Example usage:",
11301 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11305 "name": "GetFreshdesk_Accounts",
11306 "group": "Freshdesk_Accounts",
11307 "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>",
11308 "version": "0.0.0",
11309 "filename": "server/api/intFreshdeskAccount/index.js",
11310 "groupTitle": "Freshdesk_Accounts"
11314 "url": "/api/integrations/freshdesk/accounts/{id}",
11315 "title": "Gets a single Freshdesk Account",
11318 "title": "Example usage:",
11319 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11323 "name": "ShowFreshdesk_Accounts",
11324 "group": "Freshdesk_Accounts",
11325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11326 "version": "0.0.0",
11327 "filename": "server/api/intFreshdeskAccount/index.js",
11328 "groupTitle": "Freshdesk_Accounts"
11332 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11333 "title": "Creates new configuration",
11336 "title": "Example usage:",
11337 "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",
11341 "name": "addConfiguration",
11342 "group": "Freshdesk_Accounts",
11343 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11344 "version": "0.0.0",
11345 "filename": "server/api/intFreshdeskAccount/index.js",
11346 "groupTitle": "Freshdesk_Accounts"
11350 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11351 "title": "Gets account configurations",
11354 "title": "Example usage:",
11355 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11359 "name": "getConfigurations",
11360 "group": "Freshdesk_Accounts",
11361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11362 "version": "0.0.0",
11363 "filename": "server/api/intFreshdeskAccount/index.js",
11364 "groupTitle": "Freshdesk_Accounts"
11368 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11369 "title": "Gets account fields",
11372 "title": "Example usage:",
11373 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11377 "name": "getFields",
11378 "group": "Freshdesk_Accounts",
11379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11380 "version": "0.0.0",
11381 "filename": "server/api/intFreshdeskAccount/index.js",
11382 "groupTitle": "Freshdesk_Accounts"
11386 "url": "/api/integrations/freshdesk/accounts/{id}",
11387 "title": "Update an existing Freshdesk Account",
11390 "title": "Example usage:",
11391 "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",
11395 "name": "updateFreshdesk_Accounts",
11396 "group": "Freshdesk_Accounts",
11397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11398 "version": "0.0.0",
11399 "filename": "server/api/intFreshdeskAccount/index.js",
11400 "groupTitle": "Freshdesk_Accounts"
11404 "url": "/api/integrations/freshdesk/configurations",
11405 "title": "Creates a new Freshdesk Configuration",
11408 "title": "Example usage:",
11409 "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",
11413 "name": "CreateFreshdesk_Configurations",
11414 "group": "Freshdesk_Configurations",
11429 "field": "description",
11435 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11436 "version": "0.0.0",
11437 "filename": "server/api/intFreshdeskConfiguration/index.js",
11438 "groupTitle": "Freshdesk_Configurations"
11442 "url": "/api/integrations/freshdesk/configurations/{id}",
11443 "title": "Deletes a Freshdesk Configuration",
11446 "title": "Example usage:",
11447 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11451 "name": "DeleteFreshdesk_Configurations",
11452 "group": "Freshdesk_Configurations",
11453 "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>",
11454 "version": "0.0.0",
11455 "filename": "server/api/intFreshdeskConfiguration/index.js",
11456 "groupTitle": "Freshdesk_Configurations"
11460 "url": "/api/integrations/freshdesk/configurations",
11461 "title": "Gets a list of Freshdesk Configurations",
11464 "title": "Example usage:",
11465 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11469 "name": "GetFreshdesk_Configurations",
11470 "group": "Freshdesk_Configurations",
11471 "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>",
11472 "version": "0.0.0",
11473 "filename": "server/api/intFreshdeskConfiguration/index.js",
11474 "groupTitle": "Freshdesk_Configurations"
11478 "url": "/api/integrations/freshdesk/configurations/{id}",
11479 "title": "Gets a single Freshdesk Configuration",
11482 "title": "Example usage:",
11483 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11487 "name": "ShowFreshdesk_Configurations",
11488 "group": "Freshdesk_Configurations",
11489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11490 "version": "0.0.0",
11491 "filename": "server/api/intFreshdeskConfiguration/index.js",
11492 "groupTitle": "Freshdesk_Configurations"
11496 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11497 "title": "Gets configurations descriptions",
11500 "title": "Example usage:",
11501 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11505 "name": "getDescriptions",
11506 "group": "Freshdesk_Configurations",
11507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11508 "version": "0.0.0",
11509 "filename": "server/api/intFreshdeskConfiguration/index.js",
11510 "groupTitle": "Freshdesk_Configurations"
11514 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11515 "title": "Gets configurations fields",
11518 "title": "Example usage:",
11519 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11523 "name": "getFields",
11524 "group": "Freshdesk_Configurations",
11525 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11526 "version": "0.0.0",
11527 "filename": "server/api/intFreshdeskConfiguration/index.js",
11528 "groupTitle": "Freshdesk_Configurations"
11532 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11533 "title": "Gets configurations subjects",
11536 "title": "Example usage:",
11537 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11541 "name": "getSubjects",
11542 "group": "Freshdesk_Configurations",
11543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11544 "version": "0.0.0",
11545 "filename": "server/api/intFreshdeskConfiguration/index.js",
11546 "groupTitle": "Freshdesk_Configurations"
11550 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11551 "title": "Gets configurations tags",
11554 "title": "Example usage:",
11555 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11560 "group": "Freshdesk_Configurations",
11561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11562 "version": "0.0.0",
11563 "filename": "server/api/intFreshdeskConfiguration/index.js",
11564 "groupTitle": "Freshdesk_Configurations"
11568 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11569 "title": "Sets new tags",
11572 "title": "Example usage:",
11573 "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",
11578 "group": "Freshdesk_Configurations",
11579 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11580 "version": "0.0.0",
11581 "filename": "server/api/intFreshdeskConfiguration/index.js",
11582 "groupTitle": "Freshdesk_Configurations"
11586 "url": "/api/integrations/freshdesk/configurations/{id}",
11587 "title": "Update an existing Freshdesk Configuration",
11590 "title": "Example usage:",
11591 "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",
11595 "name": "updateFreshdesk_Configurations",
11596 "group": "Freshdesk_Configurations",
11597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11598 "version": "0.0.0",
11599 "filename": "server/api/intFreshdeskConfiguration/index.js",
11600 "groupTitle": "Freshdesk_Configurations"
11604 "url": "/api/integrations/freshdesk/fields",
11605 "title": "Creates a new Freshdesk Field",
11608 "title": "Example usage:",
11609 "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",
11613 "name": "CreateFreshdesk_Fields",
11614 "group": "Freshdesk_Fields",
11624 "\"customVariable\"",
11635 "field": "content",
11651 "\"customVariable\""
11654 "field": "keyType",
11661 "field": "keyContent",
11668 "field": "idField",
11675 "field": "nameField",
11682 "field": "customField",
11689 "field": "variableName",
11695 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11696 "version": "0.0.0",
11697 "filename": "server/api/intFreshdeskField/index.js",
11698 "groupTitle": "Freshdesk_Fields"
11702 "url": "/api/integrations/freshdesk/fields/{id}",
11703 "title": "Deletes a Freshdesk Field",
11706 "title": "Example usage:",
11707 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11711 "name": "DeleteFreshdesk_Fields",
11712 "group": "Freshdesk_Fields",
11713 "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>",
11714 "version": "0.0.0",
11715 "filename": "server/api/intFreshdeskField/index.js",
11716 "groupTitle": "Freshdesk_Fields"
11720 "url": "/api/integrations/freshdesk/fields",
11721 "title": "Gets a list of Freshdesk Fields",
11724 "title": "Example usage:",
11725 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11729 "name": "GetFreshdesk_Fields",
11730 "group": "Freshdesk_Fields",
11731 "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>",
11732 "version": "0.0.0",
11733 "filename": "server/api/intFreshdeskField/index.js",
11734 "groupTitle": "Freshdesk_Fields"
11738 "url": "/api/integrations/freshdesk/fields/{id}",
11739 "title": "Gets a single Freshdesk Field",
11742 "title": "Example usage:",
11743 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11747 "name": "ShowFreshdesk_Fields",
11748 "group": "Freshdesk_Fields",
11749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11750 "version": "0.0.0",
11751 "filename": "server/api/intFreshdeskField/index.js",
11752 "groupTitle": "Freshdesk_Fields"
11756 "url": "/api/integrations/freshdesk/fields/{id}",
11757 "title": "Update an existing Freshdesk Field",
11760 "title": "Example usage:",
11761 "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",
11765 "name": "updateFreshdesk_Fields",
11766 "group": "Freshdesk_Fields",
11767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11768 "version": "0.0.0",
11769 "filename": "server/api/intFreshdeskField/index.js",
11770 "groupTitle": "Freshdesk_Fields"
11774 "url": "/api/integrations/freshsales/accounts",
11775 "title": "Creates a new Freshsales Account",
11778 "title": "Example usage:",
11779 "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",
11783 "name": "CreateFreshsales_Accounts",
11784 "group": "Freshsales_Accounts",
11799 "field": "description",
11806 "field": "username",
11820 "field": "remoteUri",
11827 "field": "serverUrl",
11833 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11834 "version": "0.0.0",
11835 "filename": "server/api/intFreshsalesAccount/index.js",
11836 "groupTitle": "Freshsales_Accounts"
11840 "url": "/api/integrations/freshsales/accounts/{id}",
11841 "title": "Deletes a Freshsales Account",
11844 "title": "Example usage:",
11845 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
11849 "name": "DeleteFreshsales_Accounts",
11850 "group": "Freshsales_Accounts",
11851 "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>",
11852 "version": "0.0.0",
11853 "filename": "server/api/intFreshsalesAccount/index.js",
11854 "groupTitle": "Freshsales_Accounts"
11858 "url": "/api/integrations/freshsales/accounts",
11859 "title": "Gets a list of Freshsales Accounts",
11862 "title": "Example usage:",
11863 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
11867 "name": "GetFreshsales_Accounts",
11868 "group": "Freshsales_Accounts",
11869 "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>",
11870 "version": "0.0.0",
11871 "filename": "server/api/intFreshsalesAccount/index.js",
11872 "groupTitle": "Freshsales_Accounts"
11876 "url": "/api/integrations/freshsales/accounts/{id}",
11877 "title": "Gets a single Freshsales Account",
11880 "title": "Example usage:",
11881 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
11885 "name": "ShowFreshsales_Accounts",
11886 "group": "Freshsales_Accounts",
11887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11888 "version": "0.0.0",
11889 "filename": "server/api/intFreshsalesAccount/index.js",
11890 "groupTitle": "Freshsales_Accounts"
11894 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11895 "title": "Creates new configuration",
11898 "title": "Example usage:",
11899 "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",
11903 "name": "addConfiguration",
11904 "group": "Freshsales_Accounts",
11905 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11906 "version": "0.0.0",
11907 "filename": "server/api/intFreshsalesAccount/index.js",
11908 "groupTitle": "Freshsales_Accounts"
11912 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11913 "title": "Gets account configurations",
11916 "title": "Example usage:",
11917 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11921 "name": "getConfigurations",
11922 "group": "Freshsales_Accounts",
11923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11924 "version": "0.0.0",
11925 "filename": "server/api/intFreshsalesAccount/index.js",
11926 "groupTitle": "Freshsales_Accounts"
11930 "url": "/api/integrations/freshsales/accounts/{id}/fields",
11931 "title": "Gets account fields",
11934 "title": "Example usage:",
11935 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
11939 "name": "getFields",
11940 "group": "Freshsales_Accounts",
11941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11942 "version": "0.0.0",
11943 "filename": "server/api/intFreshsalesAccount/index.js",
11944 "groupTitle": "Freshsales_Accounts"
11948 "url": "/api/integrations/freshsales/accounts/{id}",
11949 "title": "Update an existing Freshsales Account",
11952 "title": "Example usage:",
11953 "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",
11957 "name": "updateFreshsales_Accounts",
11958 "group": "Freshsales_Accounts",
11959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11960 "version": "0.0.0",
11961 "filename": "server/api/intFreshsalesAccount/index.js",
11962 "groupTitle": "Freshsales_Accounts"
11966 "url": "/api/integrations/freshsales/configurations",
11967 "title": "Creates a new Freshsales Configuration",
11970 "title": "Example usage:",
11971 "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",
11975 "name": "CreateFreshsales_Configurations",
11976 "group": "Freshsales_Configurations",
11991 "field": "description",
11997 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11998 "version": "0.0.0",
11999 "filename": "server/api/intFreshsalesConfiguration/index.js",
12000 "groupTitle": "Freshsales_Configurations"
12004 "url": "/api/integrations/freshsales/configurations/{id}",
12005 "title": "Deletes a Freshsales Configuration",
12008 "title": "Example usage:",
12009 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12013 "name": "DeleteFreshsales_Configurations",
12014 "group": "Freshsales_Configurations",
12015 "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>",
12016 "version": "0.0.0",
12017 "filename": "server/api/intFreshsalesConfiguration/index.js",
12018 "groupTitle": "Freshsales_Configurations"
12022 "url": "/api/integrations/freshsales/configurations",
12023 "title": "Gets a list of Freshsales Configurations",
12026 "title": "Example usage:",
12027 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12031 "name": "GetFreshsales_Configurations",
12032 "group": "Freshsales_Configurations",
12033 "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>",
12034 "version": "0.0.0",
12035 "filename": "server/api/intFreshsalesConfiguration/index.js",
12036 "groupTitle": "Freshsales_Configurations"
12040 "url": "/api/integrations/freshsales/configurations/{id}",
12041 "title": "Gets a single Freshsales Configuration",
12044 "title": "Example usage:",
12045 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12049 "name": "ShowFreshsales_Configurations",
12050 "group": "Freshsales_Configurations",
12051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12052 "version": "0.0.0",
12053 "filename": "server/api/intFreshsalesConfiguration/index.js",
12054 "groupTitle": "Freshsales_Configurations"
12058 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12059 "title": "Gets configurations descriptions",
12062 "title": "Example usage:",
12063 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12067 "name": "getDescriptions",
12068 "group": "Freshsales_Configurations",
12069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12070 "version": "0.0.0",
12071 "filename": "server/api/intFreshsalesConfiguration/index.js",
12072 "groupTitle": "Freshsales_Configurations"
12076 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12077 "title": "Gets configurations fields",
12080 "title": "Example usage:",
12081 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12085 "name": "getFields",
12086 "group": "Freshsales_Configurations",
12087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12088 "version": "0.0.0",
12089 "filename": "server/api/intFreshsalesConfiguration/index.js",
12090 "groupTitle": "Freshsales_Configurations"
12094 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12095 "title": "Gets configurations subjects",
12098 "title": "Example usage:",
12099 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12103 "name": "getSubjects",
12104 "group": "Freshsales_Configurations",
12105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12106 "version": "0.0.0",
12107 "filename": "server/api/intFreshsalesConfiguration/index.js",
12108 "groupTitle": "Freshsales_Configurations"
12112 "url": "/api/integrations/freshsales/configurations/{id}",
12113 "title": "Update an existing Freshsales Configuration",
12116 "title": "Example usage:",
12117 "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",
12121 "name": "updateFreshsales_Configurations",
12122 "group": "Freshsales_Configurations",
12123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12124 "version": "0.0.0",
12125 "filename": "server/api/intFreshsalesConfiguration/index.js",
12126 "groupTitle": "Freshsales_Configurations"
12130 "url": "/api/integrations/freshsales/fields",
12131 "title": "Creates a new Freshsales Field",
12134 "title": "Example usage:",
12135 "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",
12139 "name": "CreateFreshsales_Fields",
12140 "group": "Freshsales_Fields",
12150 "\"customVariable\"",
12161 "field": "content",
12177 "\"customVariable\""
12180 "field": "keyType",
12187 "field": "keyContent",
12194 "field": "idField",
12201 "field": "nameField",
12208 "field": "customField",
12215 "field": "variableName",
12221 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12222 "version": "0.0.0",
12223 "filename": "server/api/intFreshsalesField/index.js",
12224 "groupTitle": "Freshsales_Fields"
12228 "url": "/api/integrations/freshsales/fields/{id}",
12229 "title": "Deletes a Freshsales Field",
12232 "title": "Example usage:",
12233 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12237 "name": "DeleteFreshsales_Fields",
12238 "group": "Freshsales_Fields",
12239 "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>",
12240 "version": "0.0.0",
12241 "filename": "server/api/intFreshsalesField/index.js",
12242 "groupTitle": "Freshsales_Fields"
12246 "url": "/api/integrations/freshsales/fields",
12247 "title": "Gets a list of Freshsales Fields",
12250 "title": "Example usage:",
12251 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12255 "name": "GetFreshsales_Fields",
12256 "group": "Freshsales_Fields",
12257 "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>",
12258 "version": "0.0.0",
12259 "filename": "server/api/intFreshsalesField/index.js",
12260 "groupTitle": "Freshsales_Fields"
12264 "url": "/api/integrations/freshsales/fields/{id}",
12265 "title": "Gets a single Freshsales Field",
12268 "title": "Example usage:",
12269 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12273 "name": "ShowFreshsales_Fields",
12274 "group": "Freshsales_Fields",
12275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12276 "version": "0.0.0",
12277 "filename": "server/api/intFreshsalesField/index.js",
12278 "groupTitle": "Freshsales_Fields"
12282 "url": "/api/integrations/freshsales/fields/{id}",
12283 "title": "Update an existing Freshsales Field",
12286 "title": "Example usage:",
12287 "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",
12291 "name": "updateFreshsales_Fields",
12292 "group": "Freshsales_Fields",
12293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12294 "version": "0.0.0",
12295 "filename": "server/api/intFreshsalesField/index.js",
12296 "groupTitle": "Freshsales_Fields"
12300 "url": "/api/campaigns/{id}/blacklists",
12301 "title": "Add blacklists to an IVR campaign",
12304 "title": "Example usage:",
12305 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12309 "name": "AddBlackLists",
12310 "group": "IVR_Campaigns",
12311 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12312 "version": "0.0.0",
12313 "filename": "server/api/campaign/index.js",
12314 "groupTitle": "IVR_Campaigns"
12318 "url": "/api/campaigns/{id}/lists",
12319 "title": "Add lists to an IVR campaign",
12322 "title": "Example usage:",
12323 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12327 "name": "AddLists",
12328 "group": "IVR_Campaigns",
12329 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12330 "version": "0.0.0",
12331 "filename": "server/api/campaign/index.js",
12332 "groupTitle": "IVR_Campaigns"
12336 "url": "/api/campaigns/clone",
12337 "title": "Clone an existing IVR Campaign",
12340 "title": "Example usage:",
12341 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12345 "name": "CloneIVR_Campaigns",
12346 "group": "IVR_Campaigns",
12347 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12348 "version": "0.0.0",
12349 "filename": "server/api/campaign/index.js",
12350 "groupTitle": "IVR_Campaigns"
12354 "url": "/api/campaigns",
12355 "title": "Creates a new IVR Campaign",
12358 "title": "Example usage:",
12359 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12363 "name": "CreateIVR_Campaigns",
12364 "group": "IVR_Campaigns",
12389 "field": "description",
12397 "description": "<p>Active/Disactive Campaign</p>"
12403 "field": "limitCalls",
12404 "description": "<p>Max 200 calls.</p>"
12410 "field": "dialOriginateCallerIdName",
12417 "field": "dialOriginateCallerIdNumber",
12424 "field": "dialOriginateTimeout",
12425 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12431 "field": "dialCongestionMaxRetry",
12432 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12438 "field": "dialCongestionRetryFrequency",
12439 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12445 "field": "dialBusyMaxRetry",
12446 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12452 "field": "dialBusyRetryFrequency",
12453 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12459 "field": "dialNoAnswerMaxRetry",
12460 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12466 "field": "dialNoAnswerRetryFrequency",
12467 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12473 "field": "dialGlobalMaxRetry",
12474 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12480 "field": "dialTimezone",
12487 "field": "dialGlobalInterval",
12499 "field": "dialCheckDuplicateType",
12506 "field": "dialAMDActive",
12507 "description": "<p>Active/Disactive AMD</p>"
12513 "field": "dialAMDInitialSilence",
12514 "description": "<p>#AMD Initial Silence</p>"
12520 "field": "dialAMDGreeting",
12521 "description": "<p>#AMD Greeting</p>"
12527 "field": "dialAMDAfterGreetingSilence",
12528 "description": "<p>#AMD After Greeting Silence</p>"
12534 "field": "dialAMDTotalAnalysisTime",
12535 "description": "<p>#AMD Total Analysis Time</p>"
12541 "field": "dialAMDMinWordLength",
12542 "description": "<p>#AMD Min Word Length</p>"
12548 "field": "dialAMDBetweenWordsSilence",
12549 "description": "<p>#AMD Between Words Silence</p>"
12555 "field": "dialAMDMaximumNumberOfWords",
12556 "description": "<p>#AMD Maximum Number Of Words</p>"
12562 "field": "dialAMDSilenceThreshold",
12563 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12569 "field": "dialAMDMaximumWordLength",
12570 "description": "<p>#AMD Maximum Word Length</p>"
12580 "field": "dialOrderByScheduledAt",
12587 "field": "dialPrefix",
12594 "field": "dialRandomLastDigitCallerIdNumber",
12595 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12601 "field": "dialCutDigit",
12602 "description": "<p>Cut Digit (min:1, max:15)</p>"
12607 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12608 "version": "0.0.0",
12609 "filename": "server/api/campaign/index.js",
12610 "groupTitle": "IVR_Campaigns"
12614 "url": "/api/campaigns/{id}",
12615 "title": "Deletes a IVR Campaign",
12618 "title": "Example usage:",
12619 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12623 "name": "DeleteIVR_Campaigns",
12624 "group": "IVR_Campaigns",
12625 "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>",
12626 "version": "0.0.0",
12627 "filename": "server/api/campaign/index.js",
12628 "groupTitle": "IVR_Campaigns"
12632 "url": "/api/campaigns/{id}/blacklists",
12633 "title": "Get IVR campaign blacklists",
12636 "title": "Example usage:",
12637 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12641 "name": "GetBlackLists",
12642 "group": "IVR_Campaigns",
12643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12644 "version": "0.0.0",
12645 "filename": "server/api/campaign/index.js",
12646 "groupTitle": "IVR_Campaigns"
12650 "url": "/api/campaigns/{id}/finals",
12651 "title": "Gets IVR campaign hopper finals",
12654 "title": "Example usage:",
12655 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12659 "name": "GetHopperFinals",
12660 "group": "IVR_Campaigns",
12661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12662 "version": "0.0.0",
12663 "filename": "server/api/campaign/index.js",
12664 "groupTitle": "IVR_Campaigns"
12668 "url": "/api/campaigns/{id}/hopper_histories",
12669 "title": "Gets IVR campaign hopper histories",
12672 "title": "Example usage:",
12673 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12677 "name": "GetHopperHistories",
12678 "group": "IVR_Campaigns",
12679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12680 "version": "0.0.0",
12681 "filename": "server/api/campaign/index.js",
12682 "groupTitle": "IVR_Campaigns"
12686 "url": "/api/campaigns/{id}/hoppers",
12687 "title": "Gets IVR campaign hoppers",
12690 "title": "Example usage:",
12691 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12695 "name": "GetHoppers",
12696 "group": "IVR_Campaigns",
12697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12698 "version": "0.0.0",
12699 "filename": "server/api/campaign/index.js",
12700 "groupTitle": "IVR_Campaigns"
12704 "url": "/api/campaigns",
12705 "title": "Gets a list of IVR Campaigns",
12708 "title": "Example usage:",
12709 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
12713 "name": "GetIVR_Campaigns",
12714 "group": "IVR_Campaigns",
12715 "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>",
12716 "version": "0.0.0",
12717 "filename": "server/api/campaign/index.js",
12718 "groupTitle": "IVR_Campaigns"
12722 "url": "/api/campaigns/{id}/lists",
12723 "title": "Get IVR campaign lists",
12726 "title": "Example usage:",
12727 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
12731 "name": "GetLists",
12732 "group": "IVR_Campaigns",
12733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12734 "version": "0.0.0",
12735 "filename": "server/api/campaign/index.js",
12736 "groupTitle": "IVR_Campaigns"
12740 "url": "/api/campaigns/{id}/blacklists",
12741 "title": "Remove blacklists from an IVR Campaign",
12744 "title": "Example usage:",
12745 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12749 "name": "RemoveBlackLists",
12750 "group": "IVR_Campaigns",
12751 "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>",
12752 "version": "0.0.0",
12753 "filename": "server/api/campaign/index.js",
12754 "groupTitle": "IVR_Campaigns"
12758 "url": "/api/campaigns/{id}/lists",
12759 "title": "Remove lists from an IVR Campaign",
12762 "title": "Example usage:",
12763 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12767 "name": "RemoveLists",
12768 "group": "IVR_Campaigns",
12769 "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>",
12770 "version": "0.0.0",
12771 "filename": "server/api/campaign/index.js",
12772 "groupTitle": "IVR_Campaigns"
12776 "url": "/api/campaigns/{id}",
12777 "title": "Gets a single IVR Campaign",
12780 "title": "Example usage:",
12781 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
12785 "name": "ShowIVR_Campaigns",
12786 "group": "IVR_Campaigns",
12787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12788 "version": "0.0.0",
12789 "filename": "server/api/campaign/index.js",
12790 "groupTitle": "IVR_Campaigns"
12794 "url": "/api/campaigns/{id}/blacks",
12795 "title": "Gets IVR campaign hopper blacks",
12798 "title": "Example usage:",
12799 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
12803 "name": "getHopperBlacks",
12804 "group": "IVR_Campaigns",
12805 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12806 "version": "0.0.0",
12807 "filename": "server/api/campaign/index.js",
12808 "groupTitle": "IVR_Campaigns"
12812 "url": "/api/campaigns/{id}",
12813 "title": "Update an existing IVR Campaign",
12816 "title": "Example usage:",
12817 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12821 "name": "updateIVR_Campaigns",
12822 "group": "IVR_Campaigns",
12823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12824 "version": "0.0.0",
12825 "filename": "server/api/campaign/index.js",
12826 "groupTitle": "IVR_Campaigns"
12830 "url": "/api/integrations/reports",
12831 "title": "Creates a new Integration Report",
12834 "title": "Example usage:",
12835 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12839 "name": "CreateIntegration_Reports",
12840 "group": "Integration_Reports",
12848 "field": "integration",
12855 "field": "eventChannel",
12862 "field": "exitStatus",
12869 "field": "ticketId",
12876 "field": "integrationId",
12883 "field": "contacts",
12890 "field": "uniqueid",
12897 "field": "calleridnum",
12904 "field": "calleridname",
12918 "field": "interface",
12925 "field": "membername",
12932 "field": "agentcalledAt",
12939 "field": "agentconnectAt",
12946 "field": "holdtime",
12953 "field": "agentcomplete",
12960 "field": "agentcompleteAt",
12967 "field": "talktime",
12974 "field": "agentacw",
12981 "field": "acwtime",
12995 "field": "agentringnoanswer",
13002 "field": "agentringnoanswerAt",
13009 "field": "agentdump",
13016 "field": "agentdumpAt",
13023 "field": "lastevent",
13030 "field": "channel",
13037 "field": "channelstate",
13044 "field": "channelstatedesc",
13051 "field": "connectedlinenum",
13058 "field": "connectedlinename",
13065 "field": "language",
13072 "field": "accountcode",
13079 "field": "context",
13093 "field": "priority",
13100 "field": "destchannel",
13107 "field": "destchannelstate",
13114 "field": "destchannelstatedesc",
13121 "field": "destcalleridnum",
13128 "field": "destcalleridname",
13135 "field": "destconnectedlinenum",
13142 "field": "destconnectedlinename",
13149 "field": "destlanguage",
13156 "field": "destaccountcode",
13163 "field": "destcontext",
13170 "field": "destexten",
13177 "field": "destpriority",
13184 "field": "destuniqueid",
13191 "field": "messageId",
13198 "field": "inReplyTo",
13205 "field": "subject",
13233 "field": "attachment",
13281 "field": "appdata",
13288 "field": "projectId",
13294 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13295 "version": "0.0.0",
13296 "filename": "server/api/integrationReport/index.js",
13297 "groupTitle": "Integration_Reports"
13301 "url": "/api/integrations/reports/{id}",
13302 "title": "Deletes a Integration Report",
13305 "title": "Example usage:",
13306 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13310 "name": "DeleteIntegration_Reports",
13311 "group": "Integration_Reports",
13312 "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>",
13313 "version": "0.0.0",
13314 "filename": "server/api/integrationReport/index.js",
13315 "groupTitle": "Integration_Reports"
13319 "url": "/api/integrations/reports/describe",
13320 "title": "Gets table info about Integration Reports",
13323 "title": "Example usage:",
13324 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13328 "name": "DescribeIntegration_Reports",
13329 "group": "Integration_Reports",
13330 "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>",
13331 "version": "0.0.0",
13332 "filename": "server/api/integrationReport/index.js",
13333 "groupTitle": "Integration_Reports"
13337 "url": "/api/integrations/reports",
13338 "title": "Gets a list of Integration Reports",
13341 "title": "Example usage:",
13342 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13346 "name": "GetIntegration_Reports",
13347 "group": "Integration_Reports",
13348 "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>",
13349 "version": "0.0.0",
13350 "filename": "server/api/integrationReport/index.js",
13351 "groupTitle": "Integration_Reports"
13355 "url": "/api/integrations/reports/{id}",
13356 "title": "Gets a single Integration Report",
13359 "title": "Example usage:",
13360 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13364 "name": "ShowIntegration_Reports",
13365 "group": "Integration_Reports",
13366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13367 "version": "0.0.0",
13368 "filename": "server/api/integrationReport/index.js",
13369 "groupTitle": "Integration_Reports"
13373 "url": "/api/integrations/reports/{id}",
13374 "title": "Update an existing Integration Report",
13377 "title": "Example usage:",
13378 "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",
13382 "name": "updateIntegration_Reports",
13383 "group": "Integration_Reports",
13384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13385 "version": "0.0.0",
13386 "filename": "server/api/integrationReport/index.js",
13387 "groupTitle": "Integration_Reports"
13391 "url": "/api/intervals",
13392 "title": "Creates a new Interval",
13395 "title": "Example usage:",
13396 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13400 "name": "CreateIntervals",
13401 "group": "Intervals",
13416 "field": "description",
13423 "field": "interval",
13429 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13430 "version": "0.0.0",
13431 "filename": "server/api/interval/index.js",
13432 "groupTitle": "Intervals"
13436 "url": "/api/intervals/{id}",
13437 "title": "Deletes a Interval",
13440 "title": "Example usage:",
13441 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13445 "name": "DeleteIntervals",
13446 "group": "Intervals",
13447 "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>",
13448 "version": "0.0.0",
13449 "filename": "server/api/interval/index.js",
13450 "groupTitle": "Intervals"
13454 "url": "/api/intervals",
13455 "title": "Gets a list of Intervals",
13458 "title": "Example usage:",
13459 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13463 "name": "GetIntervals",
13464 "group": "Intervals",
13465 "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>",
13466 "version": "0.0.0",
13467 "filename": "server/api/interval/index.js",
13468 "groupTitle": "Intervals"
13472 "url": "/api/intervals/{id}",
13473 "title": "Gets a single Interval",
13476 "title": "Example usage:",
13477 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13481 "name": "ShowIntervals",
13482 "group": "Intervals",
13483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13484 "version": "0.0.0",
13485 "filename": "server/api/interval/index.js",
13486 "groupTitle": "Intervals"
13490 "url": "/api/intervals/{id}/sub_intervals",
13491 "title": "Creates a new sub interval",
13494 "title": "Example usage:",
13495 "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",
13499 "name": "addInterval",
13500 "group": "Intervals",
13501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13502 "version": "0.0.0",
13503 "filename": "server/api/interval/index.js",
13504 "groupTitle": "Intervals"
13508 "url": "/api/intervals/{id}/sub_intervals/create_many",
13509 "title": "Create new sub intervals set",
13512 "title": "Example usage:",
13513 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13517 "name": "addIntervals",
13518 "group": "Intervals",
13519 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13520 "version": "0.0.0",
13521 "filename": "server/api/interval/index.js",
13522 "groupTitle": "Intervals"
13526 "url": "/api/intervals/{id}/sub_intervals",
13527 "title": "Get sub intervals set",
13530 "title": "Example usage:",
13531 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13535 "name": "getIntervals",
13536 "group": "Intervals",
13537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13538 "version": "0.0.0",
13539 "filename": "server/api/interval/index.js",
13540 "groupTitle": "Intervals"
13544 "url": "/api/intervals/{id}",
13545 "title": "Update an existing Interval",
13548 "title": "Example usage:",
13549 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13553 "name": "updateIntervals",
13554 "group": "Intervals",
13555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13556 "version": "0.0.0",
13557 "filename": "server/api/interval/index.js",
13558 "groupTitle": "Intervals"
13562 "url": "/api/jira",
13563 "title": "Creates a new issue",
13566 "title": "Example usage:",
13567 "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}",
13571 "name": "Creates_Issue",
13583 "field": "issuetype",
13590 "field": "summary",
13597 "field": "description",
13603 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13604 "version": "0.0.0",
13605 "filename": "server/api/jira/index.js",
13606 "groupTitle": "Issue"
13610 "url": "/api/jscripty/answers/reports",
13611 "title": "Creates a new Report",
13614 "title": "Example usage:",
13615 "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",
13619 "name": "CreateReports",
13620 "group": "JscriptyAnswerReport",
13628 "field": "question",
13642 "field": "membername",
13649 "field": "projectname",
13663 "field": "uniqueid",
13670 "field": "calleridname",
13677 "field": "calleridnum",
13684 "field": "questionId",
13690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13691 "version": "0.0.0",
13692 "filename": "server/api/jscriptyAnswerReport/index.js",
13693 "groupTitle": "JscriptyAnswerReport"
13697 "url": "/api/jscripty/answers/reports/{id}",
13698 "title": "Deletes a Report",
13701 "title": "Example usage:",
13702 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
13706 "name": "DeleteReports",
13707 "group": "JscriptyAnswerReport",
13708 "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>",
13709 "version": "0.0.0",
13710 "filename": "server/api/jscriptyAnswerReport/index.js",
13711 "groupTitle": "JscriptyAnswerReport"
13715 "url": "/api/jscripty/answers/reports/describe",
13716 "title": "Gets table info about Reports",
13719 "title": "Example usage:",
13720 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
13724 "name": "DescribeReports",
13725 "group": "JscriptyAnswerReport",
13726 "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>",
13727 "version": "0.0.0",
13728 "filename": "server/api/jscriptyAnswerReport/index.js",
13729 "groupTitle": "JscriptyAnswerReport"
13733 "url": "/api/jscripty/answers/reports",
13734 "title": "Gets a list of Reports",
13737 "title": "Example usage:",
13738 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
13742 "name": "GetReports",
13743 "group": "JscriptyAnswerReport",
13744 "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>",
13745 "version": "0.0.0",
13746 "filename": "server/api/jscriptyAnswerReport/index.js",
13747 "groupTitle": "JscriptyAnswerReport"
13751 "url": "/api/jscripty/answers/reports/{id}",
13752 "title": "Gets a single Report",
13755 "title": "Example usage:",
13756 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
13760 "name": "ShowReports",
13761 "group": "JscriptyAnswerReport",
13762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13763 "version": "0.0.0",
13764 "filename": "server/api/jscriptyAnswerReport/index.js",
13765 "groupTitle": "JscriptyAnswerReport"
13769 "url": "/api/jscripty/answers/reports/{id}",
13770 "title": "Update an existing Report",
13773 "title": "Example usage:",
13774 "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",
13778 "name": "updateReports",
13779 "group": "JscriptyAnswerReport",
13780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13781 "version": "0.0.0",
13782 "filename": "server/api/jscriptyAnswerReport/index.js",
13783 "groupTitle": "JscriptyAnswerReport"
13787 "url": "/api/jscripty/questions/reports",
13788 "title": "Creates a new Report",
13791 "title": "Example usage:",
13792 "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",
13796 "name": "CreateReports",
13797 "group": "JscriptyQuestionReport",
13805 "field": "question",
13819 "field": "membername",
13826 "field": "projectname",
13840 "field": "uniqueid",
13847 "field": "calleridname",
13854 "field": "calleridnum",
13861 "field": "questionId",
13867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13868 "version": "0.0.0",
13869 "filename": "server/api/jscriptyQuestionReport/index.js",
13870 "groupTitle": "JscriptyQuestionReport"
13874 "url": "/api/jscripty/questions/reports/{id}",
13875 "title": "Deletes a Report",
13878 "title": "Example usage:",
13879 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
13883 "name": "DeleteReports",
13884 "group": "JscriptyQuestionReport",
13885 "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>",
13886 "version": "0.0.0",
13887 "filename": "server/api/jscriptyQuestionReport/index.js",
13888 "groupTitle": "JscriptyQuestionReport"
13892 "url": "/api/jscripty/questions/reports/describe",
13893 "title": "Gets table info about Reports",
13896 "title": "Example usage:",
13897 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
13901 "name": "DescribeReports",
13902 "group": "JscriptyQuestionReport",
13903 "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>",
13904 "version": "0.0.0",
13905 "filename": "server/api/jscriptyQuestionReport/index.js",
13906 "groupTitle": "JscriptyQuestionReport"
13910 "url": "/api/jscripty/questions/reports",
13911 "title": "Gets a list of Reports",
13914 "title": "Example usage:",
13915 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
13919 "name": "GetReports",
13920 "group": "JscriptyQuestionReport",
13921 "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>",
13922 "version": "0.0.0",
13923 "filename": "server/api/jscriptyQuestionReport/index.js",
13924 "groupTitle": "JscriptyQuestionReport"
13928 "url": "/api/jscripty/questions/reports/{id}",
13929 "title": "Gets a single Report",
13932 "title": "Example usage:",
13933 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
13937 "name": "ShowReports",
13938 "group": "JscriptyQuestionReport",
13939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13940 "version": "0.0.0",
13941 "filename": "server/api/jscriptyQuestionReport/index.js",
13942 "groupTitle": "JscriptyQuestionReport"
13946 "url": "/api/jscripty/questions/reports/{id}",
13947 "title": "Update an existing Report",
13950 "title": "Example usage:",
13951 "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",
13955 "name": "updateReports",
13956 "group": "JscriptyQuestionReport",
13957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13958 "version": "0.0.0",
13959 "filename": "server/api/jscriptyQuestionReport/index.js",
13960 "groupTitle": "JscriptyQuestionReport"
13964 "url": "/api/jscripty/sessions/reports",
13965 "title": "Creates a new Report",
13968 "title": "Example usage:",
13969 "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",
13973 "name": "CreateReports",
13974 "group": "JscriptySessionReport",
13982 "field": "starttime",
13989 "field": "endtime",
13996 "field": "membername",
14003 "field": "projectname",
14017 "field": "uniqueid",
14024 "field": "calleridname",
14031 "field": "calleridnum",
14038 "field": "completed",
14044 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14045 "version": "0.0.0",
14046 "filename": "server/api/jscriptySessionReport/index.js",
14047 "groupTitle": "JscriptySessionReport"
14051 "url": "/api/jscripty/sessions/reports/{id}",
14052 "title": "Deletes a Report",
14055 "title": "Example usage:",
14056 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14060 "name": "DeleteReports",
14061 "group": "JscriptySessionReport",
14062 "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>",
14063 "version": "0.0.0",
14064 "filename": "server/api/jscriptySessionReport/index.js",
14065 "groupTitle": "JscriptySessionReport"
14069 "url": "/api/jscripty/sessions/reports/describe",
14070 "title": "Gets table info about Reports",
14073 "title": "Example usage:",
14074 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14078 "name": "DescribeReports",
14079 "group": "JscriptySessionReport",
14080 "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>",
14081 "version": "0.0.0",
14082 "filename": "server/api/jscriptySessionReport/index.js",
14083 "groupTitle": "JscriptySessionReport"
14087 "url": "/api/jscripty/sessions/reports",
14088 "title": "Gets a list of Reports",
14091 "title": "Example usage:",
14092 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14096 "name": "GetReports",
14097 "group": "JscriptySessionReport",
14098 "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>",
14099 "version": "0.0.0",
14100 "filename": "server/api/jscriptySessionReport/index.js",
14101 "groupTitle": "JscriptySessionReport"
14105 "url": "/api/jscripty/sessions/reports/{id}",
14106 "title": "Gets a single Report",
14109 "title": "Example usage:",
14110 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14114 "name": "ShowReports",
14115 "group": "JscriptySessionReport",
14116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14117 "version": "0.0.0",
14118 "filename": "server/api/jscriptySessionReport/index.js",
14119 "groupTitle": "JscriptySessionReport"
14123 "url": "/api/jscripty/sessions/reports/{id}/questions",
14124 "title": "Gets Jscripty Session questions",
14127 "title": "Example usage:",
14128 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14132 "name": "getQuestions",
14133 "group": "JscriptySessionReport",
14134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14135 "version": "0.0.0",
14136 "filename": "server/api/jscriptySessionReport/index.js",
14137 "groupTitle": "JscriptySessionReport"
14141 "url": "/api/jscripty/sessions/reports/{id}",
14142 "title": "Update an existing Report",
14145 "title": "Example usage:",
14146 "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",
14150 "name": "updateReports",
14151 "group": "JscriptySessionReport",
14152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14153 "version": "0.0.0",
14154 "filename": "server/api/jscriptySessionReport/index.js",
14155 "groupTitle": "JscriptySessionReport"
14159 "url": "/api/jscripty/projects/clone",
14160 "title": "Clone an existing Project",
14163 "title": "Example usage:",
14164 "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",
14168 "name": "CloneProjects",
14169 "group": "Jscripty_Projects",
14170 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14171 "version": "0.0.0",
14172 "filename": "server/api/jscriptyProject/index.js",
14173 "groupTitle": "Jscripty_Projects"
14177 "url": "/api/jscripty/projects",
14178 "title": "Creates a new Project",
14181 "title": "Example usage:",
14182 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14186 "name": "CreateProjects",
14187 "group": "Jscripty_Projects",
14202 "field": "description",
14209 "field": "formData",
14216 "field": "enableUncompleteSave",
14223 "field": "sendUnpauseOnSubmit",
14229 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14230 "version": "0.0.0",
14231 "filename": "server/api/jscriptyProject/index.js",
14232 "groupTitle": "Jscripty_Projects"
14236 "url": "/api/jscripty/projects/{id}",
14237 "title": "Deletes a Project",
14240 "title": "Example usage:",
14241 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14245 "name": "DeleteProjects",
14246 "group": "Jscripty_Projects",
14247 "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>",
14248 "version": "0.0.0",
14249 "filename": "server/api/jscriptyProject/index.js",
14250 "groupTitle": "Jscripty_Projects"
14254 "url": "/api/jscripty/projects",
14255 "title": "Gets a list of Projects",
14258 "title": "Example usage:",
14259 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14263 "name": "GetProjects",
14264 "group": "Jscripty_Projects",
14265 "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>",
14266 "version": "0.0.0",
14267 "filename": "server/api/jscriptyProject/index.js",
14268 "groupTitle": "Jscripty_Projects"
14272 "url": "/api/jscripty/projects/{id}",
14273 "title": "Gets a single Project",
14276 "title": "Example usage:",
14277 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14281 "name": "ShowProjects",
14282 "group": "Jscripty_Projects",
14283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14284 "version": "0.0.0",
14285 "filename": "server/api/jscriptyProject/index.js",
14286 "groupTitle": "Jscripty_Projects"
14290 "url": "/api/jscripty/projects/{id}/answers",
14291 "title": "Gets jscripty project answers",
14294 "title": "Example usage:",
14295 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14299 "name": "getAnswers",
14300 "group": "Jscripty_Projects",
14301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14302 "version": "0.0.0",
14303 "filename": "server/api/jscriptyProject/index.js",
14304 "groupTitle": "Jscripty_Projects"
14308 "url": "/api/jscripty/projects/{id}/sessions",
14309 "title": "Gets jscripty project sessions",
14312 "title": "Example usage:",
14313 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14317 "name": "getSessions",
14318 "group": "Jscripty_Projects",
14319 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14320 "version": "0.0.0",
14321 "filename": "server/api/jscriptyProject/index.js",
14322 "groupTitle": "Jscripty_Projects"
14326 "url": "/api/jscripty/projects/{id}/summary",
14327 "title": "Gets jscripty project summary",
14330 "title": "Example usage:",
14331 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14335 "name": "getSummary",
14336 "group": "Jscripty_Projects",
14337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14338 "version": "0.0.0",
14339 "filename": "server/api/jscriptyProject/index.js",
14340 "groupTitle": "Jscripty_Projects"
14344 "url": "/api/jscripty/projects/{id}",
14345 "title": "Update an existing Project",
14348 "title": "Example usage:",
14349 "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",
14353 "name": "updateProjects",
14354 "group": "Jscripty_Projects",
14355 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14356 "version": "0.0.0",
14357 "filename": "server/api/jscriptyProject/index.js",
14358 "groupTitle": "Jscripty_Projects"
14362 "url": "/api/license",
14363 "title": "Gets License Info",
14366 "title": "Example usage:",
14367 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14372 "group": "License",
14373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14374 "version": "0.0.0",
14375 "filename": "server/api/license/index.js",
14376 "groupTitle": "License"
14380 "url": "/api/license/{id}",
14381 "title": "Update License Info",
14384 "title": "Example usage:",
14385 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14390 "group": "License",
14391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14392 "version": "0.0.0",
14393 "filename": "server/api/license/index.js",
14394 "groupTitle": "License"
14398 "url": "/api/mail/accounts/{id}/users",
14399 "title": "Add agents to a mail account",
14402 "title": "Example usage:",
14403 "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",
14407 "name": "AddAgents",
14408 "group": "Mail_Accounts",
14409 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14410 "version": "0.0.0",
14411 "filename": "server/api/mailAccount/index.js",
14412 "groupTitle": "Mail_Accounts"
14416 "url": "/api/mail/accounts/{id}/in_servers",
14417 "title": "Creates a new IMAP server",
14420 "title": "Example usage:",
14421 "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",
14426 "group": "Mail_Accounts",
14434 "field": "description",
14448 "field": "authentication",
14462 "field": "password",
14483 "field": "mailbox",
14490 "field": "connTimeout",
14497 "field": "authTimeout",
14504 "field": "service",
14510 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14511 "version": "0.0.0",
14512 "filename": "server/api/mailAccount/index.js",
14513 "groupTitle": "Mail_Accounts"
14517 "url": "/api/mail/accounts/{id}/out_servers",
14518 "title": "Creates a new SMTP server",
14521 "title": "Example usage:",
14522 "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",
14527 "group": "Mail_Accounts",
14535 "field": "description",
14577 "field": "service",
14584 "field": "authentication",
14590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14591 "version": "0.0.0",
14592 "filename": "server/api/mailAccount/index.js",
14593 "groupTitle": "Mail_Accounts"
14597 "url": "/api/mail/accounts/{id}",
14598 "title": "Deletes a mail account",
14601 "title": "Example usage:",
14602 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14606 "name": "DeleteMailAccounts",
14607 "group": "Mail_Accounts",
14608 "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>",
14609 "version": "0.0.0",
14610 "filename": "server/api/mailAccount/index.js",
14611 "groupTitle": "Mail_Accounts"
14615 "url": "/api/mail/accounts/describe",
14616 "title": "Gets table info about Accounts",
14619 "title": "Example usage:",
14620 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14624 "name": "DescribeAccounts",
14625 "group": "Mail_Accounts",
14626 "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>",
14627 "version": "0.0.0",
14628 "filename": "server/api/mailAccount/index.js",
14629 "groupTitle": "Mail_Accounts"
14633 "url": "/api/mail/accounts",
14634 "title": "Gets a list of Accounts",
14637 "title": "Example usage:",
14638 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14642 "name": "GetAccounts",
14643 "group": "Mail_Accounts",
14644 "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>",
14645 "version": "0.0.0",
14646 "filename": "server/api/mailAccount/index.js",
14647 "groupTitle": "Mail_Accounts"
14651 "url": "/api/mail/accounts/{id}/users",
14652 "title": "Gets agents from mail account",
14655 "title": "Example usage:",
14656 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14660 "name": "GetAgents",
14661 "group": "Mail_Accounts",
14662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14663 "version": "0.0.0",
14664 "filename": "server/api/mailAccount/index.js",
14665 "groupTitle": "Mail_Accounts"
14669 "url": "/api/mail/accounts/{id}/in_servers",
14670 "title": "Gets account IMAP server",
14673 "title": "Example usage:",
14674 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14679 "group": "Mail_Accounts",
14680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14681 "version": "0.0.0",
14682 "filename": "server/api/mailAccount/index.js",
14683 "groupTitle": "Mail_Accounts"
14687 "url": "/api/mail/accounts/{id}/out_servers",
14688 "title": "Gets account SMTP server",
14691 "title": "Example usage:",
14692 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14697 "group": "Mail_Accounts",
14698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14699 "version": "0.0.0",
14700 "filename": "server/api/mailAccount/index.js",
14701 "groupTitle": "Mail_Accounts"
14705 "url": "/api/mail/accounts/{id}/users",
14706 "title": "Removes agents from a mail account",
14709 "title": "Example usage:",
14710 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14714 "name": "RemoveAgents",
14715 "group": "Mail_Accounts",
14716 "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>",
14717 "version": "0.0.0",
14718 "filename": "server/api/mailAccount/index.js",
14719 "groupTitle": "Mail_Accounts"
14723 "url": "/api/mail/accounts/{id}/canned_answers",
14724 "title": "Removes canned answers from account",
14727 "title": "Example usage:",
14728 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14732 "name": "RemoveAnswers",
14733 "group": "Mail_Accounts",
14734 "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>",
14735 "version": "0.0.0",
14736 "filename": "server/api/mailAccount/index.js",
14737 "groupTitle": "Mail_Accounts"
14741 "url": "/api/mail/accounts/{id}/dispositions",
14742 "title": "Removes dispositions from account",
14745 "title": "Example usage:",
14746 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14750 "name": "RemoveDispositions",
14751 "group": "Mail_Accounts",
14752 "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>",
14753 "version": "0.0.0",
14754 "filename": "server/api/mailAccount/index.js",
14755 "groupTitle": "Mail_Accounts"
14759 "url": "/api/mail/accounts/{id}/in_servers",
14760 "title": "Removes IMAP server from an account",
14763 "title": "Example usage:",
14764 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
14768 "name": "RemoveImmap",
14769 "group": "Mail_Accounts",
14770 "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>",
14771 "version": "0.0.0",
14772 "filename": "server/api/mailAccount/index.js",
14773 "groupTitle": "Mail_Accounts"
14777 "url": "/api/mail/accounts/{id}/out_servers",
14778 "title": "Removes SMTP server from an account",
14781 "title": "Example usage:",
14782 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
14786 "name": "RemoveSmtp",
14787 "group": "Mail_Accounts",
14788 "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>",
14789 "version": "0.0.0",
14790 "filename": "server/api/mailAccount/index.js",
14791 "groupTitle": "Mail_Accounts"
14795 "url": "/api/mail/accounts/{id}",
14796 "title": "Gets a single Account",
14799 "title": "Example usage:",
14800 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
14804 "name": "ShowAccounts",
14805 "group": "Mail_Accounts",
14806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14807 "version": "0.0.0",
14808 "filename": "server/api/mailAccount/index.js",
14809 "groupTitle": "Mail_Accounts"
14813 "url": "/api/mail/accounts/{id}/canned_answers",
14814 "title": "Creates new canned answer",
14817 "title": "Example usage:",
14818 "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",
14822 "name": "addAnswer",
14823 "group": "Mail_Accounts",
14845 "field": "description",
14858 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14859 "version": "0.0.0",
14860 "filename": "server/api/mailAccount/index.js",
14861 "groupTitle": "Mail_Accounts"
14865 "url": "/api/mail/accounts/{id}/applications",
14866 "title": "Creates new applications",
14869 "title": "Example usage:",
14870 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14874 "name": "addApplications",
14875 "group": "Mail_Accounts",
14883 "field": "priority",
14897 "field": "appdata",
14904 "field": "description",
14911 "field": "interval",
14917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14918 "version": "0.0.0",
14919 "filename": "server/api/mailAccount/index.js",
14920 "groupTitle": "Mail_Accounts"
14924 "url": "/api/mail/accounts/{id}/dispositions",
14925 "title": "Creates new disposition",
14928 "title": "Example usage:",
14929 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14933 "name": "addDisposition",
14934 "group": "Mail_Accounts",
14948 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14949 "version": "0.0.0",
14950 "filename": "server/api/mailAccount/index.js",
14951 "groupTitle": "Mail_Accounts"
14955 "url": "/api/mail/accounts/{id}/interactions",
14956 "title": "Creates new interactions",
14959 "title": "Example usage:",
14960 "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",
14964 "name": "addInteraction",
14965 "group": "Mail_Accounts",
14980 "field": "closedAt",
14987 "field": "disposition",
15001 "field": "inReplyTo",
15022 "field": "subject",
15036 "field": "read1stAt",
15043 "field": "substatus",
15050 "field": "substatusAt",
15061 "field": "firstMsgDirection",
15068 "field": "lastMsgAt",
15079 "field": "lastMsgDirection",
15086 "field": "lastMsgBody",
15093 "field": "lastMsgText",
15099 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15100 "version": "0.0.0",
15101 "filename": "server/api/mailAccount/index.js",
15102 "groupTitle": "Mail_Accounts"
15106 "url": "/api/mail/accounts",
15107 "title": "Create a mail account",
15110 "title": "Example usage:",
15111 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15116 "group": "Mail_Accounts",
15117 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15118 "version": "0.0.0",
15119 "filename": "server/api/mailAccount/index.js",
15120 "groupTitle": "Mail_Accounts"
15124 "url": "/api/mail/accounts/{id}/canned_answers",
15125 "title": "Gets account canned answers",
15128 "title": "Example usage:",
15129 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15133 "name": "getAnswers",
15134 "group": "Mail_Accounts",
15135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15136 "version": "0.0.0",
15137 "filename": "server/api/mailAccount/index.js",
15138 "groupTitle": "Mail_Accounts"
15142 "url": "/api/mail/accounts/{id}/applications",
15143 "title": "Gets account applications",
15146 "title": "Example usage:",
15147 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15151 "name": "getApplications",
15152 "group": "Mail_Accounts",
15153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15154 "version": "0.0.0",
15155 "filename": "server/api/mailAccount/index.js",
15156 "groupTitle": "Mail_Accounts"
15160 "url": "/api/mail/accounts/{id}/dispositions",
15161 "title": "Gets account dispositions",
15164 "title": "Example usage:",
15165 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15169 "name": "getDispositions",
15170 "group": "Mail_Accounts",
15171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15172 "version": "0.0.0",
15173 "filename": "server/api/mailAccount/index.js",
15174 "groupTitle": "Mail_Accounts"
15178 "url": "/api/mail/accounts/{id}/interactions",
15179 "title": "Gets account interactions",
15182 "title": "Example usage:",
15183 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15187 "name": "getInteraction",
15188 "group": "Mail_Accounts",
15189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15190 "version": "0.0.0",
15191 "filename": "server/api/mailAccount/index.js",
15192 "groupTitle": "Mail_Accounts"
15196 "url": "/api/mail/accounts/{id}/messages",
15197 "title": "Gets account messages",
15200 "title": "Example usage:",
15201 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15205 "name": "getMessages",
15206 "group": "Mail_Accounts",
15207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15208 "version": "0.0.0",
15209 "filename": "server/api/mailAccount/index.js",
15210 "groupTitle": "Mail_Accounts"
15214 "url": "/api/mail/accounts/{id}/send",
15215 "title": "Send new mail",
15218 "title": "Example usage:",
15219 "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",
15223 "name": "sendMail",
15224 "group": "Mail_Accounts",
15225 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15226 "version": "0.0.0",
15227 "filename": "server/api/mailAccount/index.js",
15228 "groupTitle": "Mail_Accounts"
15232 "url": "/api/mail/accounts/{id}",
15233 "title": "Update an existing Account",
15236 "title": "Example usage:",
15237 "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",
15241 "name": "updateAccounts",
15242 "group": "Mail_Accounts",
15243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15244 "version": "0.0.0",
15245 "filename": "server/api/mailAccount/index.js",
15246 "groupTitle": "Mail_Accounts"
15250 "url": "/api/mail/accounts/{id}/verify",
15251 "title": "Verify mail account",
15254 "title": "Example usage:",
15255 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15259 "name": "verifySmtp",
15260 "group": "Mail_Accounts",
15261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15262 "version": "0.0.0",
15263 "filename": "server/api/mailAccount/index.js",
15264 "groupTitle": "Mail_Accounts"
15268 "url": "/api/mail/applications/{id}",
15269 "title": "Deletes a Application",
15272 "title": "Example usage:",
15273 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15277 "name": "DeleteApplications",
15278 "group": "Mail_Applications",
15279 "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>",
15280 "version": "0.0.0",
15281 "filename": "server/api/mailApplication/index.js",
15282 "groupTitle": "Mail_Applications"
15286 "url": "/api/mail/applications/{id}",
15287 "title": "Gets a single Application",
15290 "title": "Example usage:",
15291 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15295 "name": "ShowApplications",
15296 "group": "Mail_Applications",
15297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15298 "version": "0.0.0",
15299 "filename": "server/api/mailApplication/index.js",
15300 "groupTitle": "Mail_Applications"
15304 "url": "/api/mail/applications/{id}",
15305 "title": "Update an existing Application",
15308 "title": "Example usage:",
15309 "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",
15313 "name": "updateApplications",
15314 "group": "Mail_Applications",
15315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15316 "version": "0.0.0",
15317 "filename": "server/api/mailApplication/index.js",
15318 "groupTitle": "Mail_Applications"
15322 "url": "/api/mail/interactions/{id}/tags",
15323 "title": "Add tags to the interaction",
15326 "title": "Example usage:",
15327 "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",
15332 "group": "Mail_Interactions",
15333 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15334 "version": "0.0.0",
15335 "filename": "server/api/mailInteraction/index.js",
15336 "groupTitle": "Mail_Interactions"
15340 "url": "/api/mail/interactions",
15341 "title": "Creates a new Interaction",
15344 "title": "Example usage:",
15345 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15349 "name": "CreateInteractions",
15350 "group": "Mail_Interactions",
15365 "field": "closedAt",
15372 "field": "disposition",
15386 "field": "inReplyTo",
15407 "field": "subject",
15421 "field": "read1stAt",
15428 "field": "substatus",
15435 "field": "substatusAt",
15446 "field": "firstMsgDirection",
15453 "field": "lastMsgAt",
15464 "field": "lastMsgDirection",
15471 "field": "lastMsgBody",
15478 "field": "lastMsgText",
15484 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15485 "version": "0.0.0",
15486 "filename": "server/api/mailInteraction/index.js",
15487 "groupTitle": "Mail_Interactions"
15491 "url": "/api/mail/interactions/{id}",
15492 "title": "Deletes a Interaction",
15495 "title": "Example usage:",
15496 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15500 "name": "DeleteInteractions",
15501 "group": "Mail_Interactions",
15502 "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>",
15503 "version": "0.0.0",
15504 "filename": "server/api/mailInteraction/index.js",
15505 "groupTitle": "Mail_Interactions"
15509 "url": "/api/mail/interactions/describe",
15510 "title": "Gets table info about Interactions",
15513 "title": "Example usage:",
15514 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15518 "name": "DescribeInteractions",
15519 "group": "Mail_Interactions",
15520 "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>",
15521 "version": "0.0.0",
15522 "filename": "server/api/mailInteraction/index.js",
15523 "groupTitle": "Mail_Interactions"
15527 "url": "/api/mail/interactions",
15528 "title": "Gets a list of Interactions",
15531 "title": "Example usage:",
15532 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15536 "name": "GetInteractions",
15537 "group": "Mail_Interactions",
15538 "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>",
15539 "version": "0.0.0",
15540 "filename": "server/api/mailInteraction/index.js",
15541 "groupTitle": "Mail_Interactions"
15545 "url": "/api/mail/interactions/{id}/tags",
15546 "title": "Removes tags from interaction",
15549 "title": "Example usage:",
15550 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15554 "name": "RemoveTags",
15555 "group": "Mail_Interactions",
15556 "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>",
15557 "version": "0.0.0",
15558 "filename": "server/api/mailInteraction/index.js",
15559 "groupTitle": "Mail_Interactions"
15563 "url": "/api/mail/interactions/{id}",
15564 "title": "Gets a single Interaction",
15567 "title": "Example usage:",
15568 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15572 "name": "ShowInteractions",
15573 "group": "Mail_Interactions",
15574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15575 "version": "0.0.0",
15576 "filename": "server/api/mailInteraction/index.js",
15577 "groupTitle": "Mail_Interactions"
15581 "url": "/api/mail/interactions/{id}/messages",
15582 "title": "Creates new message",
15585 "title": "Example usage:",
15586 "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",
15590 "name": "addMessage",
15591 "group": "Mail_Interactions",
15606 "field": "plainBody",
15624 "field": "direction",
15631 "field": "messageId",
15666 "field": "subject",
15701 "field": "originTo",
15708 "field": "originCc",
15714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715 "version": "0.0.0",
15716 "filename": "server/api/mailInteraction/index.js",
15717 "groupTitle": "Mail_Interactions"
15721 "url": "/api/mail/interactions/{id}/download",
15722 "title": "Gets interaction",
15725 "title": "Example usage:",
15726 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
15730 "name": "download",
15731 "group": "Mail_Interactions",
15732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15733 "version": "0.0.0",
15734 "filename": "server/api/mailInteraction/index.js",
15735 "groupTitle": "Mail_Interactions"
15739 "url": "/api/mail/interactions/{id}/messages",
15740 "title": "Gets interaction messages",
15743 "title": "Example usage:",
15744 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
15748 "name": "getMessages",
15749 "group": "Mail_Interactions",
15750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15751 "version": "0.0.0",
15752 "filename": "server/api/mailInteraction/index.js",
15753 "groupTitle": "Mail_Interactions"
15757 "url": "/api/mail/interactions/{id}",
15758 "title": "Update an existing Interaction",
15761 "title": "Example usage:",
15762 "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",
15766 "name": "updateInteractions",
15767 "group": "Mail_Interactions",
15768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15769 "version": "0.0.0",
15770 "filename": "server/api/mailInteraction/index.js",
15771 "groupTitle": "Mail_Interactions"
15775 "url": "/api/mail/messages/{id}",
15776 "title": "Deletes a Message",
15779 "title": "Example usage:",
15780 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
15784 "name": "DeleteMessages",
15785 "group": "Mail_Messages",
15786 "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>",
15787 "version": "0.0.0",
15788 "filename": "server/api/mailMessage/index.js",
15789 "groupTitle": "Mail_Messages"
15793 "url": "/api/mail/messages/describe",
15794 "title": "Gets table info about Messages",
15797 "title": "Example usage:",
15798 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
15802 "name": "DescribeMessages",
15803 "group": "Mail_Messages",
15804 "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>",
15805 "version": "0.0.0",
15806 "filename": "server/api/mailMessage/index.js",
15807 "groupTitle": "Mail_Messages"
15811 "url": "/api/mail/messages",
15812 "title": "Gets a list of Messages",
15815 "title": "Example usage:",
15816 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
15820 "name": "GetMessages",
15821 "group": "Mail_Messages",
15822 "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>",
15823 "version": "0.0.0",
15824 "filename": "server/api/mailMessage/index.js",
15825 "groupTitle": "Mail_Messages"
15829 "url": "/api/mail/messages/{id}",
15830 "title": "Gets a single Message",
15833 "title": "Example usage:",
15834 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
15838 "name": "ShowMessages",
15839 "group": "Mail_Messages",
15840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15841 "version": "0.0.0",
15842 "filename": "server/api/mailMessage/index.js",
15843 "groupTitle": "Mail_Messages"
15847 "url": "/api/mail/messages/{id}/accept",
15848 "title": "Accepts message",
15851 "title": "Example usage:",
15852 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
15856 "name": "acceptMessage",
15857 "group": "Mail_Messages",
15858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15859 "version": "0.0.0",
15860 "filename": "server/api/mailMessage/index.js",
15861 "groupTitle": "Mail_Messages"
15865 "url": "/api/mail/messages",
15866 "title": "Create a message",
15869 "title": "Example usage:",
15870 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15874 "name": "createMessage",
15875 "group": "Mail_Messages",
15876 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15877 "version": "0.0.0",
15878 "filename": "server/api/mailMessage/index.js",
15879 "groupTitle": "Mail_Messages"
15883 "url": "/api/mail/messages/{id}/download",
15884 "title": "Gets message",
15887 "title": "Example usage:",
15888 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
15892 "name": "download",
15893 "group": "Mail_Messages",
15894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15895 "version": "0.0.0",
15896 "filename": "server/api/mailMessage/index.js",
15897 "groupTitle": "Mail_Messages"
15901 "url": "/api/mail/messages/{id}/reject",
15902 "title": "Rejects message",
15905 "title": "Example usage:",
15906 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
15910 "name": "rejectMessage",
15911 "group": "Mail_Messages",
15912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15913 "version": "0.0.0",
15914 "filename": "server/api/mailMessage/index.js",
15915 "groupTitle": "Mail_Messages"
15919 "url": "/api/mail/messages/{id}",
15920 "title": "Update an existing Message",
15923 "title": "Example usage:",
15924 "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",
15928 "name": "updateMessages",
15929 "group": "Mail_Messages",
15930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15931 "version": "0.0.0",
15932 "filename": "server/api/mailMessage/index.js",
15933 "groupTitle": "Mail_Messages"
15937 "url": "/api/mail/reports/queue",
15938 "title": "Creates a new Mail Queue Report",
15941 "title": "Example usage:",
15942 "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",
15946 "name": "CreateMail_Queue_Reports",
15947 "group": "Mail_Queue_Reports",
15955 "field": "uniqueid",
15976 "field": "leaveAt",
15983 "field": "acceptAt",
16003 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16004 "version": "0.0.0",
16005 "filename": "server/api/mailQueueReport/index.js",
16006 "groupTitle": "Mail_Queue_Reports"
16010 "url": "/api/mail/reports/queue/{id}",
16011 "title": "Deletes a Mail Queue Report",
16014 "title": "Example usage:",
16015 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16019 "name": "DeleteMail_Queue_Reports",
16020 "group": "Mail_Queue_Reports",
16021 "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>",
16022 "version": "0.0.0",
16023 "filename": "server/api/mailQueueReport/index.js",
16024 "groupTitle": "Mail_Queue_Reports"
16028 "url": "/api/mail/reports/queue/describe",
16029 "title": "Gets table info about Mail Queue Reports",
16032 "title": "Example usage:",
16033 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16037 "name": "DescribeMail_Queue_Reports",
16038 "group": "Mail_Queue_Reports",
16039 "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>",
16040 "version": "0.0.0",
16041 "filename": "server/api/mailQueueReport/index.js",
16042 "groupTitle": "Mail_Queue_Reports"
16046 "url": "/api/mail/reports/queue",
16047 "title": "Gets a list of Mail Queue Reports",
16050 "title": "Example usage:",
16051 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16055 "name": "GetMail_Queue_Reports",
16056 "group": "Mail_Queue_Reports",
16057 "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>",
16058 "version": "0.0.0",
16059 "filename": "server/api/mailQueueReport/index.js",
16060 "groupTitle": "Mail_Queue_Reports"
16064 "url": "/api/mail/reports/queue/{id}",
16065 "title": "Gets a single Mail Queue Report",
16068 "title": "Example usage:",
16069 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16073 "name": "ShowMail_Queue_Reports",
16074 "group": "Mail_Queue_Reports",
16075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16076 "version": "0.0.0",
16077 "filename": "server/api/mailQueueReport/index.js",
16078 "groupTitle": "Mail_Queue_Reports"
16082 "url": "/api/mail/reports/queue/{id}",
16083 "title": "Update an existing Mail Queue Report",
16086 "title": "Example usage:",
16087 "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",
16091 "name": "updateMail_Queue_Reports",
16092 "group": "Mail_Queue_Reports",
16093 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16094 "version": "0.0.0",
16095 "filename": "server/api/mailQueueReport/index.js",
16096 "groupTitle": "Mail_Queue_Reports"
16100 "url": "/api/mail/queues/{id}/users",
16101 "title": "Add agents to a queue",
16104 "title": "Example usage:",
16105 "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",
16109 "name": "AddAgents",
16110 "group": "Mail_Queues",
16111 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16112 "version": "0.0.0",
16113 "filename": "server/api/mailQueue/index.js",
16114 "groupTitle": "Mail_Queues"
16118 "url": "/api/mail/queues/{id}/teams",
16119 "title": "Add teams to a queue",
16122 "title": "Example usage:",
16123 "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",
16127 "name": "AddTeams",
16128 "group": "Mail_Queues",
16129 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16130 "version": "0.0.0",
16131 "filename": "server/api/mailQueue/index.js",
16132 "groupTitle": "Mail_Queues"
16136 "url": "/api/mail/queues",
16137 "title": "Creates a new Queue",
16140 "title": "Example usage:",
16141 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16145 "name": "CreateQueues",
16146 "group": "Mail_Queues",
16161 "field": "description",
16168 "field": "timeout",
16180 "field": "strategy",
16186 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16187 "version": "0.0.0",
16188 "filename": "server/api/mailQueue/index.js",
16189 "groupTitle": "Mail_Queues"
16193 "url": "/api/mail/queues/{id}",
16194 "title": "Deletes a Queue",
16197 "title": "Example usage:",
16198 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16202 "name": "DeleteQueues",
16203 "group": "Mail_Queues",
16204 "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>",
16205 "version": "0.0.0",
16206 "filename": "server/api/mailQueue/index.js",
16207 "groupTitle": "Mail_Queues"
16211 "url": "/api/mail/queues/describe",
16212 "title": "Gets table info about Queues",
16215 "title": "Example usage:",
16216 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16220 "name": "DescribeQueues",
16221 "group": "Mail_Queues",
16222 "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>",
16223 "version": "0.0.0",
16224 "filename": "server/api/mailQueue/index.js",
16225 "groupTitle": "Mail_Queues"
16229 "url": "/api/mail/queues/{id}/users",
16230 "title": "Gets queue agents",
16233 "title": "Example usage:",
16234 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16238 "name": "GetAgents",
16239 "group": "Mail_Queues",
16240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16241 "version": "0.0.0",
16242 "filename": "server/api/mailQueue/index.js",
16243 "groupTitle": "Mail_Queues"
16247 "url": "/api/mail/queues/{id}/members",
16248 "title": "GetMembers",
16251 "title": "Example usage:",
16252 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16256 "name": "GetMembers",
16257 "group": "Mail_Queues",
16258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16259 "version": "0.0.0",
16260 "filename": "server/api/mailQueue/index.js",
16261 "groupTitle": "Mail_Queues"
16265 "url": "/api/mail/queues",
16266 "title": "Gets a list of Queues",
16269 "title": "Example usage:",
16270 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16274 "name": "GetQueues",
16275 "group": "Mail_Queues",
16276 "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>",
16277 "version": "0.0.0",
16278 "filename": "server/api/mailQueue/index.js",
16279 "groupTitle": "Mail_Queues"
16283 "url": "/api/mail/queues/{id}/teams",
16284 "title": "Gets queues list",
16287 "title": "Example usage:",
16288 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16292 "name": "GetTeams",
16293 "group": "Mail_Queues",
16294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16295 "version": "0.0.0",
16296 "filename": "server/api/mailQueue/index.js",
16297 "groupTitle": "Mail_Queues"
16301 "url": "/api/mail/queues/{id}/users",
16302 "title": "Removes agents from a queue",
16305 "title": "Example usage:",
16306 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16310 "name": "RemoveAgents",
16311 "group": "Mail_Queues",
16312 "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>",
16313 "version": "0.0.0",
16314 "filename": "server/api/mailQueue/index.js",
16315 "groupTitle": "Mail_Queues"
16319 "url": "/api/mail/queues/{id}",
16320 "title": "Gets a single Queue",
16323 "title": "Example usage:",
16324 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16328 "name": "ShowQueues",
16329 "group": "Mail_Queues",
16330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16331 "version": "0.0.0",
16332 "filename": "server/api/mailQueue/index.js",
16333 "groupTitle": "Mail_Queues"
16337 "url": "/api/mail/queues/{id}",
16338 "title": "Update an existing Queue",
16341 "title": "Example usage:",
16342 "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",
16346 "name": "updateQueues",
16347 "group": "Mail_Queues",
16348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16349 "version": "0.0.0",
16350 "filename": "server/api/mailQueue/index.js",
16351 "groupTitle": "Mail_Queues"
16355 "url": "/api/mail/out_servers",
16356 "title": "Creates a new SMTP",
16359 "title": "Example usage:",
16360 "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",
16364 "name": "CreateSMTPs",
16365 "group": "Mail_SMTP",
16373 "field": "description",
16415 "field": "service",
16422 "field": "authentication",
16428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16429 "version": "0.0.0",
16430 "filename": "server/api/mailServerOut/index.js",
16431 "groupTitle": "Mail_SMTP"
16435 "url": "/api/mail/out_servers/{id}",
16436 "title": "Deletes a SMTP",
16439 "title": "Example usage:",
16440 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16444 "name": "DeleteSMTPs",
16445 "group": "Mail_SMTP",
16446 "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>",
16447 "version": "0.0.0",
16448 "filename": "server/api/mailServerOut/index.js",
16449 "groupTitle": "Mail_SMTP"
16453 "url": "/api/mail/out_servers",
16454 "title": "Gets a list of SMTPs",
16457 "title": "Example usage:",
16458 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16462 "name": "GetSMTPs",
16463 "group": "Mail_SMTP",
16464 "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>",
16465 "version": "0.0.0",
16466 "filename": "server/api/mailServerOut/index.js",
16467 "groupTitle": "Mail_SMTP"
16471 "url": "/api/mail/out_servers/{id}",
16472 "title": "Gets a single SMTP",
16475 "title": "Example usage:",
16476 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16480 "name": "ShowSMTPs",
16481 "group": "Mail_SMTP",
16482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16483 "version": "0.0.0",
16484 "filename": "server/api/mailServerOut/index.js",
16485 "groupTitle": "Mail_SMTP"
16489 "url": "/api/mail/out_servers/{id}",
16490 "title": "Update an existing SMTP",
16493 "title": "Example usage:",
16494 "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",
16498 "name": "updateSMTPs",
16499 "group": "Mail_SMTP",
16500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16501 "version": "0.0.0",
16502 "filename": "server/api/mailServerOut/index.js",
16503 "groupTitle": "Mail_SMTP"
16507 "url": "/api/mail/substatuses",
16508 "title": "Creates a new Queue",
16511 "title": "Example usage:",
16512 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16516 "name": "CreateSubstatuses",
16517 "group": "Mail_Substatuses",
16532 "field": "description",
16538 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16539 "version": "0.0.0",
16540 "filename": "server/api/mailSubstatus/index.js",
16541 "groupTitle": "Mail_Substatuses"
16545 "url": "/api/mail/substatuses/{id}",
16546 "title": "Deletes a Queue",
16549 "title": "Example usage:",
16550 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16554 "name": "DeleteSubstatuses",
16555 "group": "Mail_Substatuses",
16556 "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>",
16557 "version": "0.0.0",
16558 "filename": "server/api/mailSubstatus/index.js",
16559 "groupTitle": "Mail_Substatuses"
16563 "url": "/api/mail/substatuses/describe",
16564 "title": "Gets table info about Substatuses",
16567 "title": "Example usage:",
16568 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16572 "name": "DescribeSubstatuses",
16573 "group": "Mail_Substatuses",
16574 "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>",
16575 "version": "0.0.0",
16576 "filename": "server/api/mailSubstatus/index.js",
16577 "groupTitle": "Mail_Substatuses"
16581 "url": "/api/mail/substatuses",
16582 "title": "Gets a list of Substatuses",
16585 "title": "Example usage:",
16586 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16590 "name": "GetSubstatuses",
16591 "group": "Mail_Substatuses",
16592 "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>",
16593 "version": "0.0.0",
16594 "filename": "server/api/mailSubstatus/index.js",
16595 "groupTitle": "Mail_Substatuses"
16599 "url": "/api/mail/substatuses/{id}",
16600 "title": "Gets a single Queue",
16603 "title": "Example usage:",
16604 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16608 "name": "ShowSubstatuses",
16609 "group": "Mail_Substatuses",
16610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16611 "version": "0.0.0",
16612 "filename": "server/api/mailSubstatus/index.js",
16613 "groupTitle": "Mail_Substatuses"
16617 "url": "/api/mail/substatuses/{id}",
16618 "title": "Update an existing Queue",
16621 "title": "Example usage:",
16622 "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",
16626 "name": "updateSubstatuses",
16627 "group": "Mail_Substatuses",
16628 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16629 "version": "0.0.0",
16630 "filename": "server/api/mailSubstatus/index.js",
16631 "groupTitle": "Mail_Substatuses"
16635 "url": "/api/mail/reports/transfer",
16636 "title": "Creates a new Mail Transfer Report",
16639 "title": "Example usage:",
16640 "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",
16644 "name": "CreateMail_Transfer_Reports",
16645 "group": "Mail_Transfer_Reports",
16653 "field": "uniqueid",
16672 "field": "transferredAt",
16678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679 "version": "0.0.0",
16680 "filename": "server/api/mailTransferReport/index.js",
16681 "groupTitle": "Mail_Transfer_Reports"
16685 "url": "/api/mail/reports/transfer/{id}",
16686 "title": "Deletes a Mail Transfer Report",
16689 "title": "Example usage:",
16690 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
16694 "name": "DeleteMail_Transfer_Reports",
16695 "group": "Mail_Transfer_Reports",
16696 "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>",
16697 "version": "0.0.0",
16698 "filename": "server/api/mailTransferReport/index.js",
16699 "groupTitle": "Mail_Transfer_Reports"
16703 "url": "/api/mail/reports/transfer/describe",
16704 "title": "Gets table info about Mail Transfer Reports",
16707 "title": "Example usage:",
16708 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
16712 "name": "DescribeMail_Transfer_Reports",
16713 "group": "Mail_Transfer_Reports",
16714 "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>",
16715 "version": "0.0.0",
16716 "filename": "server/api/mailTransferReport/index.js",
16717 "groupTitle": "Mail_Transfer_Reports"
16721 "url": "/api/mail/reports/transfer",
16722 "title": "Gets a list of Mail Transfer Reports",
16725 "title": "Example usage:",
16726 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
16730 "name": "GetMail_Transfer_Reports",
16731 "group": "Mail_Transfer_Reports",
16732 "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>",
16733 "version": "0.0.0",
16734 "filename": "server/api/mailTransferReport/index.js",
16735 "groupTitle": "Mail_Transfer_Reports"
16739 "url": "/api/mail/reports/transfer/{id}",
16740 "title": "Gets a single Mail Transfer Report",
16743 "title": "Example usage:",
16744 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
16748 "name": "ShowMail_Transfer_Reports",
16749 "group": "Mail_Transfer_Reports",
16750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16751 "version": "0.0.0",
16752 "filename": "server/api/mailTransferReport/index.js",
16753 "groupTitle": "Mail_Transfer_Reports"
16757 "url": "/api/mail/reports/transfer/{id}",
16758 "title": "Update an existing Mail Transfer Report",
16761 "title": "Example usage:",
16762 "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",
16766 "name": "updateMail_Transfer_Reports",
16767 "group": "Mail_Transfer_Reports",
16768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16769 "version": "0.0.0",
16770 "filename": "server/api/mailTransferReport/index.js",
16771 "groupTitle": "Mail_Transfer_Reports"
16775 "url": "/api/members/reports/describe",
16776 "title": "Gets table info about Member Reports",
16779 "title": "Example usage:",
16780 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
16784 "name": "DescribeMember_Reports",
16785 "group": "Member_Reports",
16786 "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>",
16787 "version": "0.0.0",
16788 "filename": "server/api/memberReport/index.js",
16789 "groupTitle": "Member_Reports"
16793 "url": "/api/members/reports",
16794 "title": "Gets a list of Member Reports",
16797 "title": "Example usage:",
16798 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
16802 "name": "GetMember_Reports",
16803 "group": "Member_Reports",
16804 "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>",
16805 "version": "0.0.0",
16806 "filename": "server/api/memberReport/index.js",
16807 "groupTitle": "Member_Reports"
16811 "url": "/api/members/reports/{id}",
16812 "title": "Gets a single Member Report",
16815 "title": "Example usage:",
16816 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
16820 "name": "ShowMember_Reports",
16821 "group": "Member_Reports",
16822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16823 "version": "0.0.0",
16824 "filename": "server/api/memberReport/index.js",
16825 "groupTitle": "Member_Reports"
16829 "url": "/api/migrations",
16830 "title": "Gets a list of Migrations",
16833 "title": "Example usage:",
16834 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
16838 "name": "GetMigrations",
16839 "group": "Migrations",
16840 "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>",
16841 "version": "0.0.0",
16842 "filename": "server/api/migration/index.js",
16843 "groupTitle": "Migrations"
16847 "url": "/api/voice/networks",
16848 "title": "Create a new network",
16851 "title": "Example usage:",
16852 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16857 "group": "Networks",
16858 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16859 "version": "0.0.0",
16860 "filename": "server/api/network/index.js",
16861 "groupTitle": "Networks"
16865 "url": "/api/voice/networks/{id}",
16866 "title": "Deletes a network",
16869 "title": "Example usage:",
16870 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
16875 "group": "Networks",
16876 "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>",
16877 "version": "0.0.0",
16878 "filename": "server/api/network/index.js",
16879 "groupTitle": "Networks"
16883 "url": "/api/networks",
16884 "title": "Gets a list of Networks",
16887 "title": "Example usage:",
16888 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
16892 "name": "GetNetworks",
16893 "group": "Networks",
16894 "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>",
16895 "version": "0.0.0",
16896 "filename": "server/api/network/index.js",
16897 "groupTitle": "Networks"
16901 "url": "/api/networks/{id}",
16902 "title": "Gets a single Network",
16905 "title": "Example usage:",
16906 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
16910 "name": "ShowNetworks",
16911 "group": "Networks",
16912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16913 "version": "0.0.0",
16914 "filename": "server/api/network/index.js",
16915 "groupTitle": "Networks"
16919 "url": "/api/voice/networks/{id}",
16920 "title": "Update an existing network",
16923 "title": "Example usage:",
16924 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
16929 "group": "Networks",
16930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16931 "version": "0.0.0",
16932 "filename": "server/api/network/index.js",
16933 "groupTitle": "Networks"
16937 "url": "/api/notifications",
16938 "title": "Send notification to user",
16941 "title": "Example usage:",
16942 "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16947 "group": "Notifications",
16948 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16949 "version": "0.0.0",
16950 "filename": "server/api/notification/index.js",
16951 "groupTitle": "Notifications"
16955 "url": "/api/openchannel/accounts/{id}/users",
16956 "title": "Add agents to a openchannel account",
16959 "title": "Example usage:",
16960 "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",
16964 "name": "AddAgents",
16965 "group": "Openchannel_Accounts",
16966 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16967 "version": "0.0.0",
16968 "filename": "server/api/openchannelAccount/index.js",
16969 "groupTitle": "Openchannel_Accounts"
16973 "url": "/api/openchannel/accounts",
16974 "title": "Creates a new Account",
16977 "title": "Example usage:",
16978 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16982 "name": "CreateAccounts",
16983 "group": "Openchannel_Accounts",
16998 "field": "description",
17012 "field": "replyUri",
17026 "field": "notificationTemplate",
17033 "field": "notificationSound",
17040 "field": "notificationShake",
17047 "field": "waitForTheAssignedAgent",
17061 "field": "queueTransfer",
17068 "field": "queueTransferTimeout",
17075 "field": "agentTransfer",
17082 "field": "agentTransferTimeout",
17089 "field": "mandatoryDispositionPauseId",
17090 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17096 "field": "mandatoryDisposition",
17097 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17103 "version": "0.0.0",
17104 "filename": "server/api/openchannelAccount/index.js",
17105 "groupTitle": "Openchannel_Accounts"
17109 "url": "/api/openchannel/accounts/{id}",
17110 "title": "Deletes a Account",
17113 "title": "Example usage:",
17114 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17118 "name": "DeleteAccounts",
17119 "group": "Openchannel_Accounts",
17120 "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>",
17121 "version": "0.0.0",
17122 "filename": "server/api/openchannelAccount/index.js",
17123 "groupTitle": "Openchannel_Accounts"
17127 "url": "/api/openchannel/accounts/describe",
17128 "title": "Gets table info about Accounts",
17131 "title": "Example usage:",
17132 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17136 "name": "DescribeAccounts",
17137 "group": "Openchannel_Accounts",
17138 "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>",
17139 "version": "0.0.0",
17140 "filename": "server/api/openchannelAccount/index.js",
17141 "groupTitle": "Openchannel_Accounts"
17145 "url": "/api/openchannel/accounts",
17146 "title": "Gets a list of Accounts",
17149 "title": "Example usage:",
17150 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17154 "name": "GetAccounts",
17155 "group": "Openchannel_Accounts",
17156 "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>",
17157 "version": "0.0.0",
17158 "filename": "server/api/openchannelAccount/index.js",
17159 "groupTitle": "Openchannel_Accounts"
17163 "url": "/api/openchannel/accounts/{id}/users",
17164 "title": "Gets agents from openchannel account",
17167 "title": "Example usage:",
17168 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17172 "name": "GetAgents",
17173 "group": "Openchannel_Accounts",
17174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17175 "version": "0.0.0",
17176 "filename": "server/api/openchannelAccount/index.js",
17177 "groupTitle": "Openchannel_Accounts"
17181 "url": "/api/openchannel/accounts/{id}/users",
17182 "title": "Removes agents from a openchannel account",
17185 "title": "Example usage:",
17186 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17190 "name": "RemoveAgents",
17191 "group": "Openchannel_Accounts",
17192 "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>",
17193 "version": "0.0.0",
17194 "filename": "server/api/openchannelAccount/index.js",
17195 "groupTitle": "Openchannel_Accounts"
17199 "url": "/api/openchannel/accounts/{id}/canned_answers",
17200 "title": "Removes canned answers from account",
17203 "title": "Example usage:",
17204 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17208 "name": "RemoveAnswers",
17209 "group": "Openchannel_Accounts",
17210 "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>",
17211 "version": "0.0.0",
17212 "filename": "server/api/openchannelAccount/index.js",
17213 "groupTitle": "Openchannel_Accounts"
17217 "url": "/api/openchannel/accounts/{id}/dispositions",
17218 "title": "Removes dispositions from account",
17221 "title": "Example usage:",
17222 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17226 "name": "RemoveDispositions",
17227 "group": "Openchannel_Accounts",
17228 "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>",
17229 "version": "0.0.0",
17230 "filename": "server/api/openchannelAccount/index.js",
17231 "groupTitle": "Openchannel_Accounts"
17235 "url": "/api/openchannel/accounts/{id}",
17236 "title": "Gets a single Account",
17239 "title": "Example usage:",
17240 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17244 "name": "ShowAccounts",
17245 "group": "Openchannel_Accounts",
17246 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17247 "version": "0.0.0",
17248 "filename": "server/api/openchannelAccount/index.js",
17249 "groupTitle": "Openchannel_Accounts"
17253 "url": "/api/openchannel/accounts/{id}/canned_answers",
17254 "title": "Creates new canned answer",
17257 "title": "Example usage:",
17258 "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",
17262 "name": "addAnswer",
17263 "group": "Openchannel_Accounts",
17285 "field": "description",
17298 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17299 "version": "0.0.0",
17300 "filename": "server/api/openchannelAccount/index.js",
17301 "groupTitle": "Openchannel_Accounts"
17305 "url": "/api/openchannel/accounts/{id}/applications",
17306 "title": "Creates new applications",
17309 "title": "Example usage:",
17310 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17314 "name": "addApplications",
17315 "group": "Openchannel_Accounts",
17323 "field": "priority",
17337 "field": "appdata",
17344 "field": "description",
17351 "field": "interval",
17357 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17358 "version": "0.0.0",
17359 "filename": "server/api/openchannelAccount/index.js",
17360 "groupTitle": "Openchannel_Accounts"
17364 "url": "/api/openchannel/accounts/{id}/dispositions",
17365 "title": "Creates new disposition",
17368 "title": "Example usage:",
17369 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17373 "name": "addDisposition",
17374 "group": "Openchannel_Accounts",
17388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17389 "version": "0.0.0",
17390 "filename": "server/api/openchannelAccount/index.js",
17391 "groupTitle": "Openchannel_Accounts"
17395 "url": "/api/openchannel/accounts/{id}/canned_answers",
17396 "title": "Gets account canned answers",
17399 "title": "Example usage:",
17400 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17404 "name": "getAnswers",
17405 "group": "Openchannel_Accounts",
17406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17407 "version": "0.0.0",
17408 "filename": "server/api/openchannelAccount/index.js",
17409 "groupTitle": "Openchannel_Accounts"
17413 "url": "/api/openchannel/accounts/{id}/applications",
17414 "title": "Gets account applications",
17417 "title": "Example usage:",
17418 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17422 "name": "getApplications",
17423 "group": "Openchannel_Accounts",
17424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17425 "version": "0.0.0",
17426 "filename": "server/api/openchannelAccount/index.js",
17427 "groupTitle": "Openchannel_Accounts"
17431 "url": "/api/openchannel/accounts/{id}/dispositions",
17432 "title": "Gets account dispositions",
17435 "title": "Example usage:",
17436 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17440 "name": "getDispositions",
17441 "group": "Openchannel_Accounts",
17442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17443 "version": "0.0.0",
17444 "filename": "server/api/openchannelAccount/index.js",
17445 "groupTitle": "Openchannel_Accounts"
17449 "url": "/api/openchannel/accounts/{id}/interactions",
17450 "title": "Gets Openchannel Account Interactions",
17453 "title": "Example usage:",
17454 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17458 "name": "getInteractions",
17459 "group": "Openchannel_Accounts",
17460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17461 "version": "0.0.0",
17462 "filename": "server/api/openchannelAccount/index.js",
17463 "groupTitle": "Openchannel_Accounts"
17467 "url": "/api/openchannel/accounts/{id}/notify",
17468 "title": "Notify new message",
17471 "title": "Example usage:",
17472 "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",
17477 "group": "Openchannel_Accounts",
17478 "description": "<p>Motion 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>",
17479 "version": "0.0.0",
17480 "filename": "server/api/openchannelAccount/index.js",
17481 "groupTitle": "Openchannel_Accounts"
17485 "url": "/api/openchannel/accounts/{id}/send",
17486 "title": "Send new openchannel message",
17489 "title": "Example usage:",
17490 "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",
17494 "name": "sendOpenchannel",
17495 "group": "Openchannel_Accounts",
17496 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17497 "version": "0.0.0",
17498 "filename": "server/api/openchannelAccount/index.js",
17499 "groupTitle": "Openchannel_Accounts"
17503 "url": "/api/openchannel/accounts/{id}",
17504 "title": "Update an existing Account",
17507 "title": "Example usage:",
17508 "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",
17512 "name": "updateAccounts",
17513 "group": "Openchannel_Accounts",
17514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17515 "version": "0.0.0",
17516 "filename": "server/api/openchannelAccount/index.js",
17517 "groupTitle": "Openchannel_Accounts"
17521 "url": "/api/openchannel/applications",
17522 "title": "Creates a new Application",
17525 "title": "Example usage:",
17526 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17530 "name": "CreateApplications",
17531 "group": "Openchannel_Applications",
17539 "field": "priority",
17553 "field": "appdata",
17560 "field": "description",
17567 "field": "interval",
17573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17574 "version": "0.0.0",
17575 "filename": "server/api/openchannelApplication/index.js",
17576 "groupTitle": "Openchannel_Applications"
17580 "url": "/api/openchannel/applications/{id}",
17581 "title": "Deletes a Application",
17584 "title": "Example usage:",
17585 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17589 "name": "DeleteApplications",
17590 "group": "Openchannel_Applications",
17591 "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>",
17592 "version": "0.0.0",
17593 "filename": "server/api/openchannelApplication/index.js",
17594 "groupTitle": "Openchannel_Applications"
17598 "url": "/api/openchannel/applications",
17599 "title": "Gets a list of Applications",
17602 "title": "Example usage:",
17603 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17607 "name": "GetApplications",
17608 "group": "Openchannel_Applications",
17609 "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>",
17610 "version": "0.0.0",
17611 "filename": "server/api/openchannelApplication/index.js",
17612 "groupTitle": "Openchannel_Applications"
17616 "url": "/api/openchannel/applications/{id}",
17617 "title": "Gets a single Application",
17620 "title": "Example usage:",
17621 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17625 "name": "ShowApplications",
17626 "group": "Openchannel_Applications",
17627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17628 "version": "0.0.0",
17629 "filename": "server/api/openchannelApplication/index.js",
17630 "groupTitle": "Openchannel_Applications"
17634 "url": "/api/openchannel/applications/{id}",
17635 "title": "Update an existing Application",
17638 "title": "Example usage:",
17639 "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",
17643 "name": "updateApplications",
17644 "group": "Openchannel_Applications",
17645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17646 "version": "0.0.0",
17647 "filename": "server/api/openchannelApplication/index.js",
17648 "groupTitle": "Openchannel_Applications"
17652 "url": "/api/openchannel/interactions/{id}/tags",
17653 "title": "Add tags to the interaction",
17656 "title": "Example usage:",
17657 "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",
17662 "group": "Openchannel_Interactions",
17663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17664 "version": "0.0.0",
17665 "filename": "server/api/openchannelInteraction/index.js",
17666 "groupTitle": "Openchannel_Interactions"
17670 "url": "/api/openchannel/interactions",
17671 "title": "Creates a new Interaction",
17674 "title": "Example usage:",
17675 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17679 "name": "CreateInteractions",
17680 "group": "Openchannel_Interactions",
17695 "field": "closedAt",
17702 "field": "disposition",
17716 "field": "read1stAt",
17723 "field": "threadId",
17730 "field": "externalUrl",
17737 "field": "lastMsgAt",
17748 "field": "lastMsgDirection",
17761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17762 "version": "0.0.0",
17763 "filename": "server/api/openchannelInteraction/index.js",
17764 "groupTitle": "Openchannel_Interactions"
17768 "url": "/api/openchannel/interactions/{id}",
17769 "title": "Deletes a Interaction",
17772 "title": "Example usage:",
17773 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
17777 "name": "DeleteInteractions",
17778 "group": "Openchannel_Interactions",
17779 "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>",
17780 "version": "0.0.0",
17781 "filename": "server/api/openchannelInteraction/index.js",
17782 "groupTitle": "Openchannel_Interactions"
17786 "url": "/api/openchannel/interactions/describe",
17787 "title": "Gets table info about Interactions",
17790 "title": "Example usage:",
17791 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
17795 "name": "DescribeInteractions",
17796 "group": "Openchannel_Interactions",
17797 "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>",
17798 "version": "0.0.0",
17799 "filename": "server/api/openchannelInteraction/index.js",
17800 "groupTitle": "Openchannel_Interactions"
17804 "url": "/api/openchannel/interactions",
17805 "title": "Gets a list of Interactions",
17808 "title": "Example usage:",
17809 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
17813 "name": "GetInteractions",
17814 "group": "Openchannel_Interactions",
17815 "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>",
17816 "version": "0.0.0",
17817 "filename": "server/api/openchannelInteraction/index.js",
17818 "groupTitle": "Openchannel_Interactions"
17822 "url": "/api/openchannel/interactions/{id}/tags",
17823 "title": "Removes tags from interaction",
17826 "title": "Example usage:",
17827 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17831 "name": "RemoveTags",
17832 "group": "Openchannel_Interactions",
17833 "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>",
17834 "version": "0.0.0",
17835 "filename": "server/api/openchannelInteraction/index.js",
17836 "groupTitle": "Openchannel_Interactions"
17840 "url": "/api/openchannel/interactions/{id}",
17841 "title": "Gets a single Interaction",
17844 "title": "Example usage:",
17845 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
17849 "name": "ShowInteractions",
17850 "group": "Openchannel_Interactions",
17851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "server/api/openchannelInteraction/index.js",
17854 "groupTitle": "Openchannel_Interactions"
17858 "url": "/api/openchannel/interactions/{id}/messages",
17859 "title": "Creates new messages",
17862 "title": "Example usage:",
17863 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17867 "name": "addMessage",
17868 "group": "Openchannel_Interactions",
17901 "field": "direction",
17914 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17915 "version": "0.0.0",
17916 "filename": "server/api/openchannelInteraction/index.js",
17917 "groupTitle": "Openchannel_Interactions"
17921 "url": "/api/openchannel/interactions/{id}/download",
17922 "title": "Gets interaction",
17925 "title": "Example usage:",
17926 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
17930 "name": "download",
17931 "group": "Openchannel_Interactions",
17932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17933 "version": "0.0.0",
17934 "filename": "server/api/openchannelInteraction/index.js",
17935 "groupTitle": "Openchannel_Interactions"
17939 "url": "/api/openchannel/interactions/{id}/messages",
17940 "title": "Gets interaction messages",
17943 "title": "Example usage:",
17944 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
17948 "name": "getMessages",
17949 "group": "Openchannel_Interactions",
17950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17951 "version": "0.0.0",
17952 "filename": "server/api/openchannelInteraction/index.js",
17953 "groupTitle": "Openchannel_Interactions"
17957 "url": "/api/openchannel/interactions/{id}",
17958 "title": "Update an existing Interaction",
17961 "title": "Example usage:",
17962 "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",
17966 "name": "updateInteractions",
17967 "group": "Openchannel_Interactions",
17968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17969 "version": "0.0.0",
17970 "filename": "server/api/openchannelInteraction/index.js",
17971 "groupTitle": "Openchannel_Interactions"
17975 "url": "/api/openchannel/messages",
17976 "title": "Creates a new Message",
17979 "title": "Example usage:",
17980 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17984 "name": "CreateMessages",
17985 "group": "Openchannel_Messages",
18018 "field": "direction",
18031 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18032 "version": "0.0.0",
18033 "filename": "server/api/openchannelMessage/index.js",
18034 "groupTitle": "Openchannel_Messages"
18038 "url": "/api/openchannel/messages/{id}",
18039 "title": "Deletes a Message",
18042 "title": "Example usage:",
18043 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18047 "name": "DeleteMessages",
18048 "group": "Openchannel_Messages",
18049 "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>",
18050 "version": "0.0.0",
18051 "filename": "server/api/openchannelMessage/index.js",
18052 "groupTitle": "Openchannel_Messages"
18056 "url": "/api/openchannel/messages/describe",
18057 "title": "Gets table info about Messages",
18060 "title": "Example usage:",
18061 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18065 "name": "DescribeMessages",
18066 "group": "Openchannel_Messages",
18067 "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>",
18068 "version": "0.0.0",
18069 "filename": "server/api/openchannelMessage/index.js",
18070 "groupTitle": "Openchannel_Messages"
18074 "url": "/api/openchannel/messages",
18075 "title": "Gets a list of Messages",
18078 "title": "Example usage:",
18079 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18083 "name": "GetMessages",
18084 "group": "Openchannel_Messages",
18085 "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>",
18086 "version": "0.0.0",
18087 "filename": "server/api/openchannelMessage/index.js",
18088 "groupTitle": "Openchannel_Messages"
18092 "url": "/api/openchannel/messages/{id}",
18093 "title": "Gets a single Message",
18096 "title": "Example usage:",
18097 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18101 "name": "ShowMessages",
18102 "group": "Openchannel_Messages",
18103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18104 "version": "0.0.0",
18105 "filename": "server/api/openchannelMessage/index.js",
18106 "groupTitle": "Openchannel_Messages"
18110 "url": "/api/openchannel/messages/{id}/accept",
18111 "title": "Accepts message",
18114 "title": "Example usage:",
18115 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18119 "name": "acceptMessage",
18120 "group": "Openchannel_Messages",
18121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18122 "version": "0.0.0",
18123 "filename": "server/api/openchannelMessage/index.js",
18124 "groupTitle": "Openchannel_Messages"
18128 "url": "/api/openchannel/messages/{id}/reject",
18129 "title": "Rejects message",
18132 "title": "Example usage:",
18133 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18137 "name": "rejectMessage",
18138 "group": "Openchannel_Messages",
18139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18140 "version": "0.0.0",
18141 "filename": "server/api/openchannelMessage/index.js",
18142 "groupTitle": "Openchannel_Messages"
18146 "url": "/api/openchannel/messages/{id}",
18147 "title": "Update an existing Message",
18150 "title": "Example usage:",
18151 "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",
18155 "name": "updateMessages",
18156 "group": "Openchannel_Messages",
18157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18158 "version": "0.0.0",
18159 "filename": "server/api/openchannelMessage/index.js",
18160 "groupTitle": "Openchannel_Messages"
18164 "url": "/api/openchannel/reports/queue",
18165 "title": "Creates a new Openchannel Queue Report",
18168 "title": "Example usage:",
18169 "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",
18173 "name": "CreateOpenchannel_Queue_Reports",
18174 "group": "Openchannel_Queue_Reports",
18182 "field": "uniqueid",
18203 "field": "leaveAt",
18210 "field": "acceptAt",
18230 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18231 "version": "0.0.0",
18232 "filename": "server/api/openchannelQueueReport/index.js",
18233 "groupTitle": "Openchannel_Queue_Reports"
18237 "url": "/api/openchannel/reports/queue/{id}",
18238 "title": "Deletes a Openchannel Queue Report",
18241 "title": "Example usage:",
18242 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18246 "name": "DeleteOpenchannel_Queue_Reports",
18247 "group": "Openchannel_Queue_Reports",
18248 "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>",
18249 "version": "0.0.0",
18250 "filename": "server/api/openchannelQueueReport/index.js",
18251 "groupTitle": "Openchannel_Queue_Reports"
18255 "url": "/api/openchannel/reports/queue/describe",
18256 "title": "Gets table info about Openchannel Queue Reports",
18259 "title": "Example usage:",
18260 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18264 "name": "DescribeOpenchannel_Queue_Reports",
18265 "group": "Openchannel_Queue_Reports",
18266 "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>",
18267 "version": "0.0.0",
18268 "filename": "server/api/openchannelQueueReport/index.js",
18269 "groupTitle": "Openchannel_Queue_Reports"
18273 "url": "/api/openchannel/reports/queue",
18274 "title": "Gets a list of Openchannel Queue Reports",
18277 "title": "Example usage:",
18278 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18282 "name": "GetOpenchannel_Queue_Reports",
18283 "group": "Openchannel_Queue_Reports",
18284 "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>",
18285 "version": "0.0.0",
18286 "filename": "server/api/openchannelQueueReport/index.js",
18287 "groupTitle": "Openchannel_Queue_Reports"
18291 "url": "/api/openchannel/reports/queue/{id}",
18292 "title": "Gets a single Openchannel Queue Report",
18295 "title": "Example usage:",
18296 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18300 "name": "ShowOpenchannel_Queue_Reports",
18301 "group": "Openchannel_Queue_Reports",
18302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18303 "version": "0.0.0",
18304 "filename": "server/api/openchannelQueueReport/index.js",
18305 "groupTitle": "Openchannel_Queue_Reports"
18309 "url": "/api/openchannel/reports/queue/{id}",
18310 "title": "Update an existing Openchannel Queue Report",
18313 "title": "Example usage:",
18314 "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",
18318 "name": "updateOpenchannel_Queue_Reports",
18319 "group": "Openchannel_Queue_Reports",
18320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18321 "version": "0.0.0",
18322 "filename": "server/api/openchannelQueueReport/index.js",
18323 "groupTitle": "Openchannel_Queue_Reports"
18327 "url": "/api/openchannel/queues/{id}/users",
18328 "title": "Add agents to a queue",
18331 "title": "Example usage:",
18332 "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",
18336 "name": "AddAgents",
18337 "group": "Openchannel_Queues",
18338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18339 "version": "0.0.0",
18340 "filename": "server/api/openchannelQueue/index.js",
18341 "groupTitle": "Openchannel_Queues"
18345 "url": "/api/openchannel/queues/{id}/teams",
18346 "title": "Add teams to a queue",
18349 "title": "Example usage:",
18350 "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",
18354 "name": "AddTeams",
18355 "group": "Openchannel_Queues",
18356 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18357 "version": "0.0.0",
18358 "filename": "server/api/openchannelQueue/index.js",
18359 "groupTitle": "Openchannel_Queues"
18363 "url": "/api/openchannel/queues",
18364 "title": "Creates a new Queue",
18367 "title": "Example usage:",
18368 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18372 "name": "CreateQueues",
18373 "group": "Openchannel_Queues",
18388 "field": "description",
18395 "field": "timeout",
18407 "field": "strategy",
18413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18414 "version": "0.0.0",
18415 "filename": "server/api/openchannelQueue/index.js",
18416 "groupTitle": "Openchannel_Queues"
18420 "url": "/api/openchannel/queues/{id}",
18421 "title": "Deletes a Queue",
18424 "title": "Example usage:",
18425 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18429 "name": "DeleteQueues",
18430 "group": "Openchannel_Queues",
18431 "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>",
18432 "version": "0.0.0",
18433 "filename": "server/api/openchannelQueue/index.js",
18434 "groupTitle": "Openchannel_Queues"
18438 "url": "/api/openchannel/queues/describe",
18439 "title": "Gets table info about Queues",
18442 "title": "Example usage:",
18443 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18447 "name": "DescribeQueues",
18448 "group": "Openchannel_Queues",
18449 "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>",
18450 "version": "0.0.0",
18451 "filename": "server/api/openchannelQueue/index.js",
18452 "groupTitle": "Openchannel_Queues"
18456 "url": "/api/openchannel/queues/{id}/users",
18457 "title": "Gets queue agents",
18460 "title": "Example usage:",
18461 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18465 "name": "GetAgents",
18466 "group": "Openchannel_Queues",
18467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18468 "version": "0.0.0",
18469 "filename": "server/api/openchannelQueue/index.js",
18470 "groupTitle": "Openchannel_Queues"
18474 "url": "/api/openchannel/queues/{id}/members",
18475 "title": "GetMembers",
18478 "title": "Example usage:",
18479 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18483 "name": "GetMembers",
18484 "group": "Openchannel_Queues",
18485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18486 "version": "0.0.0",
18487 "filename": "server/api/openchannelQueue/index.js",
18488 "groupTitle": "Openchannel_Queues"
18492 "url": "/api/openchannel/queues",
18493 "title": "Gets a list of Queues",
18496 "title": "Example usage:",
18497 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18501 "name": "GetQueues",
18502 "group": "Openchannel_Queues",
18503 "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>",
18504 "version": "0.0.0",
18505 "filename": "server/api/openchannelQueue/index.js",
18506 "groupTitle": "Openchannel_Queues"
18510 "url": "/api/openchannel/queues/{id}/teams",
18511 "title": "Gets queues list",
18514 "title": "Example usage:",
18515 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18519 "name": "GetTeams",
18520 "group": "Openchannel_Queues",
18521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18522 "version": "0.0.0",
18523 "filename": "server/api/openchannelQueue/index.js",
18524 "groupTitle": "Openchannel_Queues"
18528 "url": "/api/openchannel/queues/{id}/users",
18529 "title": "Removes agents from a queue",
18532 "title": "Example usage:",
18533 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18537 "name": "RemoveAgents",
18538 "group": "Openchannel_Queues",
18539 "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>",
18540 "version": "0.0.0",
18541 "filename": "server/api/openchannelQueue/index.js",
18542 "groupTitle": "Openchannel_Queues"
18546 "url": "/api/openchannel/queues/{id}",
18547 "title": "Gets a single Queue",
18550 "title": "Example usage:",
18551 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18555 "name": "ShowQueues",
18556 "group": "Openchannel_Queues",
18557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18558 "version": "0.0.0",
18559 "filename": "server/api/openchannelQueue/index.js",
18560 "groupTitle": "Openchannel_Queues"
18564 "url": "/api/openchannel/queues/{id}",
18565 "title": "Update an existing Queue",
18568 "title": "Example usage:",
18569 "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",
18573 "name": "updateQueues",
18574 "group": "Openchannel_Queues",
18575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18576 "version": "0.0.0",
18577 "filename": "server/api/openchannelQueue/index.js",
18578 "groupTitle": "Openchannel_Queues"
18582 "url": "/api/openchannel/reports/transfer",
18583 "title": "Creates a new Openchannel Transfer Report",
18586 "title": "Example usage:",
18587 "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",
18591 "name": "CreateOpenchannel_Transfer_Reports",
18592 "group": "Openchannel_Transfer_Reports",
18600 "field": "uniqueid",
18619 "field": "transferredAt",
18625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18626 "version": "0.0.0",
18627 "filename": "server/api/openchannelTransferReport/index.js",
18628 "groupTitle": "Openchannel_Transfer_Reports"
18632 "url": "/api/openchannel/reports/transfer/{id}",
18633 "title": "Deletes a Openchannel Transfer Report",
18636 "title": "Example usage:",
18637 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18641 "name": "DeleteOpenchannel_Transfer_Reports",
18642 "group": "Openchannel_Transfer_Reports",
18643 "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>",
18644 "version": "0.0.0",
18645 "filename": "server/api/openchannelTransferReport/index.js",
18646 "groupTitle": "Openchannel_Transfer_Reports"
18650 "url": "/api/openchannel/reports/transfer/describe",
18651 "title": "Gets table info about Openchannel Transfer Reports",
18654 "title": "Example usage:",
18655 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
18659 "name": "DescribeOpenchannel_Transfer_Reports",
18660 "group": "Openchannel_Transfer_Reports",
18661 "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>",
18662 "version": "0.0.0",
18663 "filename": "server/api/openchannelTransferReport/index.js",
18664 "groupTitle": "Openchannel_Transfer_Reports"
18668 "url": "/api/openchannel/reports/transfer",
18669 "title": "Gets a list of Openchannel Transfer Reports",
18672 "title": "Example usage:",
18673 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
18677 "name": "GetOpenchannel_Transfer_Reports",
18678 "group": "Openchannel_Transfer_Reports",
18679 "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>",
18680 "version": "0.0.0",
18681 "filename": "server/api/openchannelTransferReport/index.js",
18682 "groupTitle": "Openchannel_Transfer_Reports"
18686 "url": "/api/openchannel/reports/transfer/{id}",
18687 "title": "Gets a single Openchannel Transfer Report",
18690 "title": "Example usage:",
18691 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
18695 "name": "ShowOpenchannel_Transfer_Reports",
18696 "group": "Openchannel_Transfer_Reports",
18697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18698 "version": "0.0.0",
18699 "filename": "server/api/openchannelTransferReport/index.js",
18700 "groupTitle": "Openchannel_Transfer_Reports"
18704 "url": "/api/openchannel/reports/transfer/{id}",
18705 "title": "Update an existing Openchannel Transfer Report",
18708 "title": "Example usage:",
18709 "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",
18713 "name": "updateOpenchannel_Transfer_Reports",
18714 "group": "Openchannel_Transfer_Reports",
18715 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18716 "version": "0.0.0",
18717 "filename": "server/api/openchannelTransferReport/index.js",
18718 "groupTitle": "Openchannel_Transfer_Reports"
18722 "url": "/api/pauses",
18723 "title": "Creates a new Pause",
18726 "title": "Example usage:",
18727 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18731 "name": "CreatePauses",
18747 "field": "description",
18753 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18754 "version": "0.0.0",
18755 "filename": "server/api/pause/index.js",
18756 "groupTitle": "Pauses"
18760 "url": "/api/pauses/{id}",
18761 "title": "Deletes a Pause",
18764 "title": "Example usage:",
18765 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
18769 "name": "DeletePauses",
18771 "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>",
18772 "version": "0.0.0",
18773 "filename": "server/api/pause/index.js",
18774 "groupTitle": "Pauses"
18778 "url": "/api/pauses",
18779 "title": "Gets a list of Pauses",
18782 "title": "Example usage:",
18783 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
18787 "name": "GetPauses",
18789 "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>",
18790 "version": "0.0.0",
18791 "filename": "server/api/pause/index.js",
18792 "groupTitle": "Pauses"
18796 "url": "/api/pauses/{id}",
18797 "title": "Gets a single Pause",
18800 "title": "Example usage:",
18801 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
18805 "name": "ShowPauses",
18807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18808 "version": "0.0.0",
18809 "filename": "server/api/pause/index.js",
18810 "groupTitle": "Pauses"
18814 "url": "/api/pauses/{id}",
18815 "title": "Update an existing Pause",
18818 "title": "Example usage:",
18819 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18823 "name": "updatePauses",
18825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18826 "version": "0.0.0",
18827 "filename": "server/api/pause/index.js",
18828 "groupTitle": "Pauses"
18832 "url": "/api/plugins",
18833 "title": "Gets a list of Plugins",
18836 "title": "Example usage:",
18837 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
18841 "name": "GetPlugins",
18842 "group": "Plugins",
18843 "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>",
18844 "version": "0.0.0",
18845 "filename": "server/api/plugin/index.js",
18846 "groupTitle": "Plugins"
18850 "url": "/api/plugins/{id}",
18851 "title": "Gets a single Plugin",
18854 "title": "Example usage:",
18855 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
18859 "name": "ShowPlugins",
18860 "group": "Plugins",
18861 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18862 "version": "0.0.0",
18863 "filename": "server/api/plugin/index.js",
18864 "groupTitle": "Plugins"
18868 "url": "/api/plugins/{id}",
18869 "title": "Delete a plugin",
18872 "title": "Example usage:",
18873 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
18877 "name": "destroyPlugin",
18878 "group": "Plugins",
18879 "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>",
18880 "version": "0.0.0",
18881 "filename": "server/api/plugin/index.js",
18882 "groupTitle": "Plugins"
18886 "url": "/api/plugins/{id}/download",
18887 "title": "Download plugin source code",
18890 "title": "Example usage:",
18891 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
18895 "name": "download",
18896 "group": "Plugins",
18897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18898 "version": "0.0.0",
18899 "filename": "server/api/plugin/index.js",
18900 "groupTitle": "Plugins"
18904 "url": "/api/plugins/{id}",
18905 "title": "Update an existing plugin",
18908 "title": "Example usage:",
18909 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
18913 "name": "updatePlugin",
18914 "group": "Plugins",
18915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18916 "version": "0.0.0",
18917 "filename": "server/api/plugin/index.js",
18918 "groupTitle": "Plugins"
18922 "url": "/api/plugins",
18923 "title": "Upload new plugin",
18926 "title": "Example usage:",
18927 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
18931 "name": "uploadPlugin",
18932 "group": "Plugins",
18933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18934 "version": "0.0.0",
18935 "filename": "server/api/plugin/index.js",
18936 "groupTitle": "Plugins"
18940 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
18941 "title": "Redirect a plugin request to the specified path",
18944 "title": "Example usage:",
18945 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
18949 "name": "webhookPlugin",
18950 "group": "Plugins",
18951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18952 "version": "0.0.0",
18953 "filename": "server/api/plugin/index.js",
18954 "groupTitle": "Plugins"
18958 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
18959 "title": "Redirect a plugin request to the specified path",
18962 "title": "Example usage:",
18963 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
18967 "name": "webhookPlugin",
18968 "group": "Plugins",
18969 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18970 "version": "0.0.0",
18971 "filename": "server/api/plugin/index.js",
18972 "groupTitle": "Plugins"
18976 "url": "/api/pm2/{id}",
18977 "title": "Deletes an existing process",
18980 "title": "Example usage:",
18981 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
18985 "name": "DeletePm2Process",
18987 "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>",
18988 "version": "0.0.0",
18989 "filename": "server/api/pm2/index.js",
18990 "groupTitle": "Pm2"
18994 "url": "/api/pm2/{id}",
18995 "title": "Gets a single pm2 process",
18998 "title": "Example usage:",
18999 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19003 "name": "GetPm2Process",
19005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19006 "version": "0.0.0",
19007 "filename": "server/api/pm2/index.js",
19008 "groupTitle": "Pm2"
19013 "title": "Gets pm2 processes",
19016 "title": "Example usage:",
19017 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19021 "name": "GetPm2Processes",
19023 "description": "<p>Motion returns the pm2 processes list.</p>",
19024 "version": "0.0.0",
19025 "filename": "server/api/pm2/index.js",
19026 "groupTitle": "Pm2"
19031 "title": "Start a single pm2 process",
19034 "title": "Example usage:",
19035 "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",
19039 "name": "StartPm2Process",
19061 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19062 "version": "0.0.0",
19063 "filename": "server/api/pm2/index.js",
19064 "groupTitle": "Pm2"
19068 "url": "/api/pm2/{id}",
19069 "title": "Update an existing process",
19072 "title": "Example usage:",
19073 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19077 "name": "UpdatePm2Process",
19079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19080 "version": "0.0.0",
19081 "filename": "server/api/pm2/index.js",
19082 "groupTitle": "Pm2"
19086 "url": "/api/rpc/campaigns/",
19087 "title": "Gets a list of campaigns",
19090 "title": "Example usage:",
19091 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19095 "name": "Campaigns",
19096 "group": "RPC_Realtime",
19097 "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>",
19098 "version": "0.0.0",
19099 "filename": "server/api/rpc/index.js",
19100 "groupTitle": "RPC_Realtime"
19104 "url": "/api/rpc/fax/accounts",
19105 "title": "Gets a list of FaxAccounts",
19108 "title": "Example usage:",
19109 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19113 "name": "FaxAccounts",
19114 "group": "RPC_Realtime",
19115 "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>",
19116 "version": "0.0.0",
19117 "filename": "server/api/rpc/index.js",
19118 "groupTitle": "RPC_Realtime"
19122 "url": "/api/rpc/agents/:id/capacity",
19123 "title": "Sets agent capacity",
19126 "title": "Example usage:",
19127 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19131 "name": "RTAgentCapacity",
19132 "group": "RPC_Realtime",
19133 "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>",
19134 "version": "0.0.0",
19135 "filename": "server/api/rpc/index.js",
19136 "groupTitle": "RPC_Realtime"
19140 "url": "/api/rpc/agents",
19141 "title": "Gets a list of RTAgents",
19144 "title": "Example usage:",
19145 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19149 "name": "RTAgents",
19150 "group": "RPC_Realtime",
19151 "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>",
19152 "version": "0.0.0",
19153 "filename": "server/api/rpc/index.js",
19154 "groupTitle": "RPC_Realtime"
19158 "url": "/api/rpc/chat/queues",
19159 "title": "Gets a list of RTChatQueues",
19162 "title": "Example usage:",
19163 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19167 "name": "RTChatQueues",
19168 "group": "RPC_Realtime",
19169 "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>",
19170 "version": "0.0.0",
19171 "filename": "server/api/rpc/index.js",
19172 "groupTitle": "RPC_Realtime"
19176 "url": "/api/rpc/fax/queues",
19177 "title": "Gets a list of RTFaxQueues",
19180 "title": "Example usage:",
19181 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19185 "name": "RTFaxQueues",
19186 "group": "RPC_Realtime",
19187 "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>",
19188 "version": "0.0.0",
19189 "filename": "server/api/rpc/index.js",
19190 "groupTitle": "RPC_Realtime"
19194 "url": "/api/rpc/mail/accounts",
19195 "title": "Gets a list of RTMailAccounts",
19198 "title": "Example usage:",
19199 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19203 "name": "RTMailAccounts",
19204 "group": "RPC_Realtime",
19205 "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>",
19206 "version": "0.0.0",
19207 "filename": "server/api/rpc/index.js",
19208 "groupTitle": "RPC_Realtime"
19212 "url": "/api/rpc/mail/queues",
19213 "title": "Gets a list of RTMailQueues",
19216 "title": "Example usage:",
19217 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19221 "name": "RTMailQueues",
19222 "group": "RPC_Realtime",
19223 "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>",
19224 "version": "0.0.0",
19225 "filename": "server/api/rpc/index.js",
19226 "groupTitle": "RPC_Realtime"
19230 "url": "/api/rpc/openchannel/queues",
19231 "title": "Gets a list of RTOpenchannelQueues",
19234 "title": "Example usage:",
19235 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19239 "name": "RTOpenchannelQueues",
19240 "group": "RPC_Realtime",
19241 "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>",
19242 "version": "0.0.0",
19243 "filename": "server/api/rpc/index.js",
19244 "groupTitle": "RPC_Realtime"
19248 "url": "/api/rpc/outbound/channels",
19249 "title": "Gets a list of RTOutboundChannels",
19252 "title": "Example usage:",
19253 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19257 "name": "RTOutboundChannels",
19258 "group": "RPC_Realtime",
19259 "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>",
19260 "version": "0.0.0",
19261 "filename": "server/api/rpc/index.js",
19262 "groupTitle": "RPC_Realtime"
19266 "url": "/api/rpc/sms/queues",
19267 "title": "Gets a list of RTSmsQueues",
19270 "title": "Example usage:",
19271 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19275 "name": "RTSmsQueues",
19276 "group": "RPC_Realtime",
19277 "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>",
19278 "version": "0.0.0",
19279 "filename": "server/api/rpc/index.js",
19280 "groupTitle": "RPC_Realtime"
19284 "url": "/api/rpc/telephones",
19285 "title": "Gets a list of RTTelephones",
19288 "title": "Example usage:",
19289 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19293 "name": "RTTelephones",
19294 "group": "RPC_Realtime",
19295 "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>",
19296 "version": "0.0.0",
19297 "filename": "server/api/rpc/index.js",
19298 "groupTitle": "RPC_Realtime"
19302 "url": "/api/rpc/trunks",
19303 "title": "Gets a list of RTTrunks",
19306 "title": "Example usage:",
19307 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19311 "name": "RTTrunks",
19312 "group": "RPC_Realtime",
19313 "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>",
19314 "version": "0.0.0",
19315 "filename": "server/api/rpc/index.js",
19316 "groupTitle": "RPC_Realtime"
19320 "url": "/api/rpc/voice/channels",
19321 "title": "Gets a list of RTVoiceChannelMixMonitor",
19324 "title": "Example usage:",
19325 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19329 "name": "RTVoiceChannelMixMonitor",
19330 "group": "RPC_Realtime",
19331 "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>",
19332 "version": "0.0.0",
19333 "filename": "server/api/rpc/index.js",
19334 "groupTitle": "RPC_Realtime"
19338 "url": "/api/rpc/voice/channels",
19339 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19342 "title": "Example usage:",
19343 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19347 "name": "RTVoiceChannelStopMixMonitor",
19348 "group": "RPC_Realtime",
19349 "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>",
19350 "version": "0.0.0",
19351 "filename": "server/api/rpc/index.js",
19352 "groupTitle": "RPC_Realtime"
19356 "url": "/api/rpc/voice/channels",
19357 "title": "Gets a list of RTVoiceChannels",
19360 "title": "Example usage:",
19361 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19365 "name": "RTVoiceChannels",
19366 "group": "RPC_Realtime",
19367 "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>",
19368 "version": "0.0.0",
19369 "filename": "server/api/rpc/index.js",
19370 "groupTitle": "RPC_Realtime"
19374 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19375 "title": "Gets a single RTVoiceQueueChannel",
19378 "title": "Example usage:",
19379 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19383 "name": "RTVoiceQueueChannel",
19384 "group": "RPC_Realtime",
19385 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19386 "version": "0.0.0",
19387 "filename": "server/api/rpc/index.js",
19388 "groupTitle": "RPC_Realtime"
19392 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19393 "title": "Hangup a single RTVoiceQueueChannel",
19396 "title": "Example usage:",
19397 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19401 "name": "RTVoiceQueueChannelHangup",
19402 "group": "RPC_Realtime",
19403 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19404 "version": "0.0.0",
19405 "filename": "server/api/rpc/index.js",
19406 "groupTitle": "RPC_Realtime"
19410 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19411 "title": "Hangup a single RTVoiceQueueChannel",
19414 "title": "Example usage:",
19415 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19419 "name": "RTVoiceQueueChannelRedirect",
19420 "group": "RPC_Realtime",
19421 "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>",
19422 "version": "0.0.0",
19423 "filename": "server/api/rpc/index.js",
19424 "groupTitle": "RPC_Realtime"
19428 "url": "/api/rpc/voice/queues/preview/{id}",
19429 "title": "Gets a single preview contact",
19432 "title": "Example usage:",
19433 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19437 "name": "RTVoiceQueuePreview",
19438 "group": "RPC_Realtime",
19439 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19440 "version": "0.0.0",
19441 "filename": "server/api/rpc/index.js",
19442 "groupTitle": "RPC_Realtime"
19446 "url": "/api/rpc/outbound",
19447 "title": "Gets a list of RTOutbound",
19450 "title": "Example usage:",
19451 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19455 "name": "RTVoiceQueues",
19456 "group": "RPC_Realtime",
19457 "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>",
19458 "version": "0.0.0",
19459 "filename": "server/api/rpc/index.js",
19460 "groupTitle": "RPC_Realtime"
19464 "url": "/api/rpc/voice/queues",
19465 "title": "Gets a list of RTVoiceQueues",
19468 "title": "Example usage:",
19469 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19473 "name": "RTVoiceQueues",
19474 "group": "RPC_Realtime",
19475 "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>",
19476 "version": "0.0.0",
19477 "filename": "server/api/rpc/index.js",
19478 "groupTitle": "RPC_Realtime"
19482 "url": "/api/rpc/voice/queues/channels",
19483 "title": "Gets a list of RTVoiceQueuesChannels",
19486 "title": "Example usage:",
19487 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19491 "name": "RTVoiceQueuesChannels",
19492 "group": "RPC_Realtime",
19493 "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>",
19494 "version": "0.0.0",
19495 "filename": "server/api/rpc/index.js",
19496 "groupTitle": "RPC_Realtime"
19500 "url": "/api/rpc/chat/queues/{id}",
19501 "title": "Gets a single RTChatQueue",
19504 "title": "Example usage:",
19505 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19509 "name": "ShowRTChatQueues",
19510 "group": "RPC_Realtime",
19511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19512 "version": "0.0.0",
19513 "filename": "server/api/rpc/index.js",
19514 "groupTitle": "RPC_Realtime"
19518 "url": "/api/rpc/fax/queues/{id}",
19519 "title": "Gets a single RTFaxQueue",
19522 "title": "Example usage:",
19523 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19527 "name": "ShowRTFaxQueues",
19528 "group": "RPC_Realtime",
19529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19530 "version": "0.0.0",
19531 "filename": "server/api/rpc/index.js",
19532 "groupTitle": "RPC_Realtime"
19536 "url": "/api/rpc/mail/queues/{id}",
19537 "title": "Gets a single RTMailQueue",
19540 "title": "Example usage:",
19541 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19545 "name": "ShowRTMailQueues",
19546 "group": "RPC_Realtime",
19547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19548 "version": "0.0.0",
19549 "filename": "server/api/rpc/index.js",
19550 "groupTitle": "RPC_Realtime"
19554 "url": "/api/rpc/openchannel/queues/{id}",
19555 "title": "Gets a single RTOpenchannelQueue",
19558 "title": "Example usage:",
19559 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19563 "name": "ShowRTOpenchannelQueues",
19564 "group": "RPC_Realtime",
19565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19566 "version": "0.0.0",
19567 "filename": "server/api/rpc/index.js",
19568 "groupTitle": "RPC_Realtime"
19572 "url": "/api/rpc/sms/queues/{id}",
19573 "title": "Gets a single RTSmsQueue",
19576 "title": "Example usage:",
19577 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19581 "name": "ShowRTSmsQueues",
19582 "group": "RPC_Realtime",
19583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19584 "version": "0.0.0",
19585 "filename": "server/api/rpc/index.js",
19586 "groupTitle": "RPC_Realtime"
19590 "url": "/api/rpc/voice/queues/{id}",
19591 "title": "Gets a single RTVoiceQueue",
19594 "title": "Example usage:",
19595 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19599 "name": "ShowRTVoiceQueues",
19600 "group": "RPC_Realtime",
19601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19602 "version": "0.0.0",
19603 "filename": "server/api/rpc/index.js",
19604 "groupTitle": "RPC_Realtime"
19608 "url": "/api/rpc/agents/:id/notify",
19609 "title": "Notify message to a specific agent",
19612 "title": "Example usage:",
19613 "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",
19617 "name": "agentNotify",
19618 "group": "RPC_Realtime",
19619 "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>",
19620 "version": "0.0.0",
19621 "filename": "server/api/rpc/index.js",
19622 "groupTitle": "RPC_Realtime"
19626 "url": "/api/rpc/chat/queues/:id/notify",
19627 "title": "Notify message to a specific queue",
19630 "title": "Example usage:",
19631 "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",
19635 "name": "chatQueueNotify",
19636 "group": "RPC_Realtime",
19637 "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>",
19638 "version": "0.0.0",
19639 "filename": "server/api/rpc/index.js",
19640 "groupTitle": "RPC_Realtime"
19644 "url": "/api/rpc/chat/queues/waitinginteractions",
19645 "title": "Gets a list of chatQueuesWaitingInteractions",
19648 "title": "Example usage:",
19649 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
19653 "name": "chatQueuesWaitingInteractions",
19654 "group": "RPC_Realtime",
19655 "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>",
19656 "version": "0.0.0",
19657 "filename": "server/api/rpc/index.js",
19658 "groupTitle": "RPC_Realtime"
19662 "url": "/api/rpc/fax/queues/:id/notify",
19663 "title": "Notify message to a specific queue",
19666 "title": "Example usage:",
19667 "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",
19671 "name": "faxQueueNotify",
19672 "group": "RPC_Realtime",
19673 "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>",
19674 "version": "0.0.0",
19675 "filename": "server/api/rpc/index.js",
19676 "groupTitle": "RPC_Realtime"
19680 "url": "/api/rpc/fax/queues/waitinginteractions",
19681 "title": "Gets a list of faxQueuesWaitingInteractions",
19684 "title": "Example usage:",
19685 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
19689 "name": "faxQueuesWaitingInteractions",
19690 "group": "RPC_Realtime",
19691 "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>",
19692 "version": "0.0.0",
19693 "filename": "server/api/rpc/index.js",
19694 "groupTitle": "RPC_Realtime"
19698 "url": "/api/rpc/mail/queues/:id/notify",
19699 "title": "Notify message to a specific queue",
19702 "title": "Example usage:",
19703 "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",
19707 "name": "mailQueueNotify",
19708 "group": "RPC_Realtime",
19709 "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>",
19710 "version": "0.0.0",
19711 "filename": "server/api/rpc/index.js",
19712 "groupTitle": "RPC_Realtime"
19716 "url": "/api/rpc/mail/queues/waitinginteractions",
19717 "title": "Gets a list of mailQueuesWaitingInteractions",
19720 "title": "Example usage:",
19721 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
19725 "name": "mailQueuesWaitingInteractions",
19726 "group": "RPC_Realtime",
19727 "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>",
19728 "version": "0.0.0",
19729 "filename": "server/api/rpc/index.js",
19730 "groupTitle": "RPC_Realtime"
19734 "url": "/api/rpc/openchannel/queues/:id/notify",
19735 "title": "Notify message to a specific queue",
19738 "title": "Example usage:",
19739 "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",
19743 "name": "openchannelQueueNotify",
19744 "group": "RPC_Realtime",
19745 "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>",
19746 "version": "0.0.0",
19747 "filename": "server/api/rpc/index.js",
19748 "groupTitle": "RPC_Realtime"
19752 "url": "/api/rpc/openchannel/queues/waitinginteractions",
19753 "title": "Gets a list of openchannelQueuesWaitingInteractions",
19756 "title": "Example usage:",
19757 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
19761 "name": "openchannelQueuesWaitingInteractions",
19762 "group": "RPC_Realtime",
19763 "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>",
19764 "version": "0.0.0",
19765 "filename": "server/api/rpc/index.js",
19766 "groupTitle": "RPC_Realtime"
19770 "url": "/api/rpc/sms/queues/:id/notify",
19771 "title": "Notify message to a specific queue",
19774 "title": "Example usage:",
19775 "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",
19779 "name": "smsQueueNotify",
19780 "group": "RPC_Realtime",
19781 "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>",
19782 "version": "0.0.0",
19783 "filename": "server/api/rpc/index.js",
19784 "groupTitle": "RPC_Realtime"
19788 "url": "/api/rpc/sms/queues/waitinginteractions",
19789 "title": "Gets a list of smsQueuesWaitingInteractions",
19792 "title": "Example usage:",
19793 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
19797 "name": "smsQueuesWaitingInteractions",
19798 "group": "RPC_Realtime",
19799 "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>",
19800 "version": "0.0.0",
19801 "filename": "server/api/rpc/index.js",
19802 "groupTitle": "RPC_Realtime"
19806 "url": "/api/integrations/salesforce/accounts",
19807 "title": "Creates a new Salesforce Account",
19810 "title": "Example usage:",
19811 "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",
19815 "name": "CreateSalesforce_Accounts",
19816 "group": "Salesforce_Accounts",
19831 "field": "description",
19838 "field": "username",
19845 "field": "remoteUri",
19852 "field": "password",
19859 "field": "clientId",
19866 "field": "clientSecret",
19873 "field": "securityToken",
19880 "field": "serverUrl",
19887 "\"integrationTab\"",
19897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19898 "version": "0.0.0",
19899 "filename": "server/api/intSalesforceAccount/index.js",
19900 "groupTitle": "Salesforce_Accounts"
19904 "url": "/api/integrations/salesforce/accounts/{id}",
19905 "title": "Deletes a Salesforce Account",
19908 "title": "Example usage:",
19909 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
19913 "name": "DeleteSalesforce_Accounts",
19914 "group": "Salesforce_Accounts",
19915 "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>",
19916 "version": "0.0.0",
19917 "filename": "server/api/intSalesforceAccount/index.js",
19918 "groupTitle": "Salesforce_Accounts"
19922 "url": "/api/integrations/salesforce/accounts",
19923 "title": "Gets a list of Salesforce Accounts",
19926 "title": "Example usage:",
19927 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
19931 "name": "GetSalesforce_Accounts",
19932 "group": "Salesforce_Accounts",
19933 "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>",
19934 "version": "0.0.0",
19935 "filename": "server/api/intSalesforceAccount/index.js",
19936 "groupTitle": "Salesforce_Accounts"
19940 "url": "/api/integrations/salesforce/accounts/{id}",
19941 "title": "Gets a single Salesforce Account",
19944 "title": "Example usage:",
19945 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
19949 "name": "ShowSalesforce_Accounts",
19950 "group": "Salesforce_Accounts",
19951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19952 "version": "0.0.0",
19953 "filename": "server/api/intSalesforceAccount/index.js",
19954 "groupTitle": "Salesforce_Accounts"
19958 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
19959 "title": "Creates new configuration",
19962 "title": "Example usage:",
19963 "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",
19967 "name": "addConfiguration",
19968 "group": "Salesforce_Accounts",
19969 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19970 "version": "0.0.0",
19971 "filename": "server/api/intSalesforceAccount/index.js",
19972 "groupTitle": "Salesforce_Accounts"
19976 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
19977 "title": "Gets account configurations",
19980 "title": "Example usage:",
19981 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
19985 "name": "getConfigurations",
19986 "group": "Salesforce_Accounts",
19987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19988 "version": "0.0.0",
19989 "filename": "server/api/intSalesforceAccount/index.js",
19990 "groupTitle": "Salesforce_Accounts"
19994 "url": "/api/integrations/salesforce/accounts/{id}/fields",
19995 "title": "Gets account fields",
19998 "title": "Example usage:",
19999 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20003 "name": "getFields",
20004 "group": "Salesforce_Accounts",
20005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20006 "version": "0.0.0",
20007 "filename": "server/api/intSalesforceAccount/index.js",
20008 "groupTitle": "Salesforce_Accounts"
20012 "url": "/api/integrations/salesforce/accounts/{id}",
20013 "title": "Update an existing Salesforce Account",
20016 "title": "Example usage:",
20017 "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",
20021 "name": "updateSalesforce_Accounts",
20022 "group": "Salesforce_Accounts",
20023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20024 "version": "0.0.0",
20025 "filename": "server/api/intSalesforceAccount/index.js",
20026 "groupTitle": "Salesforce_Accounts"
20030 "url": "/api/integrations/salesforce/configurations",
20031 "title": "Creates a new Salesforce Configuration",
20034 "title": "Example usage:",
20035 "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",
20039 "name": "CreateSalesforce_Configurations",
20040 "group": "Salesforce_Configurations",
20055 "field": "description",
20066 "field": "ticketType",
20073 "\"contact_lead\"",
20078 "field": "moduleSearch",
20090 "field": "moduleCreate",
20096 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20097 "version": "0.0.0",
20098 "filename": "server/api/intSalesforceConfiguration/index.js",
20099 "groupTitle": "Salesforce_Configurations"
20103 "url": "/api/integrations/salesforce/configurations/{id}",
20104 "title": "Deletes a Salesforce Configuration",
20107 "title": "Example usage:",
20108 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20112 "name": "DeleteSalesforce_Configurations",
20113 "group": "Salesforce_Configurations",
20114 "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>",
20115 "version": "0.0.0",
20116 "filename": "server/api/intSalesforceConfiguration/index.js",
20117 "groupTitle": "Salesforce_Configurations"
20121 "url": "/api/integrations/salesforce/configurations",
20122 "title": "Gets a list of Salesforce Configurations",
20125 "title": "Example usage:",
20126 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20130 "name": "GetSalesforce_Configurations",
20131 "group": "Salesforce_Configurations",
20132 "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>",
20133 "version": "0.0.0",
20134 "filename": "server/api/intSalesforceConfiguration/index.js",
20135 "groupTitle": "Salesforce_Configurations"
20139 "url": "/api/integrations/salesforce/configurations/{id}",
20140 "title": "Gets a single Salesforce Configuration",
20143 "title": "Example usage:",
20144 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20148 "name": "ShowSalesforce_Configurations",
20149 "group": "Salesforce_Configurations",
20150 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20151 "version": "0.0.0",
20152 "filename": "server/api/intSalesforceConfiguration/index.js",
20153 "groupTitle": "Salesforce_Configurations"
20157 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20158 "title": "Gets configurations descriptions",
20161 "title": "Example usage:",
20162 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20166 "name": "getDescriptions",
20167 "group": "Salesforce_Configurations",
20168 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20169 "version": "0.0.0",
20170 "filename": "server/api/intSalesforceConfiguration/index.js",
20171 "groupTitle": "Salesforce_Configurations"
20175 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20176 "title": "Gets configurations fields",
20179 "title": "Example usage:",
20180 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20184 "name": "getFields",
20185 "group": "Salesforce_Configurations",
20186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20187 "version": "0.0.0",
20188 "filename": "server/api/intSalesforceConfiguration/index.js",
20189 "groupTitle": "Salesforce_Configurations"
20193 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20194 "title": "Gets configurations subjects",
20197 "title": "Example usage:",
20198 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20202 "name": "getSubjects",
20203 "group": "Salesforce_Configurations",
20204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20205 "version": "0.0.0",
20206 "filename": "server/api/intSalesforceConfiguration/index.js",
20207 "groupTitle": "Salesforce_Configurations"
20211 "url": "/api/integrations/salesforce/configurations/{id}",
20212 "title": "Update an existing Salesforce Configuration",
20215 "title": "Example usage:",
20216 "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",
20220 "name": "updateSalesforce_Configurations",
20221 "group": "Salesforce_Configurations",
20222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20223 "version": "0.0.0",
20224 "filename": "server/api/intSalesforceConfiguration/index.js",
20225 "groupTitle": "Salesforce_Configurations"
20229 "url": "/api/integrations/salesforce/fields",
20230 "title": "Creates a new Salesforce Field",
20233 "title": "Example usage:",
20234 "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",
20238 "name": "CreateSalesforce_Fields",
20239 "group": "Salesforce_Fields",
20249 "\"customVariable\"",
20260 "field": "content",
20276 "\"customVariable\""
20279 "field": "keyType",
20286 "field": "keyContent",
20293 "field": "idField",
20300 "field": "variableName",
20306 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20307 "version": "0.0.0",
20308 "filename": "server/api/intSalesforceField/index.js",
20309 "groupTitle": "Salesforce_Fields"
20313 "url": "/api/integrations/salesforce/fields/{id}",
20314 "title": "Deletes a Salesforce Field",
20317 "title": "Example usage:",
20318 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20322 "name": "DeleteSalesforce_Fields",
20323 "group": "Salesforce_Fields",
20324 "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>",
20325 "version": "0.0.0",
20326 "filename": "server/api/intSalesforceField/index.js",
20327 "groupTitle": "Salesforce_Fields"
20331 "url": "/api/integrations/salesforce/fields",
20332 "title": "Gets a list of Salesforce Fields",
20335 "title": "Example usage:",
20336 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20340 "name": "GetSalesforce_Fields",
20341 "group": "Salesforce_Fields",
20342 "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>",
20343 "version": "0.0.0",
20344 "filename": "server/api/intSalesforceField/index.js",
20345 "groupTitle": "Salesforce_Fields"
20349 "url": "/api/integrations/salesforce/fields/{id}",
20350 "title": "Gets a single Salesforce Field",
20353 "title": "Example usage:",
20354 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20358 "name": "ShowSalesforce_Fields",
20359 "group": "Salesforce_Fields",
20360 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20361 "version": "0.0.0",
20362 "filename": "server/api/intSalesforceField/index.js",
20363 "groupTitle": "Salesforce_Fields"
20367 "url": "/api/integrations/salesforce/fields/{id}",
20368 "title": "Update an existing Salesforce Field",
20371 "title": "Example usage:",
20372 "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",
20376 "name": "updateSalesforce_Fields",
20377 "group": "Salesforce_Fields",
20378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20379 "version": "0.0.0",
20380 "filename": "server/api/intSalesforceField/index.js",
20381 "groupTitle": "Salesforce_Fields"
20385 "url": "/api/schedules",
20386 "title": "Creates a new Schedule",
20389 "title": "Example usage:",
20390 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20394 "name": "CreateSchedules",
20395 "group": "Schedules",
20410 "field": "description",
20431 "field": "startAt",
20445 "field": "subtractNumber",
20461 "field": "subtractUnit",
20491 "field": "sendMail",
20519 "field": "sendIfEmpty",
20525 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20526 "version": "0.0.0",
20527 "filename": "server/api/schedule/index.js",
20528 "groupTitle": "Schedules"
20532 "url": "/api/schedules/{id}",
20533 "title": "Deletes a Schedule",
20536 "title": "Example usage:",
20537 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20541 "name": "DeleteSchedules",
20542 "group": "Schedules",
20543 "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>",
20544 "version": "0.0.0",
20545 "filename": "server/api/schedule/index.js",
20546 "groupTitle": "Schedules"
20550 "url": "/api/schedules",
20551 "title": "Gets a list of Schedules",
20554 "title": "Example usage:",
20555 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20559 "name": "GetSchedules",
20560 "group": "Schedules",
20561 "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>",
20562 "version": "0.0.0",
20563 "filename": "server/api/schedule/index.js",
20564 "groupTitle": "Schedules"
20568 "url": "/api/schedules/{id}",
20569 "title": "Gets a single Schedule",
20572 "title": "Example usage:",
20573 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
20577 "name": "ShowSchedules",
20578 "group": "Schedules",
20579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20580 "version": "0.0.0",
20581 "filename": "server/api/schedule/index.js",
20582 "groupTitle": "Schedules"
20586 "url": "/api/schedules/{id}/run",
20587 "title": "Run Scheduler",
20590 "title": "Example usage:",
20591 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
20596 "group": "Schedules",
20597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20598 "version": "0.0.0",
20599 "filename": "server/api/schedule/index.js",
20600 "groupTitle": "Schedules"
20604 "url": "/api/schedules/{id}",
20605 "title": "Update an existing Schedule",
20608 "title": "Example usage:",
20609 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20613 "name": "updateSchedules",
20614 "group": "Schedules",
20615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20616 "version": "0.0.0",
20617 "filename": "server/api/schedule/index.js",
20618 "groupTitle": "Schedules"
20622 "url": "/api/screen/recordings",
20623 "title": "Creates a new Recording",
20626 "title": "Example usage:",
20627 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20631 "name": "CreateRecordings",
20632 "group": "Screen_Recordings",
20647 "field": "interactionid",
20654 "field": "channel",
20675 "field": "duration",
20682 "field": "startedAt",
20689 "field": "closedAt",
20696 "field": "createdAt",
20703 "field": "updatedAt",
20709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20710 "version": "0.0.0",
20711 "filename": "server/api/screenRecording/index.js",
20712 "groupTitle": "Screen_Recordings"
20716 "url": "/api/screen/recordings/describe",
20717 "title": "Gets table info about Recordings",
20720 "title": "Example usage:",
20721 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
20725 "name": "DescribeRecordings",
20726 "group": "Screen_Recordings",
20727 "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>",
20728 "version": "0.0.0",
20729 "filename": "server/api/screenRecording/index.js",
20730 "groupTitle": "Screen_Recordings"
20734 "url": "/api/screen/recordings",
20735 "title": "Gets a list of Recordings",
20738 "title": "Example usage:",
20739 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
20743 "name": "GetRecordings",
20744 "group": "Screen_Recordings",
20745 "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>",
20746 "version": "0.0.0",
20747 "filename": "server/api/screenRecording/index.js",
20748 "groupTitle": "Screen_Recordings"
20752 "url": "/api/screen/recordings/{id}",
20753 "title": "Gets a single Recording",
20756 "title": "Example usage:",
20757 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
20761 "name": "ShowRecordings",
20762 "group": "Screen_Recordings",
20763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20764 "version": "0.0.0",
20765 "filename": "server/api/screenRecording/index.js",
20766 "groupTitle": "Screen_Recordings"
20770 "url": "/api/screen/recordings/{id}",
20771 "title": "Delete screen recording",
20774 "title": "Example usage:",
20775 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
20780 "group": "Screen_Recordings",
20781 "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>",
20782 "version": "0.0.0",
20783 "filename": "server/api/screenRecording/index.js",
20784 "groupTitle": "Screen_Recordings"
20788 "url": "/api/screen/recordings/{id}/download",
20789 "title": "Download Recording",
20792 "title": "Example usage:",
20793 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
20797 "name": "download",
20798 "group": "Screen_Recordings",
20799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20800 "version": "0.0.0",
20801 "filename": "server/api/screenRecording/index.js",
20802 "groupTitle": "Screen_Recordings"
20806 "url": "/api/screen/recordings/{id}",
20807 "title": "Update an existing Recording",
20810 "title": "Example usage:",
20811 "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",
20815 "name": "updateRecordings",
20816 "group": "Screen_Recordings",
20817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20818 "version": "0.0.0",
20819 "filename": "server/api/screenRecording/index.js",
20820 "groupTitle": "Screen_Recordings"
20824 "url": "/api/integrations/servicenow/accounts",
20825 "title": "Creates a new Servicenow Account",
20828 "title": "Example usage:",
20829 "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",
20833 "name": "CreateServicenow_Accounts",
20834 "group": "Servicenow_Accounts",
20849 "field": "description",
20856 "field": "username",
20863 "field": "password",
20877 "field": "remoteUri",
20884 "field": "serverUrl",
20890 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20891 "version": "0.0.0",
20892 "filename": "server/api/intServicenowAccount/index.js",
20893 "groupTitle": "Servicenow_Accounts"
20897 "url": "/api/integrations/servicenow/accounts/{id}",
20898 "title": "Deletes a Servicenow Account",
20901 "title": "Example usage:",
20902 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
20906 "name": "DeleteServicenow_Accounts",
20907 "group": "Servicenow_Accounts",
20908 "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>",
20909 "version": "0.0.0",
20910 "filename": "server/api/intServicenowAccount/index.js",
20911 "groupTitle": "Servicenow_Accounts"
20915 "url": "/api/integrations/servicenow/accounts",
20916 "title": "Gets a list of Servicenow Accounts",
20919 "title": "Example usage:",
20920 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
20924 "name": "GetServicenow_Accounts",
20925 "group": "Servicenow_Accounts",
20926 "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>",
20927 "version": "0.0.0",
20928 "filename": "server/api/intServicenowAccount/index.js",
20929 "groupTitle": "Servicenow_Accounts"
20933 "url": "/api/integrations/servicenow/accounts/{id}",
20934 "title": "Gets a single Servicenow Account",
20937 "title": "Example usage:",
20938 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
20942 "name": "ShowServicenow_Accounts",
20943 "group": "Servicenow_Accounts",
20944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20945 "version": "0.0.0",
20946 "filename": "server/api/intServicenowAccount/index.js",
20947 "groupTitle": "Servicenow_Accounts"
20951 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
20952 "title": "Creates new configuration",
20955 "title": "Example usage:",
20956 "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",
20960 "name": "addConfiguration",
20961 "group": "Servicenow_Accounts",
20962 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20963 "version": "0.0.0",
20964 "filename": "server/api/intServicenowAccount/index.js",
20965 "groupTitle": "Servicenow_Accounts"
20969 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
20970 "title": "Gets account configurations",
20973 "title": "Example usage:",
20974 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20978 "name": "getConfigurations",
20979 "group": "Servicenow_Accounts",
20980 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20981 "version": "0.0.0",
20982 "filename": "server/api/intServicenowAccount/index.js",
20983 "groupTitle": "Servicenow_Accounts"
20987 "url": "/api/integrations/servicenow/accounts/{id}/fields",
20988 "title": "Gets account fields",
20991 "title": "Example usage:",
20992 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
20996 "name": "getFields",
20997 "group": "Servicenow_Accounts",
20998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20999 "version": "0.0.0",
21000 "filename": "server/api/intServicenowAccount/index.js",
21001 "groupTitle": "Servicenow_Accounts"
21005 "url": "/api/integrations/servicenow/accounts/{id}",
21006 "title": "Update an existing Servicenow Account",
21009 "title": "Example usage:",
21010 "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",
21014 "name": "updateServicenow_Accounts",
21015 "group": "Servicenow_Accounts",
21016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21017 "version": "0.0.0",
21018 "filename": "server/api/intServicenowAccount/index.js",
21019 "groupTitle": "Servicenow_Accounts"
21023 "url": "/api/integrations/servicenow/configurations",
21024 "title": "Creates a new Servicenow Configuration",
21027 "title": "Example usage:",
21028 "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",
21032 "name": "CreateServicenow_Configurations",
21033 "group": "Servicenow_Configurations",
21048 "field": "description",
21054 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21055 "version": "0.0.0",
21056 "filename": "server/api/intServicenowConfiguration/index.js",
21057 "groupTitle": "Servicenow_Configurations"
21061 "url": "/api/integrations/servicenow/configurations/{id}",
21062 "title": "Deletes a Servicenow Configuration",
21065 "title": "Example usage:",
21066 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21070 "name": "DeleteServicenow_Configurations",
21071 "group": "Servicenow_Configurations",
21072 "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>",
21073 "version": "0.0.0",
21074 "filename": "server/api/intServicenowConfiguration/index.js",
21075 "groupTitle": "Servicenow_Configurations"
21079 "url": "/api/integrations/servicenow/configurations",
21080 "title": "Gets a list of Servicenow Configurations",
21083 "title": "Example usage:",
21084 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21088 "name": "GetServicenow_Configurations",
21089 "group": "Servicenow_Configurations",
21090 "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>",
21091 "version": "0.0.0",
21092 "filename": "server/api/intServicenowConfiguration/index.js",
21093 "groupTitle": "Servicenow_Configurations"
21097 "url": "/api/integrations/servicenow/configurations/{id}",
21098 "title": "Gets a single Servicenow Configuration",
21101 "title": "Example usage:",
21102 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21106 "name": "ShowServicenow_Configurations",
21107 "group": "Servicenow_Configurations",
21108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21109 "version": "0.0.0",
21110 "filename": "server/api/intServicenowConfiguration/index.js",
21111 "groupTitle": "Servicenow_Configurations"
21115 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21116 "title": "Gets configurations descriptions",
21119 "title": "Example usage:",
21120 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21124 "name": "getDescriptions",
21125 "group": "Servicenow_Configurations",
21126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21127 "version": "0.0.0",
21128 "filename": "server/api/intServicenowConfiguration/index.js",
21129 "groupTitle": "Servicenow_Configurations"
21133 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21134 "title": "Gets configurations fields",
21137 "title": "Example usage:",
21138 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21142 "name": "getFields",
21143 "group": "Servicenow_Configurations",
21144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21145 "version": "0.0.0",
21146 "filename": "server/api/intServicenowConfiguration/index.js",
21147 "groupTitle": "Servicenow_Configurations"
21151 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21152 "title": "Gets configurations subjects",
21155 "title": "Example usage:",
21156 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21160 "name": "getSubjects",
21161 "group": "Servicenow_Configurations",
21162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21163 "version": "0.0.0",
21164 "filename": "server/api/intServicenowConfiguration/index.js",
21165 "groupTitle": "Servicenow_Configurations"
21169 "url": "/api/integrations/servicenow/configurations/{id}",
21170 "title": "Update an existing Servicenow Configuration",
21173 "title": "Example usage:",
21174 "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",
21178 "name": "updateServicenow_Configurations",
21179 "group": "Servicenow_Configurations",
21180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21181 "version": "0.0.0",
21182 "filename": "server/api/intServicenowConfiguration/index.js",
21183 "groupTitle": "Servicenow_Configurations"
21187 "url": "/api/integrations/servicenow/fields",
21188 "title": "Creates a new Servicenow Field",
21191 "title": "Example usage:",
21192 "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",
21196 "name": "CreateServicenow_Fields",
21197 "group": "Servicenow_Fields",
21207 "\"customVariable\"",
21218 "field": "content",
21234 "\"customVariable\""
21237 "field": "keyType",
21244 "field": "keyContent",
21251 "field": "idField",
21258 "field": "nameField",
21265 "field": "customField",
21272 "field": "variableName",
21278 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21279 "version": "0.0.0",
21280 "filename": "server/api/intServicenowField/index.js",
21281 "groupTitle": "Servicenow_Fields"
21285 "url": "/api/integrations/servicenow/fields/{id}",
21286 "title": "Deletes a Servicenow Field",
21289 "title": "Example usage:",
21290 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21294 "name": "DeleteServicenow_Fields",
21295 "group": "Servicenow_Fields",
21296 "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>",
21297 "version": "0.0.0",
21298 "filename": "server/api/intServicenowField/index.js",
21299 "groupTitle": "Servicenow_Fields"
21303 "url": "/api/integrations/servicenow/fields",
21304 "title": "Gets a list of Servicenow Fields",
21307 "title": "Example usage:",
21308 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21312 "name": "GetServicenow_Fields",
21313 "group": "Servicenow_Fields",
21314 "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>",
21315 "version": "0.0.0",
21316 "filename": "server/api/intServicenowField/index.js",
21317 "groupTitle": "Servicenow_Fields"
21321 "url": "/api/integrations/servicenow/fields/{id}",
21322 "title": "Gets a single Servicenow Field",
21325 "title": "Example usage:",
21326 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21330 "name": "ShowServicenow_Fields",
21331 "group": "Servicenow_Fields",
21332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21333 "version": "0.0.0",
21334 "filename": "server/api/intServicenowField/index.js",
21335 "groupTitle": "Servicenow_Fields"
21339 "url": "/api/integrations/servicenow/fields/{id}",
21340 "title": "Update an existing Servicenow Field",
21343 "title": "Example usage:",
21344 "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",
21348 "name": "updateServicenow_Fields",
21349 "group": "Servicenow_Fields",
21350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21351 "version": "0.0.0",
21352 "filename": "server/api/intServicenowField/index.js",
21353 "groupTitle": "Servicenow_Fields"
21357 "url": "/api/settings",
21358 "title": "Gets a list of Settings",
21361 "title": "Example usage:",
21362 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21366 "name": "GetSettings",
21367 "group": "Settings",
21368 "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>",
21369 "version": "0.0.0",
21370 "filename": "server/api/setting/index.js",
21371 "groupTitle": "Settings"
21375 "url": "/api/settings/{id}",
21376 "title": "Gets a single Setting",
21379 "title": "Example usage:",
21380 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21384 "name": "ShowSettings",
21385 "group": "Settings",
21386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21387 "version": "0.0.0",
21388 "filename": "server/api/setting/index.js",
21389 "groupTitle": "Settings"
21393 "url": "/api/settings/{id}/favicon",
21394 "title": "Add Favicon",
21397 "title": "Example usage:",
21398 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21402 "name": "addFavicon",
21403 "group": "Settings",
21404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21405 "version": "0.0.0",
21406 "filename": "server/api/setting/index.js",
21407 "groupTitle": "Settings"
21411 "url": "/api/settings/{id}/logo",
21412 "title": "Add logo",
21415 "title": "Example usage:",
21416 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21421 "group": "Settings",
21422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21423 "version": "0.0.0",
21424 "filename": "server/api/setting/index.js",
21425 "groupTitle": "Settings"
21429 "url": "/api/settings/{id}/logo_login",
21430 "title": "Add logo login",
21433 "title": "Example usage:",
21434 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21438 "name": "addLogoLogin",
21439 "group": "Settings",
21440 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21441 "version": "0.0.0",
21442 "filename": "server/api/setting/index.js",
21443 "groupTitle": "Settings"
21447 "url": "/api/settings/{id}/preferred",
21448 "title": "Add Preferred",
21451 "title": "Example usage:",
21452 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21456 "name": "addPreferred",
21457 "group": "Settings",
21458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21459 "version": "0.0.0",
21460 "filename": "server/api/setting/index.js",
21461 "groupTitle": "Settings"
21465 "url": "/api/settings/{id}/favicon",
21466 "title": "Get Favicon",
21469 "title": "Example usage:",
21470 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21474 "name": "getFavicon",
21475 "group": "Settings",
21476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21477 "version": "0.0.0",
21478 "filename": "server/api/setting/index.js",
21479 "groupTitle": "Settings"
21483 "url": "/api/settings/{id}/gdpr",
21484 "title": "Get gdpr settings",
21487 "title": "Example usage:",
21488 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21493 "group": "Settings",
21494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21495 "version": "0.0.0",
21496 "filename": "server/api/setting/index.js",
21497 "groupTitle": "Settings"
21501 "url": "/api/settings/{id}/logo",
21502 "title": "Get logo",
21505 "title": "Example usage:",
21506 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21511 "group": "Settings",
21512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21513 "version": "0.0.0",
21514 "filename": "server/api/setting/index.js",
21515 "groupTitle": "Settings"
21519 "url": "/api/settings/{id}/logo_login",
21520 "title": "Get logo login",
21523 "title": "Example usage:",
21524 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21528 "name": "getLogoLogin",
21529 "group": "Settings",
21530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21531 "version": "0.0.0",
21532 "filename": "server/api/setting/index.js",
21533 "groupTitle": "Settings"
21537 "url": "/api/settings/{id}/preferred",
21538 "title": "Get Preferred",
21541 "title": "Example usage:",
21542 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21546 "name": "getPreferred",
21547 "group": "Settings",
21548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21549 "version": "0.0.0",
21550 "filename": "server/api/setting/index.js",
21551 "groupTitle": "Settings"
21555 "url": "/api/settings/{id}",
21556 "title": "Update an existing Setting",
21559 "title": "Example usage:",
21560 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21564 "name": "updateSettings",
21565 "group": "Settings",
21566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21567 "version": "0.0.0",
21568 "filename": "server/api/setting/index.js",
21569 "groupTitle": "Settings"
21573 "url": "/api/sms/accounts/{id}/users",
21574 "title": "Add agents to a sms account",
21577 "title": "Example usage:",
21578 "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",
21582 "name": "AddAgents",
21583 "group": "Sms_Accounts",
21584 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21585 "version": "0.0.0",
21586 "filename": "server/api/smsAccount/index.js",
21587 "groupTitle": "Sms_Accounts"
21591 "url": "/api/sms/accounts",
21592 "title": "Creates a new Account",
21595 "title": "Example usage:",
21596 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21600 "name": "CreateAccounts",
21601 "group": "Sms_Accounts",
21662 "field": "accountSid",
21676 "field": "authToken",
21688 "field": "smsMethod",
21695 "field": "username",
21702 "field": "password",
21716 "field": "senderString",
21723 "field": "deliveryReport",
21730 "field": "description",
21737 "field": "notificationTemplate",
21744 "field": "notificationSound",
21751 "field": "notificationShake",
21758 "field": "waitForTheAssignedAgent",
21765 "field": "queueTransfer",
21772 "field": "queueTransferTimeout",
21779 "field": "agentTransfer",
21786 "field": "agentTransferTimeout",
21793 "field": "baseUrl",
21800 "field": "mandatoryDispositionPauseId",
21801 "description": "<p>Status to put when mandatory disposition is enabled</p>"
21807 "field": "mandatoryDisposition",
21808 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
21813 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21814 "version": "0.0.0",
21815 "filename": "server/api/smsAccount/index.js",
21816 "groupTitle": "Sms_Accounts"
21820 "url": "/api/sms/accounts/{id}",
21821 "title": "Deletes a Account",
21824 "title": "Example usage:",
21825 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
21829 "name": "DeleteAccounts",
21830 "group": "Sms_Accounts",
21831 "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>",
21832 "version": "0.0.0",
21833 "filename": "server/api/smsAccount/index.js",
21834 "groupTitle": "Sms_Accounts"
21838 "url": "/api/sms/accounts/describe",
21839 "title": "Gets table info about Accounts",
21842 "title": "Example usage:",
21843 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
21847 "name": "DescribeAccounts",
21848 "group": "Sms_Accounts",
21849 "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>",
21850 "version": "0.0.0",
21851 "filename": "server/api/smsAccount/index.js",
21852 "groupTitle": "Sms_Accounts"
21856 "url": "/api/sms/accounts",
21857 "title": "Gets a list of Accounts",
21860 "title": "Example usage:",
21861 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
21865 "name": "GetAccounts",
21866 "group": "Sms_Accounts",
21867 "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>",
21868 "version": "0.0.0",
21869 "filename": "server/api/smsAccount/index.js",
21870 "groupTitle": "Sms_Accounts"
21874 "url": "/api/sms/accounts/{id}/users",
21875 "title": "Gets agents from sms account",
21878 "title": "Example usage:",
21879 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
21883 "name": "GetAgents",
21884 "group": "Sms_Accounts",
21885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21886 "version": "0.0.0",
21887 "filename": "server/api/smsAccount/index.js",
21888 "groupTitle": "Sms_Accounts"
21892 "url": "/api/sms/accounts/{id}/users",
21893 "title": "Removes agents from a sms account",
21896 "title": "Example usage:",
21897 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
21901 "name": "RemoveAgents",
21902 "group": "Sms_Accounts",
21903 "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>",
21904 "version": "0.0.0",
21905 "filename": "server/api/smsAccount/index.js",
21906 "groupTitle": "Sms_Accounts"
21910 "url": "/api/sms/accounts/{id}/canned_answers",
21911 "title": "Removes canned answers from account",
21914 "title": "Example usage:",
21915 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
21919 "name": "RemoveAnswers",
21920 "group": "Sms_Accounts",
21921 "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>",
21922 "version": "0.0.0",
21923 "filename": "server/api/smsAccount/index.js",
21924 "groupTitle": "Sms_Accounts"
21928 "url": "/api/sms/accounts/{id}/dispositions",
21929 "title": "Removes dispositions from account",
21932 "title": "Example usage:",
21933 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
21937 "name": "RemoveDispositions",
21938 "group": "Sms_Accounts",
21939 "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>",
21940 "version": "0.0.0",
21941 "filename": "server/api/smsAccount/index.js",
21942 "groupTitle": "Sms_Accounts"
21946 "url": "/api/sms/accounts/{id}",
21947 "title": "Gets a single Account",
21950 "title": "Example usage:",
21951 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
21955 "name": "ShowAccounts",
21956 "group": "Sms_Accounts",
21957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21958 "version": "0.0.0",
21959 "filename": "server/api/smsAccount/index.js",
21960 "groupTitle": "Sms_Accounts"
21964 "url": "/api/sms/messages/{id}/accept",
21965 "title": "Accepts message",
21968 "title": "Example usage:",
21969 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
21973 "name": "acceptMessage",
21974 "group": "Sms_Accounts",
21975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21976 "version": "0.0.0",
21977 "filename": "server/api/smsMessage/index.js",
21978 "groupTitle": "Sms_Accounts"
21982 "url": "/api/sms/accounts/{id}/canned_answers",
21983 "title": "Creates new canned answer",
21986 "title": "Example usage:",
21987 "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",
21991 "name": "addAnswer",
21992 "group": "Sms_Accounts",
22014 "field": "description",
22027 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22028 "version": "0.0.0",
22029 "filename": "server/api/smsAccount/index.js",
22030 "groupTitle": "Sms_Accounts"
22034 "url": "/api/sms/accounts/{id}/applications",
22035 "title": "Creates new applications",
22038 "title": "Example usage:",
22039 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22043 "name": "addApplications",
22044 "group": "Sms_Accounts",
22052 "field": "priority",
22066 "field": "appdata",
22073 "field": "description",
22080 "field": "interval",
22086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22087 "version": "0.0.0",
22088 "filename": "server/api/smsAccount/index.js",
22089 "groupTitle": "Sms_Accounts"
22093 "url": "/api/sms/accounts/{id}/dispositions",
22094 "title": "Creates new disposition",
22097 "title": "Example usage:",
22098 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22102 "name": "addDisposition",
22103 "group": "Sms_Accounts",
22117 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22118 "version": "0.0.0",
22119 "filename": "server/api/smsAccount/index.js",
22120 "groupTitle": "Sms_Accounts"
22124 "url": "/api/sms/accounts/{id}/canned_answers",
22125 "title": "Gets account canned answers",
22128 "title": "Example usage:",
22129 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22133 "name": "getAnswers",
22134 "group": "Sms_Accounts",
22135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22136 "version": "0.0.0",
22137 "filename": "server/api/smsAccount/index.js",
22138 "groupTitle": "Sms_Accounts"
22142 "url": "/api/sms/accounts/{id}/applications",
22143 "title": "Gets account applications",
22146 "title": "Example usage:",
22147 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22151 "name": "getApplications",
22152 "group": "Sms_Accounts",
22153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22154 "version": "0.0.0",
22155 "filename": "server/api/smsAccount/index.js",
22156 "groupTitle": "Sms_Accounts"
22160 "url": "/api/sms/accounts/{id}/dispositions",
22161 "title": "Gets account dispositions",
22164 "title": "Example usage:",
22165 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22169 "name": "getDispositions",
22170 "group": "Sms_Accounts",
22171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22172 "version": "0.0.0",
22173 "filename": "server/api/smsAccount/index.js",
22174 "groupTitle": "Sms_Accounts"
22178 "url": "/api/sms/accounts/{id}/interactions",
22179 "title": "Gets Sms Account interactions",
22182 "title": "Example usage:",
22183 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22187 "name": "getInteractions",
22188 "group": "Sms_Accounts",
22189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22190 "version": "0.0.0",
22191 "filename": "server/api/smsAccount/index.js",
22192 "groupTitle": "Sms_Accounts"
22196 "url": "/api/sms/accounts/{id}/notify",
22197 "title": "Notify new message",
22200 "title": "Example usage:",
22201 "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",
22206 "group": "Sms_Accounts",
22207 "description": "<p>Motion 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>",
22208 "version": "0.0.0",
22209 "filename": "server/api/smsAccount/index.js",
22210 "groupTitle": "Sms_Accounts"
22214 "url": "/api/sms/messages/{id}/reject",
22215 "title": "Rejects message",
22218 "title": "Example usage:",
22219 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22223 "name": "rejectMessage",
22224 "group": "Sms_Accounts",
22225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22226 "version": "0.0.0",
22227 "filename": "server/api/smsMessage/index.js",
22228 "groupTitle": "Sms_Accounts"
22232 "url": "/api/sms/accounts/{id}/send",
22233 "title": "Send new sms message",
22236 "title": "Example usage:",
22237 "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",
22242 "group": "Sms_Accounts",
22243 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22244 "version": "0.0.0",
22245 "filename": "server/api/smsAccount/index.js",
22246 "groupTitle": "Sms_Accounts"
22250 "url": "/api/sms/messages/{id}/status",
22251 "title": "Receive message status",
22254 "title": "Example usage:",
22255 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22259 "name": "statusMessage",
22260 "group": "Sms_Accounts",
22261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22262 "version": "0.0.0",
22263 "filename": "server/api/smsMessage/index.js",
22264 "groupTitle": "Sms_Accounts"
22268 "url": "/api/sms/accounts/{id}/status",
22269 "title": "Receive message status as get request",
22272 "title": "Example usage:",
22273 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22277 "name": "statusMessage",
22278 "group": "Sms_Accounts",
22279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22280 "version": "0.0.0",
22281 "filename": "server/api/smsAccount/index.js",
22282 "groupTitle": "Sms_Accounts"
22286 "url": "/api/sms/accounts/{id}/status",
22287 "title": "Receive message status",
22290 "title": "Example usage:",
22291 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22295 "name": "statusMessage",
22296 "group": "Sms_Accounts",
22297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22298 "version": "0.0.0",
22299 "filename": "server/api/smsAccount/index.js",
22300 "groupTitle": "Sms_Accounts"
22304 "url": "/api/sms/accounts/{id}",
22305 "title": "Update an existing Account",
22308 "title": "Example usage:",
22309 "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",
22313 "name": "updateAccounts",
22314 "group": "Sms_Accounts",
22315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22316 "version": "0.0.0",
22317 "filename": "server/api/smsAccount/index.js",
22318 "groupTitle": "Sms_Accounts"
22322 "url": "/api/sms/applications",
22323 "title": "Creates a new Application",
22326 "title": "Example usage:",
22327 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22331 "name": "CreateApplications",
22332 "group": "Sms_Applications",
22340 "field": "priority",
22354 "field": "appdata",
22361 "field": "description",
22368 "field": "interval",
22374 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22375 "version": "0.0.0",
22376 "filename": "server/api/smsApplication/index.js",
22377 "groupTitle": "Sms_Applications"
22381 "url": "/api/sms/applications/{id}",
22382 "title": "Deletes a Application",
22385 "title": "Example usage:",
22386 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22390 "name": "DeleteApplications",
22391 "group": "Sms_Applications",
22392 "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>",
22393 "version": "0.0.0",
22394 "filename": "server/api/smsApplication/index.js",
22395 "groupTitle": "Sms_Applications"
22399 "url": "/api/sms/applications",
22400 "title": "Gets a list of Applications",
22403 "title": "Example usage:",
22404 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22408 "name": "GetApplications",
22409 "group": "Sms_Applications",
22410 "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>",
22411 "version": "0.0.0",
22412 "filename": "server/api/smsApplication/index.js",
22413 "groupTitle": "Sms_Applications"
22417 "url": "/api/sms/applications/{id}",
22418 "title": "Gets a single Application",
22421 "title": "Example usage:",
22422 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22426 "name": "ShowApplications",
22427 "group": "Sms_Applications",
22428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22429 "version": "0.0.0",
22430 "filename": "server/api/smsApplication/index.js",
22431 "groupTitle": "Sms_Applications"
22435 "url": "/api/sms/applications/{id}",
22436 "title": "Update an existing Application",
22439 "title": "Example usage:",
22440 "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",
22444 "name": "updateApplications",
22445 "group": "Sms_Applications",
22446 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22447 "version": "0.0.0",
22448 "filename": "server/api/smsApplication/index.js",
22449 "groupTitle": "Sms_Applications"
22453 "url": "/api/sms/interactions/{id}/tags",
22454 "title": "Add tags to the interaction",
22457 "title": "Example usage:",
22458 "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",
22463 "group": "Sms_Interactions",
22464 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22465 "version": "0.0.0",
22466 "filename": "server/api/smsInteraction/index.js",
22467 "groupTitle": "Sms_Interactions"
22471 "url": "/api/sms/interactions",
22472 "title": "Creates a new Interaction",
22475 "title": "Example usage:",
22476 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22480 "name": "CreateInteractions",
22481 "group": "Sms_Interactions",
22496 "field": "closedAt",
22503 "field": "disposition",
22524 "field": "read1stAt",
22535 "field": "firstMsgDirection",
22542 "field": "lastMsgAt",
22553 "field": "lastMsgDirection",
22559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22560 "version": "0.0.0",
22561 "filename": "server/api/smsInteraction/index.js",
22562 "groupTitle": "Sms_Interactions"
22566 "url": "/api/sms/interactions/{id}",
22567 "title": "Deletes a Interaction",
22570 "title": "Example usage:",
22571 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
22575 "name": "DeleteInteractions",
22576 "group": "Sms_Interactions",
22577 "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>",
22578 "version": "0.0.0",
22579 "filename": "server/api/smsInteraction/index.js",
22580 "groupTitle": "Sms_Interactions"
22584 "url": "/api/sms/interactions/describe",
22585 "title": "Gets table info about Interactions",
22588 "title": "Example usage:",
22589 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
22593 "name": "DescribeInteractions",
22594 "group": "Sms_Interactions",
22595 "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>",
22596 "version": "0.0.0",
22597 "filename": "server/api/smsInteraction/index.js",
22598 "groupTitle": "Sms_Interactions"
22602 "url": "/api/sms/interactions",
22603 "title": "Gets a list of Interactions",
22606 "title": "Example usage:",
22607 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
22611 "name": "GetInteractions",
22612 "group": "Sms_Interactions",
22613 "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>",
22614 "version": "0.0.0",
22615 "filename": "server/api/smsInteraction/index.js",
22616 "groupTitle": "Sms_Interactions"
22620 "url": "/api/sms/interactions/{id}/tags",
22621 "title": "Removes tags from interaction",
22624 "title": "Example usage:",
22625 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22629 "name": "RemoveTags",
22630 "group": "Sms_Interactions",
22631 "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>",
22632 "version": "0.0.0",
22633 "filename": "server/api/smsInteraction/index.js",
22634 "groupTitle": "Sms_Interactions"
22638 "url": "/api/sms/interactions/{id}",
22639 "title": "Gets a single Interaction",
22642 "title": "Example usage:",
22643 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
22647 "name": "ShowInteractions",
22648 "group": "Sms_Interactions",
22649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22650 "version": "0.0.0",
22651 "filename": "server/api/smsInteraction/index.js",
22652 "groupTitle": "Sms_Interactions"
22656 "url": "/api/sms/interactions/{id}/messages",
22657 "title": "Creates new messages",
22660 "title": "Example usage:",
22661 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22665 "name": "addMessage",
22666 "group": "Sms_Interactions",
22692 "field": "direction",
22699 "field": "messageId",
22726 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22727 "version": "0.0.0",
22728 "filename": "server/api/smsInteraction/index.js",
22729 "groupTitle": "Sms_Interactions"
22733 "url": "/api/sms/interactions/{id}/download",
22734 "title": "Gets interaction",
22737 "title": "Example usage:",
22738 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
22742 "name": "download",
22743 "group": "Sms_Interactions",
22744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22745 "version": "0.0.0",
22746 "filename": "server/api/smsInteraction/index.js",
22747 "groupTitle": "Sms_Interactions"
22751 "url": "/api/sms/interactions/{id}/messages",
22752 "title": "Gets interaction messages",
22755 "title": "Example usage:",
22756 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
22760 "name": "getMessages",
22761 "group": "Sms_Interactions",
22762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22763 "version": "0.0.0",
22764 "filename": "server/api/smsInteraction/index.js",
22765 "groupTitle": "Sms_Interactions"
22769 "url": "/api/sms/interactions/{id}",
22770 "title": "Update an existing Interaction",
22773 "title": "Example usage:",
22774 "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",
22778 "name": "updateInteractions",
22779 "group": "Sms_Interactions",
22780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22781 "version": "0.0.0",
22782 "filename": "server/api/smsInteraction/index.js",
22783 "groupTitle": "Sms_Interactions"
22787 "url": "/api/sms/messages",
22788 "title": "Creates a new Message",
22791 "title": "Example usage:",
22792 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22796 "name": "CreateMessages",
22797 "group": "Sms_Messages",
22823 "field": "direction",
22830 "field": "messageId",
22857 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22858 "version": "0.0.0",
22859 "filename": "server/api/smsMessage/index.js",
22860 "groupTitle": "Sms_Messages"
22864 "url": "/api/sms/messages/{id}",
22865 "title": "Deletes a Message",
22868 "title": "Example usage:",
22869 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
22873 "name": "DeleteMessages",
22874 "group": "Sms_Messages",
22875 "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>",
22876 "version": "0.0.0",
22877 "filename": "server/api/smsMessage/index.js",
22878 "groupTitle": "Sms_Messages"
22882 "url": "/api/sms/messages/describe",
22883 "title": "Gets table info about Messages",
22886 "title": "Example usage:",
22887 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
22891 "name": "DescribeMessages",
22892 "group": "Sms_Messages",
22893 "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>",
22894 "version": "0.0.0",
22895 "filename": "server/api/smsMessage/index.js",
22896 "groupTitle": "Sms_Messages"
22900 "url": "/api/sms/messages",
22901 "title": "Gets a list of Messages",
22904 "title": "Example usage:",
22905 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
22909 "name": "GetMessages",
22910 "group": "Sms_Messages",
22911 "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>",
22912 "version": "0.0.0",
22913 "filename": "server/api/smsMessage/index.js",
22914 "groupTitle": "Sms_Messages"
22918 "url": "/api/sms/messages/{id}",
22919 "title": "Gets a single Message",
22922 "title": "Example usage:",
22923 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
22927 "name": "ShowMessages",
22928 "group": "Sms_Messages",
22929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22930 "version": "0.0.0",
22931 "filename": "server/api/smsMessage/index.js",
22932 "groupTitle": "Sms_Messages"
22936 "url": "/api/sms/messages/{id}",
22937 "title": "Update an existing Message",
22940 "title": "Example usage:",
22941 "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",
22945 "name": "updateMessages",
22946 "group": "Sms_Messages",
22947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22948 "version": "0.0.0",
22949 "filename": "server/api/smsMessage/index.js",
22950 "groupTitle": "Sms_Messages"
22954 "url": "/api/sms/reports/queue",
22955 "title": "Creates a new Sms Queue Report",
22958 "title": "Example usage:",
22959 "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",
22963 "name": "CreateSms_Queue_Reports",
22964 "group": "Sms_Queue_Reports",
22972 "field": "uniqueid",
22993 "field": "leaveAt",
23000 "field": "acceptAt",
23020 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23021 "version": "0.0.0",
23022 "filename": "server/api/smsQueueReport/index.js",
23023 "groupTitle": "Sms_Queue_Reports"
23027 "url": "/api/sms/reports/queue/{id}",
23028 "title": "Deletes a Sms Queue Report",
23031 "title": "Example usage:",
23032 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23036 "name": "DeleteSms_Queue_Reports",
23037 "group": "Sms_Queue_Reports",
23038 "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>",
23039 "version": "0.0.0",
23040 "filename": "server/api/smsQueueReport/index.js",
23041 "groupTitle": "Sms_Queue_Reports"
23045 "url": "/api/sms/reports/queue/describe",
23046 "title": "Gets table info about Sms Queue Reports",
23049 "title": "Example usage:",
23050 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23054 "name": "DescribeSms_Queue_Reports",
23055 "group": "Sms_Queue_Reports",
23056 "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>",
23057 "version": "0.0.0",
23058 "filename": "server/api/smsQueueReport/index.js",
23059 "groupTitle": "Sms_Queue_Reports"
23063 "url": "/api/sms/reports/queue",
23064 "title": "Gets a list of Sms Queue Reports",
23067 "title": "Example usage:",
23068 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23072 "name": "GetSms_Queue_Reports",
23073 "group": "Sms_Queue_Reports",
23074 "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>",
23075 "version": "0.0.0",
23076 "filename": "server/api/smsQueueReport/index.js",
23077 "groupTitle": "Sms_Queue_Reports"
23081 "url": "/api/sms/reports/queue/{id}",
23082 "title": "Gets a single Sms Queue Report",
23085 "title": "Example usage:",
23086 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23090 "name": "ShowSms_Queue_Reports",
23091 "group": "Sms_Queue_Reports",
23092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23093 "version": "0.0.0",
23094 "filename": "server/api/smsQueueReport/index.js",
23095 "groupTitle": "Sms_Queue_Reports"
23099 "url": "/api/sms/reports/queue/{id}",
23100 "title": "Update an existing Sms Queue Report",
23103 "title": "Example usage:",
23104 "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",
23108 "name": "updateSms_Queue_Reports",
23109 "group": "Sms_Queue_Reports",
23110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23111 "version": "0.0.0",
23112 "filename": "server/api/smsQueueReport/index.js",
23113 "groupTitle": "Sms_Queue_Reports"
23117 "url": "/api/sms/queues/{id}/users",
23118 "title": "Add agents to a queue",
23121 "title": "Example usage:",
23122 "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",
23126 "name": "AddAgents",
23127 "group": "Sms_Queues",
23128 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23129 "version": "0.0.0",
23130 "filename": "server/api/smsQueue/index.js",
23131 "groupTitle": "Sms_Queues"
23135 "url": "/api/sms/queues/{id}/teams",
23136 "title": "Add teams to a queue",
23139 "title": "Example usage:",
23140 "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",
23144 "name": "AddTeams",
23145 "group": "Sms_Queues",
23146 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23147 "version": "0.0.0",
23148 "filename": "server/api/smsQueue/index.js",
23149 "groupTitle": "Sms_Queues"
23153 "url": "/api/sms/queues",
23154 "title": "Creates a new Queue",
23157 "title": "Example usage:",
23158 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23162 "name": "CreateQueues",
23163 "group": "Sms_Queues",
23178 "field": "description",
23185 "field": "timeout",
23197 "field": "strategy",
23203 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23204 "version": "0.0.0",
23205 "filename": "server/api/smsQueue/index.js",
23206 "groupTitle": "Sms_Queues"
23210 "url": "/api/sms/queues/{id}",
23211 "title": "Deletes a Queue",
23214 "title": "Example usage:",
23215 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23219 "name": "DeleteQueues",
23220 "group": "Sms_Queues",
23221 "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>",
23222 "version": "0.0.0",
23223 "filename": "server/api/smsQueue/index.js",
23224 "groupTitle": "Sms_Queues"
23228 "url": "/api/sms/queues/describe",
23229 "title": "Gets table info about Queues",
23232 "title": "Example usage:",
23233 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23237 "name": "DescribeQueues",
23238 "group": "Sms_Queues",
23239 "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>",
23240 "version": "0.0.0",
23241 "filename": "server/api/smsQueue/index.js",
23242 "groupTitle": "Sms_Queues"
23246 "url": "/api/sms/queues/{id}/users",
23247 "title": "Gets queue agents",
23250 "title": "Example usage:",
23251 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23255 "name": "GetAgents",
23256 "group": "Sms_Queues",
23257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23258 "version": "0.0.0",
23259 "filename": "server/api/smsQueue/index.js",
23260 "groupTitle": "Sms_Queues"
23264 "url": "/api/sms/queues/{id}/members",
23265 "title": "GetMembers",
23268 "title": "Example usage:",
23269 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23273 "name": "GetMembers",
23274 "group": "Sms_Queues",
23275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23276 "version": "0.0.0",
23277 "filename": "server/api/smsQueue/index.js",
23278 "groupTitle": "Sms_Queues"
23282 "url": "/api/sms/queues",
23283 "title": "Gets a list of Queues",
23286 "title": "Example usage:",
23287 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23291 "name": "GetQueues",
23292 "group": "Sms_Queues",
23293 "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>",
23294 "version": "0.0.0",
23295 "filename": "server/api/smsQueue/index.js",
23296 "groupTitle": "Sms_Queues"
23300 "url": "/api/sms/queues/{id}/teams",
23301 "title": "Gets queues list",
23304 "title": "Example usage:",
23305 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23309 "name": "GetTeams",
23310 "group": "Sms_Queues",
23311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23312 "version": "0.0.0",
23313 "filename": "server/api/smsQueue/index.js",
23314 "groupTitle": "Sms_Queues"
23318 "url": "/api/sms/queues/{id}/users",
23319 "title": "Removes agents from a queue",
23322 "title": "Example usage:",
23323 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23327 "name": "RemoveAgents",
23328 "group": "Sms_Queues",
23329 "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>",
23330 "version": "0.0.0",
23331 "filename": "server/api/smsQueue/index.js",
23332 "groupTitle": "Sms_Queues"
23336 "url": "/api/sms/queues/{id}",
23337 "title": "Gets a single Queue",
23340 "title": "Example usage:",
23341 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23345 "name": "ShowQueues",
23346 "group": "Sms_Queues",
23347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23348 "version": "0.0.0",
23349 "filename": "server/api/smsQueue/index.js",
23350 "groupTitle": "Sms_Queues"
23354 "url": "/api/sms/queues/{id}",
23355 "title": "Update an existing Queue",
23358 "title": "Example usage:",
23359 "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",
23363 "name": "updateQueues",
23364 "group": "Sms_Queues",
23365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23366 "version": "0.0.0",
23367 "filename": "server/api/smsQueue/index.js",
23368 "groupTitle": "Sms_Queues"
23372 "url": "/api/sms/reports/transfer",
23373 "title": "Creates a new Sms Transfer Report",
23376 "title": "Example usage:",
23377 "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",
23381 "name": "CreateSms_Transfer_Reports",
23382 "group": "Sms_Transfer_Reports",
23390 "field": "uniqueid",
23409 "field": "transferredAt",
23415 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23416 "version": "0.0.0",
23417 "filename": "server/api/smsTransferReport/index.js",
23418 "groupTitle": "Sms_Transfer_Reports"
23422 "url": "/api/sms/reports/transfer/{id}",
23423 "title": "Deletes a Sms Transfer Report",
23426 "title": "Example usage:",
23427 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23431 "name": "DeleteSms_Transfer_Reports",
23432 "group": "Sms_Transfer_Reports",
23433 "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>",
23434 "version": "0.0.0",
23435 "filename": "server/api/smsTransferReport/index.js",
23436 "groupTitle": "Sms_Transfer_Reports"
23440 "url": "/api/sms/reports/transfer/describe",
23441 "title": "Gets table info about Sms Transfer Reports",
23444 "title": "Example usage:",
23445 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23449 "name": "DescribeSms_Transfer_Reports",
23450 "group": "Sms_Transfer_Reports",
23451 "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>",
23452 "version": "0.0.0",
23453 "filename": "server/api/smsTransferReport/index.js",
23454 "groupTitle": "Sms_Transfer_Reports"
23458 "url": "/api/sms/reports/transfer",
23459 "title": "Gets a list of Sms Transfer Reports",
23462 "title": "Example usage:",
23463 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23467 "name": "GetSms_Transfer_Reports",
23468 "group": "Sms_Transfer_Reports",
23469 "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>",
23470 "version": "0.0.0",
23471 "filename": "server/api/smsTransferReport/index.js",
23472 "groupTitle": "Sms_Transfer_Reports"
23476 "url": "/api/sms/reports/transfer/{id}",
23477 "title": "Gets a single Sms Transfer Report",
23480 "title": "Example usage:",
23481 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23485 "name": "ShowSms_Transfer_Reports",
23486 "group": "Sms_Transfer_Reports",
23487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23488 "version": "0.0.0",
23489 "filename": "server/api/smsTransferReport/index.js",
23490 "groupTitle": "Sms_Transfer_Reports"
23494 "url": "/api/sms/reports/transfer/{id}",
23495 "title": "Update an existing Sms Transfer Report",
23498 "title": "Example usage:",
23499 "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",
23503 "name": "updateSms_Transfer_Reports",
23504 "group": "Sms_Transfer_Reports",
23505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23506 "version": "0.0.0",
23507 "filename": "server/api/smsTransferReport/index.js",
23508 "groupTitle": "Sms_Transfer_Reports"
23512 "url": "/api/sounds",
23513 "title": "Gets a list of Sounds",
23516 "title": "Example usage:",
23517 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
23521 "name": "GetSounds",
23523 "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>",
23524 "version": "0.0.0",
23525 "filename": "server/api/sound/index.js",
23526 "groupTitle": "Sounds"
23530 "url": "/api/sounds/{id}",
23531 "title": "Gets a single Sound",
23534 "title": "Example usage:",
23535 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
23539 "name": "ShowSounds",
23541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23542 "version": "0.0.0",
23543 "filename": "server/api/sound/index.js",
23544 "groupTitle": "Sounds"
23548 "url": "/api/sounds",
23549 "title": "Create a new sound",
23552 "title": "Example usage:",
23553 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23557 "name": "addSound",
23559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23560 "version": "0.0.0",
23561 "filename": "server/api/sound/index.js",
23562 "groupTitle": "Sounds"
23566 "url": "/api/sounds/{id}",
23567 "title": "Deletes a sound",
23570 "title": "Example usage:",
23571 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
23575 "name": "destroySound",
23577 "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>",
23578 "version": "0.0.0",
23579 "filename": "server/api/sound/index.js",
23580 "groupTitle": "Sounds"
23584 "url": "/api/sounds/{id}/download",
23585 "title": "Download Sound",
23588 "title": "Example usage:",
23589 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
23593 "name": "download",
23595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23596 "version": "0.0.0",
23597 "filename": "server/api/sound/index.js",
23598 "groupTitle": "Sounds"
23602 "url": "/api/sounds",
23603 "title": "Update an existing new sound",
23606 "title": "Example usage:",
23607 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
23611 "name": "updateSound",
23613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23614 "version": "0.0.0",
23615 "filename": "server/api/sound/index.js",
23616 "groupTitle": "Sounds"
23620 "url": "/api/square/details/reports",
23621 "title": "Creates a new Square Detail Report",
23624 "title": "Example usage:",
23625 "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",
23629 "name": "CreateSquare_Detail_Reports",
23630 "group": "Square_Details_Reports",
23638 "field": "uniqueid",
23652 "field": "application",
23666 "field": "project_name",
23673 "field": "callerid",
23679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23680 "version": "0.0.0",
23681 "filename": "server/api/squareReportDetail/index.js",
23682 "groupTitle": "Square_Details_Reports"
23686 "url": "/api/square/details/reports/{id}",
23687 "title": "Deletes a Square Detail Report",
23690 "title": "Example usage:",
23691 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
23695 "name": "DeleteSquare_Detail_Reports",
23696 "group": "Square_Details_Reports",
23697 "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>",
23698 "version": "0.0.0",
23699 "filename": "server/api/squareReportDetail/index.js",
23700 "groupTitle": "Square_Details_Reports"
23704 "url": "/api/square/details/reports/describe",
23705 "title": "Gets table info about Square Detail Reports",
23708 "title": "Example usage:",
23709 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
23713 "name": "DescribeSquare_Detail_Reports",
23714 "group": "Square_Details_Reports",
23715 "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>",
23716 "version": "0.0.0",
23717 "filename": "server/api/squareReportDetail/index.js",
23718 "groupTitle": "Square_Details_Reports"
23722 "url": "/api/square/details/reports",
23723 "title": "Gets a list of Square Detail Reports",
23726 "title": "Example usage:",
23727 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
23731 "name": "GetSquare_Detail_Reports",
23732 "group": "Square_Details_Reports",
23733 "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>",
23734 "version": "0.0.0",
23735 "filename": "server/api/squareReportDetail/index.js",
23736 "groupTitle": "Square_Details_Reports"
23740 "url": "/api/square/details/reports/{id}",
23741 "title": "Gets a single Square Detail Report",
23744 "title": "Example usage:",
23745 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
23749 "name": "ShowSquare_Detail_Reports",
23750 "group": "Square_Details_Reports",
23751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23752 "version": "0.0.0",
23753 "filename": "server/api/squareReportDetail/index.js",
23754 "groupTitle": "Square_Details_Reports"
23758 "url": "/api/square/details/reports/{id}",
23759 "title": "Update an existing Square Detail Report",
23762 "title": "Example usage:",
23763 "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",
23767 "name": "updateSquare_Detail_Reports",
23768 "group": "Square_Details_Reports",
23769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23770 "version": "0.0.0",
23771 "filename": "server/api/squareReportDetail/index.js",
23772 "groupTitle": "Square_Details_Reports"
23776 "url": "/api/square/messages",
23777 "title": "Creates a new Message",
23780 "title": "Example usage:",
23781 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23785 "name": "CreateMessages",
23786 "group": "Square_Messages",
23794 "field": "uniqueid",
23812 "field": "direction",
23818 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23819 "version": "0.0.0",
23820 "filename": "server/api/squareMessage/index.js",
23821 "groupTitle": "Square_Messages"
23825 "url": "/api/square/messages/{id}",
23826 "title": "Deletes a Message",
23829 "title": "Example usage:",
23830 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
23834 "name": "DeleteMessages",
23835 "group": "Square_Messages",
23836 "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>",
23837 "version": "0.0.0",
23838 "filename": "server/api/squareMessage/index.js",
23839 "groupTitle": "Square_Messages"
23843 "url": "/api/square/messages",
23844 "title": "Gets a list of Messages",
23847 "title": "Example usage:",
23848 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
23852 "name": "GetMessages",
23853 "group": "Square_Messages",
23854 "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>",
23855 "version": "0.0.0",
23856 "filename": "server/api/squareMessage/index.js",
23857 "groupTitle": "Square_Messages"
23861 "url": "/api/square/messages/{id}",
23862 "title": "Gets a single Message",
23865 "title": "Example usage:",
23866 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
23870 "name": "ShowMessages",
23871 "group": "Square_Messages",
23872 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23873 "version": "0.0.0",
23874 "filename": "server/api/squareMessage/index.js",
23875 "groupTitle": "Square_Messages"
23879 "url": "/api/square/messages/{id}",
23880 "title": "Update an existing Message",
23883 "title": "Example usage:",
23884 "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",
23888 "name": "updateMessages",
23889 "group": "Square_Messages",
23890 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23891 "version": "0.0.0",
23892 "filename": "server/api/squareMessage/index.js",
23893 "groupTitle": "Square_Messages"
23897 "url": "/api/square/odbc",
23898 "title": "Creates a new ODBC",
23901 "title": "Example usage:",
23902 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23906 "name": "CreateODBCs",
23907 "group": "Square_ODBC",
23929 "field": "description",
23935 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23936 "version": "0.0.0",
23937 "filename": "server/api/squareOdbc/index.js",
23938 "groupTitle": "Square_ODBC"
23942 "url": "/api/square/odbc/{id}",
23943 "title": "Deletes a ODBC",
23946 "title": "Example usage:",
23947 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
23951 "name": "DeleteODBCs",
23952 "group": "Square_ODBC",
23953 "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>",
23954 "version": "0.0.0",
23955 "filename": "server/api/squareOdbc/index.js",
23956 "groupTitle": "Square_ODBC"
23960 "url": "/api/square/odbc",
23961 "title": "Gets a list of ODBCs",
23964 "title": "Example usage:",
23965 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
23969 "name": "GetODBCs",
23970 "group": "Square_ODBC",
23971 "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>",
23972 "version": "0.0.0",
23973 "filename": "server/api/squareOdbc/index.js",
23974 "groupTitle": "Square_ODBC"
23978 "url": "/api/square/odbc/{id}",
23979 "title": "Gets a single ODBC",
23982 "title": "Example usage:",
23983 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
23987 "name": "ShowODBCs",
23988 "group": "Square_ODBC",
23989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23990 "version": "0.0.0",
23991 "filename": "server/api/squareOdbc/index.js",
23992 "groupTitle": "Square_ODBC"
23996 "url": "/api/square/odbc/{id}/test",
23997 "title": "Test Odbc",
24000 "title": "Example usage:",
24001 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24006 "group": "Square_ODBC",
24007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24008 "version": "0.0.0",
24009 "filename": "server/api/squareOdbc/index.js",
24010 "groupTitle": "Square_ODBC"
24014 "url": "/api/square/odbc/{id}",
24015 "title": "Update an existing ODBC",
24018 "title": "Example usage:",
24019 "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",
24023 "name": "updateODBCs",
24024 "group": "Square_ODBC",
24025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24026 "version": "0.0.0",
24027 "filename": "server/api/squareOdbc/index.js",
24028 "groupTitle": "Square_ODBC"
24032 "url": "/api/square/projects",
24033 "title": "Creates a new Project",
24036 "title": "Example usage:",
24037 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24041 "name": "CreateProjects",
24042 "group": "Square_Projects",
24057 "field": "description",
24071 "field": "preproduction",
24078 "field": "production",
24084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24085 "version": "0.0.0",
24086 "filename": "server/api/squareProject/index.js",
24087 "groupTitle": "Square_Projects"
24091 "url": "/api/square/projects/{id}",
24092 "title": "Deletes a Project",
24095 "title": "Example usage:",
24096 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24100 "name": "DeleteProjects",
24101 "group": "Square_Projects",
24102 "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>",
24103 "version": "0.0.0",
24104 "filename": "server/api/squareProject/index.js",
24105 "groupTitle": "Square_Projects"
24109 "url": "/api/square/projects",
24110 "title": "Gets a list of Projects",
24113 "title": "Example usage:",
24114 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24118 "name": "GetProjects",
24119 "group": "Square_Projects",
24120 "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>",
24121 "version": "0.0.0",
24122 "filename": "server/api/squareProject/index.js",
24123 "groupTitle": "Square_Projects"
24127 "url": "/api/square/projects/{id}",
24128 "title": "Gets a single Project",
24131 "title": "Example usage:",
24132 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24136 "name": "ShowProjects",
24137 "group": "Square_Projects",
24138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24139 "version": "0.0.0",
24140 "filename": "server/api/squareProject/index.js",
24141 "groupTitle": "Square_Projects"
24145 "url": "/api/square/projects/{id}/users",
24146 "title": "Adds user permissions to a Project",
24149 "title": "Example usage:",
24150 "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",
24154 "name": "addUsers",
24155 "group": "Square_Projects",
24156 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24157 "version": "0.0.0",
24158 "filename": "server/api/squareProject/index.js",
24159 "groupTitle": "Square_Projects"
24163 "url": "/api/square/projects/{id}/users",
24164 "title": "Gets users permissions from Project",
24167 "title": "Example usage:",
24168 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24172 "name": "getUsers",
24173 "group": "Square_Projects",
24174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24175 "version": "0.0.0",
24176 "filename": "server/api/squareProject/index.js",
24177 "groupTitle": "Square_Projects"
24181 "url": "/api/square/projects/{id}/users",
24182 "title": "Removes user permissions from a Project",
24185 "title": "Example usage:",
24186 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24190 "name": "removeUsers",
24191 "group": "Square_Projects",
24192 "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>",
24193 "version": "0.0.0",
24194 "filename": "server/api/squareProject/index.js",
24195 "groupTitle": "Square_Projects"
24199 "url": "/api/square/projects/{id}",
24200 "title": "Update an existing Project",
24203 "title": "Example usage:",
24204 "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",
24208 "name": "updateProjects",
24209 "group": "Square_Projects",
24210 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24211 "version": "0.0.0",
24212 "filename": "server/api/squareProject/index.js",
24213 "groupTitle": "Square_Projects"
24217 "url": "/api/square/recordings",
24218 "title": "Creates a new Recording",
24221 "title": "Example usage:",
24222 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24226 "name": "CreateRecordings",
24227 "group": "Square_Recordings",
24235 "field": "uniqueid",
24242 "field": "callerid",
24249 "field": "calleridname",
24256 "field": "context",
24263 "field": "extension",
24270 "field": "priority",
24277 "field": "accountcode",
24291 "field": "projectName",
24298 "field": "saveName",
24305 "field": "filename",
24312 "field": "savePath",
24325 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24326 "version": "0.0.0",
24327 "filename": "server/api/squareRecording/index.js",
24328 "groupTitle": "Square_Recordings"
24332 "url": "/api/square/recordings",
24333 "title": "Gets a list of Recordings",
24336 "title": "Example usage:",
24337 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24341 "name": "GetRecordings",
24342 "group": "Square_Recordings",
24343 "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>",
24344 "version": "0.0.0",
24345 "filename": "server/api/squareRecording/index.js",
24346 "groupTitle": "Square_Recordings"
24350 "url": "/api/square/recordings/{id}",
24351 "title": "Gets a single Recording",
24354 "title": "Example usage:",
24355 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24359 "name": "ShowRecordings",
24360 "group": "Square_Recordings",
24361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24362 "version": "0.0.0",
24363 "filename": "server/api/squareRecording/index.js",
24364 "groupTitle": "Square_Recordings"
24368 "url": "/api/square/recordings/{id}/delete",
24369 "title": "Delete recording",
24372 "title": "Example usage:",
24373 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24378 "group": "Square_Recordings",
24379 "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>",
24380 "version": "0.0.0",
24381 "filename": "server/api/squareRecording/index.js",
24382 "groupTitle": "Square_Recordings"
24386 "url": "/api/square/recordings/{id}/download",
24387 "title": "Download Recording",
24390 "title": "Example usage:",
24391 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24395 "name": "download",
24396 "group": "Square_Recordings",
24397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24398 "version": "0.0.0",
24399 "filename": "server/api/squareRecording/index.js",
24400 "groupTitle": "Square_Recordings"
24404 "url": "/api/square/recordings/{id}",
24405 "title": "Update an existing Recording",
24408 "title": "Example usage:",
24409 "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",
24413 "name": "updateRecordings",
24414 "group": "Square_Recordings",
24415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24416 "version": "0.0.0",
24417 "filename": "server/api/squareRecording/index.js",
24418 "groupTitle": "Square_Recordings"
24422 "url": "/api/square/reports",
24423 "title": "Creates a new Square Report",
24426 "title": "Example usage:",
24427 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24431 "name": "CreateSquare_Reports",
24432 "group": "Square_Reports",
24440 "field": "network",
24447 "field": "network_script",
24454 "field": "request",
24461 "field": "channel",
24468 "field": "language",
24482 "field": "uniqueid",
24489 "field": "version",
24496 "field": "callerid",
24503 "field": "calleridname",
24510 "field": "callingpres",
24517 "field": "callingani2",
24524 "field": "callington",
24531 "field": "callingtns",
24552 "field": "context",
24559 "field": "extension",
24566 "field": "priority",
24573 "field": "enhanced",
24580 "field": "accountcode",
24587 "field": "threadid",
24594 "field": "project_name",
24608 "field": "leaveAt",
24621 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24622 "version": "0.0.0",
24623 "filename": "server/api/squareReport/index.js",
24624 "groupTitle": "Square_Reports"
24628 "url": "/api/square/reports/{id}",
24629 "title": "Deletes a Square Report",
24632 "title": "Example usage:",
24633 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
24637 "name": "DeleteSquare_Reports",
24638 "group": "Square_Reports",
24639 "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>",
24640 "version": "0.0.0",
24641 "filename": "server/api/squareReport/index.js",
24642 "groupTitle": "Square_Reports"
24646 "url": "/api/square/reports/describe",
24647 "title": "Gets table info about Square Reports",
24650 "title": "Example usage:",
24651 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
24655 "name": "DescribeSquare_Reports",
24656 "group": "Square_Reports",
24657 "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>",
24658 "version": "0.0.0",
24659 "filename": "server/api/squareReport/index.js",
24660 "groupTitle": "Square_Reports"
24664 "url": "/api/square/reports",
24665 "title": "Gets a list of Square Reports",
24668 "title": "Example usage:",
24669 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
24673 "name": "GetSquare_Reports",
24674 "group": "Square_Reports",
24675 "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>",
24676 "version": "0.0.0",
24677 "filename": "server/api/squareReport/index.js",
24678 "groupTitle": "Square_Reports"
24682 "url": "/api/square/reports/{id}",
24683 "title": "Gets a single Square Report",
24686 "title": "Example usage:",
24687 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
24691 "name": "ShowSquare_Reports",
24692 "group": "Square_Reports",
24693 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24694 "version": "0.0.0",
24695 "filename": "server/api/squareReport/index.js",
24696 "groupTitle": "Square_Reports"
24700 "url": "/api/square/reports/{id}",
24701 "title": "Update an existing Square Report",
24704 "title": "Example usage:",
24705 "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",
24709 "name": "updateSquare_Reports",
24710 "group": "Square_Reports",
24711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24712 "version": "0.0.0",
24713 "filename": "server/api/squareReport/index.js",
24714 "groupTitle": "Square_Reports"
24718 "url": "/api/integrations/sugarcrm/configurations",
24719 "title": "Creates a new SugarCRM Configuration",
24722 "title": "Example usage:",
24723 "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",
24727 "name": "CreateSugarCRM_Configurations",
24728 "group": "SugarCRM_Configurations",
24743 "field": "description",
24749 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24750 "version": "0.0.0",
24751 "filename": "server/api/intSugarcrmConfiguration/index.js",
24752 "groupTitle": "SugarCRM_Configurations"
24756 "url": "/api/integrations/sugarcrm/configurations/{id}",
24757 "title": "Deletes a SugarCRM Configuration",
24760 "title": "Example usage:",
24761 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
24765 "name": "DeleteSugarCRM_Configurations",
24766 "group": "SugarCRM_Configurations",
24767 "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>",
24768 "version": "0.0.0",
24769 "filename": "server/api/intSugarcrmConfiguration/index.js",
24770 "groupTitle": "SugarCRM_Configurations"
24774 "url": "/api/integrations/sugarcrm/configurations",
24775 "title": "Gets a list of SugarCRM Configurations",
24778 "title": "Example usage:",
24779 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
24783 "name": "GetSugarCRM_Configurations",
24784 "group": "SugarCRM_Configurations",
24785 "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>",
24786 "version": "0.0.0",
24787 "filename": "server/api/intSugarcrmConfiguration/index.js",
24788 "groupTitle": "SugarCRM_Configurations"
24792 "url": "/api/integrations/sugarcrm/configurations/{id}",
24793 "title": "Gets a single SugarCRM Configuration",
24796 "title": "Example usage:",
24797 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
24801 "name": "ShowSugarCRM_Configurations",
24802 "group": "SugarCRM_Configurations",
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": "server/api/intSugarcrmConfiguration/index.js",
24806 "groupTitle": "SugarCRM_Configurations"
24810 "url": "/api/integrations/sugarcrm/configurations/{id}",
24811 "title": "Update an existing SugarCRM Configuration",
24814 "title": "Example usage:",
24815 "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",
24819 "name": "updateSugarCRM_Configurations",
24820 "group": "SugarCRM_Configurations",
24821 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24822 "version": "0.0.0",
24823 "filename": "server/api/intSugarcrmConfiguration/index.js",
24824 "groupTitle": "SugarCRM_Configurations"
24828 "url": "/api/integrations/sugarcrm/accounts",
24829 "title": "Creates a new Sugarcrm Account",
24832 "title": "Example usage:",
24833 "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",
24837 "name": "CreateSugarcrm_Accounts",
24838 "group": "Sugarcrm_Accounts",
24853 "field": "description",
24860 "field": "username",
24867 "field": "password",
24874 "field": "remoteUri",
24881 "field": "serverUrl",
24887 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24888 "version": "0.0.0",
24889 "filename": "server/api/intSugarcrmAccount/index.js",
24890 "groupTitle": "Sugarcrm_Accounts"
24894 "url": "/api/integrations/sugarcrm/accounts/{id}",
24895 "title": "Deletes a Sugarcrm Account",
24898 "title": "Example usage:",
24899 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
24903 "name": "DeleteSugarcrm_Accounts",
24904 "group": "Sugarcrm_Accounts",
24905 "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>",
24906 "version": "0.0.0",
24907 "filename": "server/api/intSugarcrmAccount/index.js",
24908 "groupTitle": "Sugarcrm_Accounts"
24912 "url": "/api/integrations/sugarcrm/accounts",
24913 "title": "Gets a list of Sugarcrm Accounts",
24916 "title": "Example usage:",
24917 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
24921 "name": "GetSugarcrm_Accounts",
24922 "group": "Sugarcrm_Accounts",
24923 "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>",
24924 "version": "0.0.0",
24925 "filename": "server/api/intSugarcrmAccount/index.js",
24926 "groupTitle": "Sugarcrm_Accounts"
24930 "url": "/api/integrations/sugarcrm/accounts/{id}",
24931 "title": "Gets a single Sugarcrm Account",
24934 "title": "Example usage:",
24935 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
24939 "name": "ShowSugarcrm_Accounts",
24940 "group": "Sugarcrm_Accounts",
24941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24942 "version": "0.0.0",
24943 "filename": "server/api/intSugarcrmAccount/index.js",
24944 "groupTitle": "Sugarcrm_Accounts"
24948 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
24949 "title": "Creates new configuration",
24952 "title": "Example usage:",
24953 "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",
24957 "name": "addConfiguration",
24958 "group": "Sugarcrm_Accounts",
24959 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24960 "version": "0.0.0",
24961 "filename": "server/api/intSugarcrmAccount/index.js",
24962 "groupTitle": "Sugarcrm_Accounts"
24966 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
24967 "title": "Gets account configurations",
24970 "title": "Example usage:",
24971 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
24975 "name": "getConfigurations",
24976 "group": "Sugarcrm_Accounts",
24977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24978 "version": "0.0.0",
24979 "filename": "server/api/intSugarcrmAccount/index.js",
24980 "groupTitle": "Sugarcrm_Accounts"
24984 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
24985 "title": "Gets account fields",
24988 "title": "Example usage:",
24989 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
24993 "name": "getFields",
24994 "group": "Sugarcrm_Accounts",
24995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24996 "version": "0.0.0",
24997 "filename": "server/api/intSugarcrmAccount/index.js",
24998 "groupTitle": "Sugarcrm_Accounts"
25002 "url": "/api/integrations/sugarcrm/accounts/{id}",
25003 "title": "Update an existing Sugarcrm Account",
25006 "title": "Example usage:",
25007 "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",
25011 "name": "updateSugarcrm_Accounts",
25012 "group": "Sugarcrm_Accounts",
25013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25014 "version": "0.0.0",
25015 "filename": "server/api/intSugarcrmAccount/index.js",
25016 "groupTitle": "Sugarcrm_Accounts"
25020 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25021 "title": "Gets configurations descriptions",
25024 "title": "Example usage:",
25025 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25029 "name": "getDescriptions",
25030 "group": "Sugarcrm_Configurations",
25031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25032 "version": "0.0.0",
25033 "filename": "server/api/intSugarcrmConfiguration/index.js",
25034 "groupTitle": "Sugarcrm_Configurations"
25038 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25039 "title": "Gets configurations fields",
25042 "title": "Example usage:",
25043 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25047 "name": "getFields",
25048 "group": "Sugarcrm_Configurations",
25049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25050 "version": "0.0.0",
25051 "filename": "server/api/intSugarcrmConfiguration/index.js",
25052 "groupTitle": "Sugarcrm_Configurations"
25056 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25057 "title": "Gets configurations subjects",
25060 "title": "Example usage:",
25061 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25065 "name": "getSubjects",
25066 "group": "Sugarcrm_Configurations",
25067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25068 "version": "0.0.0",
25069 "filename": "server/api/intSugarcrmConfiguration/index.js",
25070 "groupTitle": "Sugarcrm_Configurations"
25074 "url": "/api/integrations/sugarcrm/fields",
25075 "title": "Creates a new Sugarcrm Field",
25078 "title": "Example usage:",
25079 "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",
25083 "name": "CreateSugarcrm_Fields",
25084 "group": "Sugarcrm_Fields",
25094 "\"customVariable\"",
25105 "field": "content",
25121 "\"customVariable\""
25124 "field": "keyType",
25131 "field": "keyContent",
25138 "field": "idField",
25145 "field": "nameField",
25152 "field": "customField",
25159 "field": "variableName",
25165 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25166 "version": "0.0.0",
25167 "filename": "server/api/intSugarcrmField/index.js",
25168 "groupTitle": "Sugarcrm_Fields"
25172 "url": "/api/integrations/sugarcrm/fields/{id}",
25173 "title": "Deletes a Sugarcrm Field",
25176 "title": "Example usage:",
25177 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25181 "name": "DeleteSugarcrm_Fields",
25182 "group": "Sugarcrm_Fields",
25183 "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>",
25184 "version": "0.0.0",
25185 "filename": "server/api/intSugarcrmField/index.js",
25186 "groupTitle": "Sugarcrm_Fields"
25190 "url": "/api/integrations/sugarcrm/fields",
25191 "title": "Gets a list of Sugarcrm Fields",
25194 "title": "Example usage:",
25195 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25199 "name": "GetSugarcrm_Fields",
25200 "group": "Sugarcrm_Fields",
25201 "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>",
25202 "version": "0.0.0",
25203 "filename": "server/api/intSugarcrmField/index.js",
25204 "groupTitle": "Sugarcrm_Fields"
25208 "url": "/api/integrations/sugarcrm/fields/{id}",
25209 "title": "Gets a single Sugarcrm Field",
25212 "title": "Example usage:",
25213 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25217 "name": "ShowSugarcrm_Fields",
25218 "group": "Sugarcrm_Fields",
25219 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25220 "version": "0.0.0",
25221 "filename": "server/api/intSugarcrmField/index.js",
25222 "groupTitle": "Sugarcrm_Fields"
25226 "url": "/api/integrations/sugarcrm/fields/{id}",
25227 "title": "Update an existing Sugarcrm Field",
25230 "title": "Example usage:",
25231 "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",
25235 "name": "updateSugarcrm_Fields",
25236 "group": "Sugarcrm_Fields",
25237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25238 "version": "0.0.0",
25239 "filename": "server/api/intSugarcrmField/index.js",
25240 "groupTitle": "Sugarcrm_Fields"
25244 "url": "/api/system",
25245 "title": "Gets system information",
25248 "title": "Example usage:",
25249 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25253 "name": "GetSystemInformation",
25254 "group": "System_Information",
25255 "description": "<p>Motion returns the system information.</p>",
25256 "version": "0.0.0",
25257 "filename": "server/api/system/index.js",
25258 "groupTitle": "System_Information"
25262 "url": "/api/system/process",
25263 "title": "Gets system information",
25266 "title": "Example usage:",
25267 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25271 "name": "GetSystemInformation",
25272 "group": "System_Information",
25273 "description": "<p>Motion returns the system information.</p>",
25274 "version": "0.0.0",
25275 "filename": "server/api/system/index.js",
25276 "groupTitle": "System_Information"
25280 "url": "/api/tags",
25281 "title": "Creates a new Tag",
25284 "title": "Example usage:",
25285 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25289 "name": "CreateTags",
25312 "field": "description",
25318 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25319 "version": "0.0.0",
25320 "filename": "server/api/tag/index.js",
25321 "groupTitle": "Tags"
25325 "url": "/api/tags/{id}",
25326 "title": "Deletes a Tag",
25329 "title": "Example usage:",
25330 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25334 "name": "DeleteTags",
25336 "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>",
25337 "version": "0.0.0",
25338 "filename": "server/api/tag/index.js",
25339 "groupTitle": "Tags"
25343 "url": "/api/tags",
25344 "title": "Gets a list of Tags",
25347 "title": "Example usage:",
25348 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25354 "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>",
25355 "version": "0.0.0",
25356 "filename": "server/api/tag/index.js",
25357 "groupTitle": "Tags"
25361 "url": "/api/tags/{id}",
25362 "title": "Gets a single Tag",
25365 "title": "Example usage:",
25366 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25370 "name": "ShowTags",
25372 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25373 "version": "0.0.0",
25374 "filename": "server/api/tag/index.js",
25375 "groupTitle": "Tags"
25379 "url": "/api/tags/{id}",
25380 "title": "Update an existing Tag",
25383 "title": "Example usage:",
25384 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25388 "name": "updateTags",
25390 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25391 "version": "0.0.0",
25392 "filename": "server/api/tag/index.js",
25393 "groupTitle": "Tags"
25397 "url": "/api/teams/{id}/queues",
25398 "title": "Add queues to a team",
25401 "title": "Example usage:",
25402 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25406 "name": "AddQueues",
25408 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25409 "version": "0.0.0",
25410 "filename": "server/api/team/index.js",
25411 "groupTitle": "Teams"
25415 "url": "/api/teams",
25416 "title": "Creates a new Team",
25419 "title": "Example usage:",
25420 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25424 "name": "CreateTeams",
25440 "field": "description",
25446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25447 "version": "0.0.0",
25448 "filename": "server/api/team/index.js",
25449 "groupTitle": "Teams"
25453 "url": "/api/teams/{id}",
25454 "title": "Deletes a Team",
25457 "title": "Example usage:",
25458 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25462 "name": "DeleteTeams",
25464 "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>",
25465 "version": "0.0.0",
25466 "filename": "server/api/team/index.js",
25467 "groupTitle": "Teams"
25471 "url": "/api/teams/{id}/users",
25472 "title": "Gets agents from team",
25475 "title": "Example usage:",
25476 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25480 "name": "GetAgents",
25482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25483 "version": "0.0.0",
25484 "filename": "server/api/team/index.js",
25485 "groupTitle": "Teams"
25489 "url": "/api/teams/{id}/queues?channel={channel}",
25490 "title": "Gets Queues list",
25493 "title": "Example usage:",
25494 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
25498 "name": "GetQueues",
25500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25501 "version": "0.0.0",
25502 "filename": "server/api/team/index.js",
25503 "groupTitle": "Teams"
25507 "url": "/api/teams",
25508 "title": "Gets a list of Teams",
25511 "title": "Example usage:",
25512 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
25516 "name": "GetTeams",
25518 "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>",
25519 "version": "0.0.0",
25520 "filename": "server/api/team/index.js",
25521 "groupTitle": "Teams"
25525 "url": "/api/teams/{id}/users",
25526 "title": "Removes agents from a team",
25529 "title": "Example usage:",
25530 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25534 "name": "RemoveAgents",
25536 "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>",
25537 "version": "0.0.0",
25538 "filename": "server/api/team/index.js",
25539 "groupTitle": "Teams"
25543 "url": "/api/teams/{id}/queues",
25544 "title": "Remove queues to a team",
25547 "title": "Example usage:",
25548 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25552 "name": "RemoveQueues",
25554 "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>",
25555 "version": "0.0.0",
25556 "filename": "server/api/team/index.js",
25557 "groupTitle": "Teams"
25561 "url": "/api/mail/queues/{id}/teams",
25562 "title": "Remove teams from a queue",
25565 "title": "Example usage:",
25566 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25570 "name": "RemoveTeams",
25572 "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>",
25573 "version": "0.0.0",
25574 "filename": "server/api/mailQueue/index.js",
25575 "groupTitle": "Teams"
25579 "url": "/api/openchannel/queues/{id}/teams",
25580 "title": "Remove teams from a queue",
25583 "title": "Example usage:",
25584 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25588 "name": "RemoveTeams",
25590 "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>",
25591 "version": "0.0.0",
25592 "filename": "server/api/openchannelQueue/index.js",
25593 "groupTitle": "Teams"
25597 "url": "/api/whatsapp/queues/{id}/teams",
25598 "title": "Remove teams from a queue",
25601 "title": "Example usage:",
25602 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25606 "name": "RemoveTeams",
25608 "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>",
25609 "version": "0.0.0",
25610 "filename": "server/api/whatsappQueue/index.js",
25611 "groupTitle": "Teams"
25615 "url": "/api/sms/queues/{id}/teams",
25616 "title": "Remove teams from a queue",
25619 "title": "Example usage:",
25620 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25624 "name": "RemoveTeams",
25626 "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>",
25627 "version": "0.0.0",
25628 "filename": "server/api/smsQueue/index.js",
25629 "groupTitle": "Teams"
25633 "url": "/api/voice/queues/{id}/teams",
25634 "title": "Remove teams from a queue",
25637 "title": "Example usage:",
25638 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25642 "name": "RemoveTeams",
25644 "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>",
25645 "version": "0.0.0",
25646 "filename": "server/api/voiceQueue/index.js",
25647 "groupTitle": "Teams"
25651 "url": "/api/chat/queues/{id}/teams",
25652 "title": "Remove teams from a queue",
25655 "title": "Example usage:",
25656 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25660 "name": "RemoveTeams",
25662 "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>",
25663 "version": "0.0.0",
25664 "filename": "server/api/chatQueue/index.js",
25665 "groupTitle": "Teams"
25669 "url": "/api/fax/queues/{id}/teams",
25670 "title": "Remove teams from a queue",
25673 "title": "Example usage:",
25674 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25678 "name": "RemoveTeams",
25680 "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>",
25681 "version": "0.0.0",
25682 "filename": "server/api/faxQueue/index.js",
25683 "groupTitle": "Teams"
25687 "url": "/api/teams/{id}",
25688 "title": "Gets a single Team",
25691 "title": "Example usage:",
25692 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
25696 "name": "ShowTeams",
25698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25699 "version": "0.0.0",
25700 "filename": "server/api/team/index.js",
25701 "groupTitle": "Teams"
25705 "url": "/api/teams/{id}/users",
25706 "title": "Adds agents to a team",
25709 "title": "Example usage:",
25710 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25714 "name": "addAgents",
25716 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25717 "version": "0.0.0",
25718 "filename": "server/api/team/index.js",
25719 "groupTitle": "Teams"
25723 "url": "/api/teams/{id}",
25724 "title": "Update an existing Team",
25727 "title": "Example usage:",
25728 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25732 "name": "updateTeams",
25734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25735 "version": "0.0.0",
25736 "filename": "server/api/team/index.js",
25737 "groupTitle": "Teams"
25741 "url": "/api/templates",
25742 "title": "Creates a new Template",
25745 "title": "Example usage:",
25746 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25750 "name": "CreateTemplates",
25751 "group": "Templates",
25766 "field": "description",
25779 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25780 "version": "0.0.0",
25781 "filename": "server/api/template/index.js",
25782 "groupTitle": "Templates"
25786 "url": "/api/templates/{id}",
25787 "title": "Deletes a Template",
25790 "title": "Example usage:",
25791 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
25795 "name": "DeleteTemplates",
25796 "group": "Templates",
25797 "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>",
25798 "version": "0.0.0",
25799 "filename": "server/api/template/index.js",
25800 "groupTitle": "Templates"
25804 "url": "/api/templates",
25805 "title": "Gets a list of Templates",
25808 "title": "Example usage:",
25809 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
25813 "name": "GetTemplates",
25814 "group": "Templates",
25815 "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>",
25816 "version": "0.0.0",
25817 "filename": "server/api/template/index.js",
25818 "groupTitle": "Templates"
25822 "url": "/api/templates/{id}",
25823 "title": "Gets a single Template",
25826 "title": "Example usage:",
25827 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
25831 "name": "ShowTemplates",
25832 "group": "Templates",
25833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25834 "version": "0.0.0",
25835 "filename": "server/api/template/index.js",
25836 "groupTitle": "Templates"
25840 "url": "/api/templates/{id}",
25841 "title": "Update an existing Template",
25844 "title": "Example usage:",
25845 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25849 "name": "updateTemplates",
25850 "group": "Templates",
25851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25852 "version": "0.0.0",
25853 "filename": "server/api/template/index.js",
25854 "groupTitle": "Templates"
25858 "url": "/api/triggers",
25859 "title": "Creates a new Trigger",
25862 "title": "Example usage:",
25863 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25867 "name": "CreateTriggers",
25868 "group": "Triggers",
25883 "field": "channel",
25890 "field": "description",
25903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25904 "version": "0.0.0",
25905 "filename": "server/api/trigger/index.js",
25906 "groupTitle": "Triggers"
25910 "url": "/api/triggers/{id}",
25911 "title": "Deletes a Trigger",
25914 "title": "Example usage:",
25915 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
25919 "name": "DeleteTriggers",
25920 "group": "Triggers",
25921 "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>",
25922 "version": "0.0.0",
25923 "filename": "server/api/trigger/index.js",
25924 "groupTitle": "Triggers"
25928 "url": "/api/triggers",
25929 "title": "Gets a list of Triggers",
25932 "title": "Example usage:",
25933 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
25937 "name": "GetTriggers",
25938 "group": "Triggers",
25939 "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>",
25940 "version": "0.0.0",
25941 "filename": "server/api/trigger/index.js",
25942 "groupTitle": "Triggers"
25946 "url": "/api/triggers/{id}",
25947 "title": "Gets a single Trigger",
25950 "title": "Example usage:",
25951 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
25955 "name": "ShowTriggers",
25956 "group": "Triggers",
25957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25958 "version": "0.0.0",
25959 "filename": "server/api/trigger/index.js",
25960 "groupTitle": "Triggers"
25964 "url": "/api/triggers/{id}/actions",
25965 "title": "Creates new actions",
25968 "title": "Example usage:",
25969 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25973 "name": "addAction",
25974 "group": "Triggers",
25990 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
25997 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26004 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26011 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26044 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26045 "version": "0.0.0",
26046 "filename": "server/api/trigger/index.js",
26047 "groupTitle": "Triggers"
26051 "url": "/api/triggers/{id}/all_conditions",
26052 "title": "Creates a new \"AND\"condition",
26055 "title": "Example usage:",
26056 "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",
26060 "name": "addAllCondition",
26061 "group": "Triggers",
26083 "field": "operator",
26096 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26097 "version": "0.0.0",
26098 "filename": "server/api/trigger/index.js",
26099 "groupTitle": "Triggers"
26103 "url": "/api/triggers/{id}/any_conditions",
26104 "title": "Creates a new \"OR\"condition",
26107 "title": "Example usage:",
26108 "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",
26112 "name": "addAnyCondition",
26113 "group": "Triggers",
26135 "field": "operator",
26148 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26149 "version": "0.0.0",
26150 "filename": "server/api/trigger/index.js",
26151 "groupTitle": "Triggers"
26155 "url": "/api/triggers/{id}/actions",
26156 "title": "Gets Trigger Actions",
26159 "title": "Example usage:",
26160 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26164 "name": "getActions",
26165 "group": "Triggers",
26166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26167 "version": "0.0.0",
26168 "filename": "server/api/trigger/index.js",
26169 "groupTitle": "Triggers"
26173 "url": "/api/triggers/{id}/all_conditions",
26174 "title": "Gets \"AND\" Trigger Conditions",
26177 "title": "Example usage:",
26178 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26182 "name": "getAllConditions",
26183 "group": "Triggers",
26184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26185 "version": "0.0.0",
26186 "filename": "server/api/trigger/index.js",
26187 "groupTitle": "Triggers"
26191 "url": "/api/triggers/{id}/any_conditions",
26192 "title": "Gets \"OR\" Trigger Conditions",
26195 "title": "Example usage:",
26196 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26200 "name": "getAnyConditions",
26201 "group": "Triggers",
26202 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26203 "version": "0.0.0",
26204 "filename": "server/api/trigger/index.js",
26205 "groupTitle": "Triggers"
26209 "url": "/api/triggers/{id}",
26210 "title": "Update an existing Trigger",
26213 "title": "Example usage:",
26214 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26218 "name": "updateTriggers",
26219 "group": "Triggers",
26220 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26221 "version": "0.0.0",
26222 "filename": "server/api/trigger/index.js",
26223 "groupTitle": "Triggers"
26227 "url": "/api/trunks/clone",
26228 "title": "Clone an existing Trunk",
26231 "title": "Example usage:",
26232 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26236 "name": "CloneTrunks",
26238 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26239 "version": "0.0.0",
26240 "filename": "server/api/trunk/index.js",
26241 "groupTitle": "Trunks"
26245 "url": "/api/trunks",
26246 "title": "Create a new trunk",
26249 "title": "Example usage:",
26250 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26282 "field": "context",
26289 "\"ALLOWED_NOT_SCREENED\"",
26290 "\"ALLOWED_PASSED_SCREEN\"",
26291 "\"ALLOWED_FAILED_SCREEN\"",
26293 "\"PROHIB_NOT_SCREENED\"",
26294 "\"PROHIB_PASSED_SCREEN\"",
26295 "\"PROHIB_FAILED_SCREEN\"",
26299 "field": "callingpres",
26327 "field": "md5secret",
26334 "field": "remotesecret",
26341 "field": "transport",
26342 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26355 "field": "dtmfmode",
26369 "field": "directmedia",
26380 "field": "directrtpsetup",
26387 "field": "directmediapermit",
26394 "field": "directmediadeny",
26402 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
26408 "field": "callgroup",
26415 "field": "namedcallgroup",
26422 "field": "pickupgroup",
26429 "field": "namedpickupgroup",
26436 "field": "language",
26443 "field": "tonezone",
26450 "field": "disallow",
26458 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
26468 "field": "autoframing",
26475 "field": "insecure",
26476 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
26486 "field": "trustrpid",
26497 "field": "trust_id_outbound",
26509 "field": "progressinband",
26520 "field": "promiscredir",
26531 "field": "useclientcode",
26538 "field": "accountcode",
26552 "field": "callerid",
26559 "field": "amaflags",
26570 "field": "callcounter",
26577 "field": "busylevel",
26588 "field": "allowoverlap",
26599 "field": "allowsubscribe",
26610 "field": "allowtransfer",
26621 "field": "ignoresdpversion",
26628 "field": "subscribecontext",
26635 "field": "template",
26647 "field": "videosupport",
26654 "field": "maxcallbitrate",
26665 "field": "rfc2833compensate",
26672 "field": "mailbox",
26684 "field": "session_timers",
26691 "field": "session_expires",
26698 "field": "session_minse",
26709 "field": "session_refresher",
26716 "field": "t38pt_usertpsource",
26723 "field": "regexten",
26730 "field": "fromdomain",
26737 "field": "fromuser",
26755 "field": "qualify",
26762 "field": "keepalive",
26769 "field": "defaultip",
26776 "field": "defaultuser",
26783 "field": "rtptimeout",
26790 "field": "rtpholdtimeout",
26797 "field": "rtpkeepalive",
26809 "field": "sendrpid",
26816 "field": "outboundproxy",
26823 "field": "callbackextension",
26830 "field": "timert1",
26844 "field": "qualifyfreq",
26851 "field": "contactpermit",
26858 "field": "contactdeny",
26865 "field": "contactacl",
26872 "field": "unsolicited_mailbox",
26879 "field": "use_q850_reason",
26886 "field": "maxforwards",
26897 "field": "encryption",
26919 "field": "force_avp",
26930 "field": "icesupport",
26941 "field": "dtlsenable",
26954 "field": "dtlsverify",
26961 "field": "dtlsrekey",
26968 "field": "dtlscertfile",
26975 "field": "dtlsprivatekey",
26982 "field": "dtlscipher",
26989 "field": "dtlscafile",
26996 "field": "dtlscapath",
27008 "field": "dtlssetup",
27015 "field": "dtlsfingerprint",
27026 "field": "usereqphone",
27033 "field": "recordonfeature",
27040 "field": "recordofffeature",
27047 "field": "call_limit",
27058 "field": "registertrying",
27069 "field": "subscribemwi",
27076 "field": "vmexten",
27083 "field": "mohinterpret",
27090 "field": "mohsuggest",
27097 "field": "parkinglot",
27104 "field": "description",
27125 "field": "canreinvite",
27132 "field": "registry",
27139 "field": "otherFields",
27153 "field": "t38pt_udptl",
27159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27160 "version": "0.0.0",
27161 "filename": "server/api/trunk/index.js",
27162 "groupTitle": "Trunks"
27166 "url": "/api/trunks/{id}",
27167 "title": "Deletes a trunk",
27170 "title": "Example usage:",
27171 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27177 "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>",
27178 "version": "0.0.0",
27179 "filename": "server/api/trunk/index.js",
27180 "groupTitle": "Trunks"
27184 "url": "/api/trunks",
27185 "title": "Gets a list of Trunks",
27188 "title": "Example usage:",
27189 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27193 "name": "GetTrunks",
27195 "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>",
27196 "version": "0.0.0",
27197 "filename": "server/api/trunk/index.js",
27198 "groupTitle": "Trunks"
27202 "url": "/api/trunks/{id}",
27203 "title": "Gets a single Trunk",
27206 "title": "Example usage:",
27207 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27211 "name": "ShowTrunks",
27213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "server/api/trunk/index.js",
27216 "groupTitle": "Trunks"
27220 "url": "/api/trunks/{id}",
27221 "title": "Update an existing trunk",
27224 "title": "Example usage:",
27225 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
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": "server/api/trunk/index.js",
27234 "groupTitle": "Trunks"
27238 "url": "/api/userProfile/resources",
27239 "title": "Creates a new User Profile Resource",
27242 "title": "Example usage:",
27243 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27247 "name": "CreateUser_Profile_Resources",
27248 "group": "User_Profile_Resources",
27263 "field": "resourceId",
27276 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27277 "version": "0.0.0",
27278 "filename": "server/api/userProfileResource/index.js",
27279 "groupTitle": "User_Profile_Resources"
27283 "url": "/api/userProfile/resources/{id}",
27284 "title": "Deletes a User Profile Resource",
27287 "title": "Example usage:",
27288 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27292 "name": "DeleteUser_Profile_Resources",
27293 "group": "User_Profile_Resources",
27294 "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>",
27295 "version": "0.0.0",
27296 "filename": "server/api/userProfileResource/index.js",
27297 "groupTitle": "User_Profile_Resources"
27301 "url": "/api/userProfile/resources/describe",
27302 "title": "Gets table info about User Profile Resources",
27305 "title": "Example usage:",
27306 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27310 "name": "DescribeUser_Profile_Resources",
27311 "group": "User_Profile_Resources",
27312 "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>",
27313 "version": "0.0.0",
27314 "filename": "server/api/userProfileResource/index.js",
27315 "groupTitle": "User_Profile_Resources"
27319 "url": "/api/userProfile/resources",
27320 "title": "Gets a list of User Profile Resources",
27323 "title": "Example usage:",
27324 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27328 "name": "GetUser_Profile_Resources",
27329 "group": "User_Profile_Resources",
27330 "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>",
27331 "version": "0.0.0",
27332 "filename": "server/api/userProfileResource/index.js",
27333 "groupTitle": "User_Profile_Resources"
27337 "url": "/api/userProfile/resources/{id}",
27338 "title": "Gets a single User Profile Resource",
27341 "title": "Example usage:",
27342 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27346 "name": "ShowUser_Profile_Resources",
27347 "group": "User_Profile_Resources",
27348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27349 "version": "0.0.0",
27350 "filename": "server/api/userProfileResource/index.js",
27351 "groupTitle": "User_Profile_Resources"
27355 "url": "/api/userProfile/resources/{id}",
27356 "title": "Update an existing User Profile Resource",
27359 "title": "Example usage:",
27360 "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",
27364 "name": "updateUser_Profile_Resources",
27365 "group": "User_Profile_Resources",
27366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27367 "version": "0.0.0",
27368 "filename": "server/api/userProfileResource/index.js",
27369 "groupTitle": "User_Profile_Resources"
27373 "url": "/api/userProfile/sections",
27374 "title": "Creates a new User Profile Section",
27377 "title": "Example usage:",
27378 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27382 "name": "CreateUser_Profile_Sections",
27383 "group": "User_Profile_Sections",
27398 "field": "category",
27405 "field": "sectionId",
27412 "field": "enabled",
27419 "field": "autoAssociation",
27426 "field": "crudPermissions",
27432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27433 "version": "0.0.0",
27434 "filename": "server/api/userProfileSection/index.js",
27435 "groupTitle": "User_Profile_Sections"
27439 "url": "/api/userProfile/sections/{id}",
27440 "title": "Deletes a User Profile Section",
27443 "title": "Example usage:",
27444 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27448 "name": "DeleteUser_Profile_Sections",
27449 "group": "User_Profile_Sections",
27450 "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>",
27451 "version": "0.0.0",
27452 "filename": "server/api/userProfileSection/index.js",
27453 "groupTitle": "User_Profile_Sections"
27457 "url": "/api/userProfile/sections/describe",
27458 "title": "Gets table info about User Profile Sections",
27461 "title": "Example usage:",
27462 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27466 "name": "DescribeUser_Profile_Sections",
27467 "group": "User_Profile_Sections",
27468 "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>",
27469 "version": "0.0.0",
27470 "filename": "server/api/userProfileSection/index.js",
27471 "groupTitle": "User_Profile_Sections"
27475 "url": "/api/userProfile/sections",
27476 "title": "Gets a list of User Profile Sections",
27479 "title": "Example usage:",
27480 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
27484 "name": "GetUser_Profile_Sections",
27485 "group": "User_Profile_Sections",
27486 "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>",
27487 "version": "0.0.0",
27488 "filename": "server/api/userProfileSection/index.js",
27489 "groupTitle": "User_Profile_Sections"
27493 "url": "/api/userProfile/sections/{id}",
27494 "title": "Gets a single User Profile Section",
27497 "title": "Example usage:",
27498 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
27502 "name": "ShowUser_Profile_Sections",
27503 "group": "User_Profile_Sections",
27504 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27505 "version": "0.0.0",
27506 "filename": "server/api/userProfileSection/index.js",
27507 "groupTitle": "User_Profile_Sections"
27511 "url": "/api/userProfile/sections/{id}",
27512 "title": "Update an existing User Profile Section",
27515 "title": "Example usage:",
27516 "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",
27520 "name": "updateUser_Profile_Sections",
27521 "group": "User_Profile_Sections",
27522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27523 "version": "0.0.0",
27524 "filename": "server/api/userProfileSection/index.js",
27525 "groupTitle": "User_Profile_Sections"
27529 "url": "/api/userProfiles/{id}/resources",
27530 "title": "Add resources' permissions to User Profile",
27533 "title": "Example usage:",
27534 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27538 "name": "AddResources",
27539 "group": "User_Profiles",
27540 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27541 "version": "0.0.0",
27542 "filename": "server/api/userProfile/index.js",
27543 "groupTitle": "User_Profiles"
27547 "url": "/api/userProfiles/{id}/sections",
27548 "title": "Add sections' permissions to User Profile",
27551 "title": "Example usage:",
27552 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27556 "name": "AddSections",
27557 "group": "User_Profiles",
27558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27559 "version": "0.0.0",
27560 "filename": "server/api/userProfile/index.js",
27561 "groupTitle": "User_Profiles"
27565 "url": "/api/userProfiles/clone",
27566 "title": "Clone an existing User Profile",
27569 "title": "Example usage:",
27570 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27574 "name": "CloneUser_Profiles",
27575 "group": "User_Profiles",
27576 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27577 "version": "0.0.0",
27578 "filename": "server/api/userProfile/index.js",
27579 "groupTitle": "User_Profiles"
27583 "url": "/api/userProfiles",
27584 "title": "Creates a new User Profile",
27587 "title": "Example usage:",
27588 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27592 "name": "CreateUser_Profiles",
27593 "group": "User_Profiles",
27608 "field": "crudPermissions",
27615 "field": "description",
27621 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27622 "version": "0.0.0",
27623 "filename": "server/api/userProfile/index.js",
27624 "groupTitle": "User_Profiles"
27628 "url": "/api/userProfiles/{id}",
27629 "title": "Deletes a User Profile",
27632 "title": "Example usage:",
27633 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
27637 "name": "DeleteUser_Profiles",
27638 "group": "User_Profiles",
27639 "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>",
27640 "version": "0.0.0",
27641 "filename": "server/api/userProfile/index.js",
27642 "groupTitle": "User_Profiles"
27646 "url": "/api/userProfiles/describe",
27647 "title": "Gets table info about User Profiles",
27650 "title": "Example usage:",
27651 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
27655 "name": "DescribeUser_Profiles",
27656 "group": "User_Profiles",
27657 "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>",
27658 "version": "0.0.0",
27659 "filename": "server/api/userProfile/index.js",
27660 "groupTitle": "User_Profiles"
27664 "url": "/api/userProfiles/{id}/resources?section={section}",
27665 "title": "Get Resources assigned to a Section",
27668 "title": "Example usage:",
27669 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
27673 "name": "GetResources",
27674 "group": "User_Profiles",
27675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27676 "version": "0.0.0",
27677 "filename": "server/api/userProfile/index.js",
27678 "groupTitle": "User_Profiles"
27682 "url": "/api/userProfiles/{id}/sections",
27683 "title": "Get sections associated to a User Profile",
27686 "title": "Example usage:",
27687 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
27691 "name": "GetSections",
27692 "group": "User_Profiles",
27693 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27694 "version": "0.0.0",
27695 "filename": "server/api/userProfile/index.js",
27696 "groupTitle": "User_Profiles"
27700 "url": "/api/userProfiles",
27701 "title": "Gets a list of User Profiles",
27704 "title": "Example usage:",
27705 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
27709 "name": "GetUser_Profiles",
27710 "group": "User_Profiles",
27711 "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>",
27712 "version": "0.0.0",
27713 "filename": "server/api/userProfile/index.js",
27714 "groupTitle": "User_Profiles"
27718 "url": "/api/userProfiles/{id}/resources",
27719 "title": "Removes resources' permissions from User Profile",
27722 "title": "Example usage:",
27723 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27727 "name": "RemoveResources",
27728 "group": "User_Profiles",
27729 "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>",
27730 "version": "0.0.0",
27731 "filename": "server/api/userProfile/index.js",
27732 "groupTitle": "User_Profiles"
27736 "url": "/api/userProfiles/{id}/sections",
27737 "title": "Removes sections' permissions from User Profile",
27740 "title": "Example usage:",
27741 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27745 "name": "RemoveSections",
27746 "group": "User_Profiles",
27747 "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>",
27748 "version": "0.0.0",
27749 "filename": "server/api/userProfile/index.js",
27750 "groupTitle": "User_Profiles"
27754 "url": "/api/userProfiles/{id}",
27755 "title": "Gets a single User Profile",
27758 "title": "Example usage:",
27759 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
27763 "name": "ShowUser_Profiles",
27764 "group": "User_Profiles",
27765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27766 "version": "0.0.0",
27767 "filename": "server/api/userProfile/index.js",
27768 "groupTitle": "User_Profiles"
27772 "url": "/api/userProfiles/{id}",
27773 "title": "Update an existing User Profile",
27776 "title": "Example usage:",
27777 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27781 "name": "updateUser_Profiles",
27782 "group": "User_Profiles",
27783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27784 "version": "0.0.0",
27785 "filename": "server/api/userProfile/index.js",
27786 "groupTitle": "User_Profiles"
27790 "url": "/api/users/{id}/chat_interactions",
27791 "title": "Add chat interaction tabs to an agent",
27794 "title": "Example usage:",
27795 "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",
27799 "name": "AddChatInteractions",
27801 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27802 "version": "0.0.0",
27803 "filename": "server/api/user/index.js",
27804 "groupTitle": "Users"
27808 "url": "/api/users/{id}/chat_websites",
27809 "title": "Add a Chat Website to a user",
27812 "title": "Example usage:",
27813 "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",
27817 "name": "AddChatWebsites",
27819 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27820 "version": "0.0.0",
27821 "filename": "server/api/user/index.js",
27822 "groupTitle": "Users"
27826 "url": "/api/users/{id}/contacts",
27827 "title": "Add contacts to a user",
27830 "title": "Example usage:",
27831 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27835 "name": "AddContacts",
27837 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27838 "version": "0.0.0",
27839 "filename": "server/api/user/index.js",
27840 "groupTitle": "Users"
27844 "url": "/api/users/{id}/fax_accounts",
27845 "title": "Add a Fax Account to a user",
27848 "title": "Example usage:",
27849 "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",
27853 "name": "AddFaxAccounts",
27855 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27856 "version": "0.0.0",
27857 "filename": "server/api/user/index.js",
27858 "groupTitle": "Users"
27862 "url": "/api/users/{id}/fax_interactions",
27863 "title": "Add fax interaction tabs to an agent",
27866 "title": "Example usage:",
27867 "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",
27871 "name": "AddFaxInteractions",
27873 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27874 "version": "0.0.0",
27875 "filename": "server/api/user/index.js",
27876 "groupTitle": "Users"
27880 "url": "/api/users/{id}/mail_accounts",
27881 "title": "Add a Mail Account to a user",
27884 "title": "Example usage:",
27885 "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",
27889 "name": "AddMailAccounts",
27891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27892 "version": "0.0.0",
27893 "filename": "server/api/user/index.js",
27894 "groupTitle": "Users"
27898 "url": "/api/users/{id}/mail_interactions",
27899 "title": "Add mail interaction tabs to an agent",
27902 "title": "Example usage:",
27903 "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",
27907 "name": "AddMailInteractions",
27909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27910 "version": "0.0.0",
27911 "filename": "server/api/user/index.js",
27912 "groupTitle": "Users"
27916 "url": "/api/users/{id}/openchannel_accounts",
27917 "title": "Add a Open Channel Account to a user",
27920 "title": "Example usage:",
27921 "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",
27925 "name": "AddOpenchannelAccounts",
27927 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27928 "version": "0.0.0",
27929 "filename": "server/api/user/index.js",
27930 "groupTitle": "Users"
27934 "url": "/api/users/{id}/openchannel_interactions",
27935 "title": "Add openchannel interaction tabs to an agent",
27938 "title": "Example usage:",
27939 "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",
27943 "name": "AddOpenchannelInteractions",
27945 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27946 "version": "0.0.0",
27947 "filename": "server/api/user/index.js",
27948 "groupTitle": "Users"
27952 "url": "/api/users/{id}/queues",
27953 "title": "Add queues to an agent",
27956 "title": "Example usage:",
27957 "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",
27961 "name": "AddQueues",
27963 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27964 "version": "0.0.0",
27965 "filename": "server/api/user/index.js",
27966 "groupTitle": "Users"
27970 "url": "/api/users/{id}/sms_accounts",
27971 "title": "Add a Sms Account to a user",
27974 "title": "Example usage:",
27975 "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",
27979 "name": "AddSmsAccounts",
27981 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27982 "version": "0.0.0",
27983 "filename": "server/api/user/index.js",
27984 "groupTitle": "Users"
27988 "url": "/api/users/{id}/sms_interactions",
27989 "title": "Add sms interaction tabs to an agent",
27992 "title": "Example usage:",
27993 "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",
27997 "name": "AddSmsInteractions",
27999 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28000 "version": "0.0.0",
28001 "filename": "server/api/user/index.js",
28002 "groupTitle": "Users"
28006 "url": "/api/users/{id}/square_projects",
28007 "title": "Add a Square Project to a user",
28010 "title": "Example usage:",
28011 "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",
28015 "name": "AddSquareProjects",
28017 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28018 "version": "0.0.0",
28019 "filename": "server/api/user/index.js",
28020 "groupTitle": "Users"
28024 "url": "/api/users/{id}/teams",
28025 "title": "Add teams to an agent",
28028 "title": "Example usage:",
28029 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28033 "name": "AddTeams",
28035 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28036 "version": "0.0.0",
28037 "filename": "server/api/user/index.js",
28038 "groupTitle": "Users"
28042 "url": "/api/users/{id}/whatsapp_accounts",
28043 "title": "Add a Whatsapp Account to a user",
28046 "title": "Example usage:",
28047 "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",
28051 "name": "AddWhatsappAccounts",
28053 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28054 "version": "0.0.0",
28055 "filename": "server/api/user/index.js",
28056 "groupTitle": "Users"
28060 "url": "/api/users/{id}/whatsapp_interactions",
28061 "title": "Add Whatsapp interaction tabs to an agent",
28064 "title": "Example usage:",
28065 "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",
28069 "name": "AddWhatsappInteractions",
28071 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28072 "version": "0.0.0",
28073 "filename": "server/api/user/index.js",
28074 "groupTitle": "Users"
28078 "url": "/api/users/create_many",
28079 "title": "Creates many Users",
28082 "title": "Example usage:",
28083 "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28087 "name": "BulkCreateUsers",
28097 "description": "<p>The name of the user</p>"
28103 "field": "fullname",
28137 "field": "password",
28144 "field": "provider",
28151 "field": "internal",
28179 "field": "address",
28186 "field": "zipcode",
28193 "field": "userpic",
28207 "field": "country",
28221 "field": "lastLoginAt",
28228 "field": "voicePause",
28235 "field": "chatPause",
28242 "field": "mailPause",
28249 "field": "faxPause",
28256 "field": "smsPause",
28263 "field": "whatsappPause",
28270 "field": "openchannelPause",
28277 "field": "pauseType",
28284 "field": "lastPauseAt",
28291 "field": "chatCapacity",
28298 "field": "mailCapacity",
28305 "field": "faxCapacity",
28312 "field": "smsCapacity",
28319 "field": "whatsappCapacity",
28326 "field": "openchannelCapacity",
28333 "field": "phoneBarAutoAnswer",
28340 "field": "phoneBarEnableSettings",
28347 "field": "phoneBarListenPort",
28354 "field": "phoneBarExpires",
28361 "field": "phoneBarRemoteControl",
28368 "field": "phoneBarRemoteControlPort",
28375 "field": "phoneBarEnableRecording",
28382 "field": "phoneBarRingInUse",
28389 "field": "chanspy",
28396 "field": "description",
28424 "field": "regseconds",
28431 "field": "fullcontact",
28438 "field": "regserver",
28445 "field": "useragent",
28471 "field": "context",
28478 "\"ALLOWED_NOT_SCREENED\"",
28479 "\"ALLOWED_PASSED_SCREEN\"",
28480 "\"ALLOWED_FAILED_SCREEN\"",
28482 "\"PROHIB_NOT_SCREENED\"",
28483 "\"PROHIB_PASSED_SCREEN\"",
28484 "\"PROHIB_FAILED_SCREEN\"",
28488 "field": "callingpres",
28516 "field": "md5secret",
28523 "field": "remotesecret",
28530 "field": "transport",
28531 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
28544 "field": "dtmfmode",
28558 "field": "directmedia",
28569 "field": "directrtpsetup",
28576 "field": "directmediapermit",
28583 "field": "directmediadeny",
28591 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
28597 "field": "callgroup",
28604 "field": "namedcallgroup",
28611 "field": "pickupgroup",
28618 "field": "namedpickupgroup",
28625 "field": "language",
28632 "field": "tonezone",
28639 "field": "disallow",
28647 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "gsm"]</p>"
28657 "field": "autoframing",
28664 "field": "insecure",
28665 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
28675 "field": "trustrpid",
28686 "field": "trust_id_outbound",
28698 "field": "progressinband",
28709 "field": "promiscredir",
28720 "field": "useclientcode",
28727 "field": "accountcode",
28741 "field": "callerid",
28748 "field": "amaflags",
28759 "field": "callcounter",
28766 "field": "busylevel",
28777 "field": "allowoverlap",
28788 "field": "allowsubscribe",
28799 "field": "allowtransfer",
28810 "field": "ignoresdpversion",
28817 "field": "subscribecontext",
28824 "field": "template",
28836 "field": "videosupport",
28843 "field": "maxcallbitrate",
28854 "field": "rfc2833compensate",
28861 "field": "mailbox",
28873 "field": "session_timers",
28880 "field": "session_expires",
28887 "field": "session_minse",
28898 "field": "session_refresher",
28905 "field": "t38pt_usertpsource",
28912 "field": "regexten",
28919 "field": "fromdomain",
28926 "field": "fromuser",
28937 "field": "qualify",
28944 "field": "keepalive",
28951 "field": "defaultip",
28958 "field": "defaultuser",
28965 "field": "rtptimeout",
28972 "field": "rtpholdtimeout",
28979 "field": "rtpkeepalive",
28990 "field": "sendrpid",
28997 "field": "outboundproxy",
29004 "field": "callbackextension",
29011 "field": "timert1",
29025 "field": "qualifyfreq",
29032 "field": "contactpermit",
29039 "field": "contactdeny",
29046 "field": "contactacl",
29053 "field": "unsolicited_mailbox",
29060 "field": "use_q850_reason",
29067 "field": "maxforwards",
29078 "field": "encryption",
29100 "field": "force_avp",
29111 "field": "icesupport",
29122 "field": "dtlsenable",
29135 "field": "dtlsverify",
29142 "field": "dtlsrekey",
29149 "field": "dtlscertfile",
29156 "field": "dtlsprivatekey",
29163 "field": "dtlscipher",
29170 "field": "dtlscafile",
29177 "field": "dtlscapath",
29189 "field": "dtlssetup",
29196 "field": "dtlsfingerprint",
29207 "field": "usereqphone",
29214 "field": "recordonfeature",
29221 "field": "recordofffeature",
29228 "field": "call_limit",
29239 "field": "registertrying",
29250 "field": "subscribemwi",
29257 "field": "vmexten",
29264 "field": "mohinterpret",
29271 "field": "mohsuggest",
29278 "field": "parkinglot",
29292 "field": "canreinvite",
29299 "field": "loginInPause",
29306 "field": "resetPasswordToken",
29313 "field": "resetPasswordExpires",
29320 "field": "showWebBar",
29327 "field": "permissions",
29334 "field": "phoneBarUnconditionalNumber",
29341 "field": "phoneBarNoReplyNumber",
29348 "field": "phoneBarBusyNumber",
29355 "field": "phoneBarUnconditional",
29362 "field": "phoneBarNoReply",
29369 "field": "phoneBarBusy",
29376 "field": "phoneBarDnd",
29383 "field": "phoneBarUnansweredCallBadge",
29390 "field": "phoneBarEnableDtmfTone",
29397 "field": "phoneBarAutoAnswerDelay",
29404 "field": "extensionMonitor",
29411 "field": "crudPermissions",
29422 "field": "rtcp_mux",
29429 "field": "allowmessenger",
29436 "field": "phoneBarOutboundProxy",
29443 "field": "passwordResetAt",
29450 "field": "phoneBarEnableJaws",
29457 "field": "phoneBarEnableScreenRecordingByAgent",
29464 "field": "phoneBarEnableVideoRecording",
29471 "field": "phoneBarEnableAutomaticScreenRecording",
29478 "field": "phoneBarPrefixRequired",
29485 "field": "hotdesk",
29492 "field": "interface",
29499 "field": "privacyEnabled",
29506 "field": "apiKeyNonce",
29513 "field": "apiKeyIat",
29520 "field": "screenrecording",
29527 "field": "blocked",
29534 "field": "blockedAt",
29541 "field": "loginAttempts",
29548 "field": "disabled",
29554 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29555 "version": "0.0.0",
29556 "filename": "server/api/user/index.js",
29557 "groupTitle": "Users"
29561 "url": "/api/users/{id}/password",
29562 "title": "Change user password",
29565 "title": "Example usage:",
29566 "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",
29570 "name": "ChangePwd",
29572 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29573 "version": "0.0.0",
29574 "filename": "server/api/user/index.js",
29575 "groupTitle": "Users"
29579 "url": "/api/users",
29580 "title": "Create a new user",
29583 "title": "Example usage:",
29584 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29591 "version": "0.0.0",
29592 "filename": "server/api/user/index.js",
29593 "groupTitle": "Users"
29597 "url": "/api/users/{id}/api_key",
29598 "title": "Create a new API access key for the user",
29601 "title": "Example usage:",
29602 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29606 "name": "CreateApiKey",
29608 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29609 "version": "0.0.0",
29610 "filename": "server/api/user/index.js",
29611 "groupTitle": "Users"
29615 "url": "/api/users/{id}",
29616 "title": "Deletes a user",
29619 "title": "Example usage:",
29620 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29626 "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>",
29627 "version": "0.0.0",
29628 "filename": "server/api/user/index.js",
29629 "groupTitle": "Users"
29633 "url": "/api/users/describe",
29634 "title": "Gets table info about Users",
29637 "title": "Example usage:",
29638 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29642 "name": "DescribeUsers",
29644 "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>",
29645 "version": "0.0.0",
29646 "filename": "server/api/user/index.js",
29647 "groupTitle": "Users"
29651 "url": "/api/users/{id}/agents",
29652 "title": "GetAgents",
29655 "title": "Example usage:",
29656 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29660 "name": "GetAgents",
29662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29663 "version": "0.0.0",
29664 "filename": "server/api/user/index.js",
29665 "groupTitle": "Users"
29669 "url": "/api/users/{id}/api_key",
29670 "title": "Get the API access key for the user",
29673 "title": "Example usage:",
29674 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29678 "name": "GetApiKey",
29680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29681 "version": "0.0.0",
29682 "filename": "server/api/user/index.js",
29683 "groupTitle": "Users"
29687 "url": "/api/users/{id}/groups",
29688 "title": "GetChatGroups",
29691 "title": "Example usage:",
29692 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29696 "name": "GetChatGroups",
29698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29699 "version": "0.0.0",
29700 "filename": "server/api/user/index.js",
29701 "groupTitle": "Users"
29705 "url": "/api/users/{id}/chat/interactions",
29706 "title": "GetChatInteractions",
29709 "title": "Example usage:",
29710 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29714 "name": "GetChatInteractions",
29716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29717 "version": "0.0.0",
29718 "filename": "server/api/user/index.js",
29719 "groupTitle": "Users"
29723 "url": "/api/users/{id}/chat_websites",
29724 "title": "GetChatWebsites",
29727 "title": "Example usage:",
29728 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29732 "name": "GetChatWebsites",
29734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29735 "version": "0.0.0",
29736 "filename": "server/api/user/index.js",
29737 "groupTitle": "Users"
29741 "url": "/api/users/{id}/contacts",
29742 "title": "GetContacts",
29745 "title": "Example usage:",
29746 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29750 "name": "GetContacts",
29752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29753 "version": "0.0.0",
29754 "filename": "server/api/user/index.js",
29755 "groupTitle": "Users"
29759 "url": "/api/users/{id}/fax_accounts",
29760 "title": "GetFaxAccounts",
29763 "title": "Example usage:",
29764 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29768 "name": "GetFaxAccounts",
29770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29771 "version": "0.0.0",
29772 "filename": "server/api/user/index.js",
29773 "groupTitle": "Users"
29777 "url": "/api/users/{id}/fax/interactions",
29778 "title": "GetFaxInteractions",
29781 "title": "Example usage:",
29782 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29786 "name": "GetFaxInteractions",
29788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29789 "version": "0.0.0",
29790 "filename": "server/api/user/index.js",
29791 "groupTitle": "Users"
29795 "url": "/api/users/{id}/lists",
29796 "title": "GetLists",
29799 "title": "Example usage:",
29800 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29804 "name": "GetLists",
29806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29807 "version": "0.0.0",
29808 "filename": "server/api/user/index.js",
29809 "groupTitle": "Users"
29813 "url": "/api/users/{id}/mail_accounts",
29814 "title": "GetMailAccounts",
29817 "title": "Example usage:",
29818 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29822 "name": "GetMailAccounts",
29824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29825 "version": "0.0.0",
29826 "filename": "server/api/user/index.js",
29827 "groupTitle": "Users"
29831 "url": "/api/users/{id}/mail/interactions",
29832 "title": "GetMailInteractions",
29835 "title": "Example usage:",
29836 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29840 "name": "GetMailInteractions",
29842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29843 "version": "0.0.0",
29844 "filename": "server/api/user/index.js",
29845 "groupTitle": "Users"
29849 "url": "/api/users/{id}/openchannel_accounts",
29850 "title": "GetOpenchannelAccounts",
29853 "title": "Example usage:",
29854 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29858 "name": "GetOpenchannelAccounts",
29860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29861 "version": "0.0.0",
29862 "filename": "server/api/user/index.js",
29863 "groupTitle": "Users"
29867 "url": "/api/users/{id}/openchannel/interactions",
29868 "title": "GetOpenchannelInteractions",
29871 "title": "Example usage:",
29872 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29876 "name": "GetOpenchannelInteractions",
29878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29879 "version": "0.0.0",
29880 "filename": "server/api/user/index.js",
29881 "groupTitle": "Users"
29885 "url": "/api/users/{id}/prefixes",
29886 "title": "GetPrefixes",
29889 "title": "Example usage:",
29890 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29894 "name": "GetPrefixes",
29896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29897 "version": "0.0.0",
29898 "filename": "server/api/user/index.js",
29899 "groupTitle": "Users"
29903 "url": "/api/users/{id}/queues?channel={channel}",
29904 "title": "Gets Queues list",
29907 "title": "Example usage:",
29908 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29912 "name": "GetQueues",
29914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29915 "version": "0.0.0",
29916 "filename": "server/api/user/index.js",
29917 "groupTitle": "Users"
29921 "url": "/api/users/{id}/recordings",
29922 "title": "GetRecordings",
29925 "title": "Example usage:",
29926 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29930 "name": "GetRecordings",
29932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29933 "version": "0.0.0",
29934 "filename": "server/api/user/index.js",
29935 "groupTitle": "Users"
29939 "url": "/api/users/{id}/scheduled_calls",
29940 "title": "GetScheduledCalls",
29943 "title": "Example usage:",
29944 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29948 "name": "GetScheduledCalls",
29950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29951 "version": "0.0.0",
29952 "filename": "server/api/user/index.js",
29953 "groupTitle": "Users"
29957 "url": "/api/users/{id}/screen_recordings",
29958 "title": "GetScreenRecordings",
29961 "title": "Example usage:",
29962 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29966 "name": "GetScreenRecordings",
29968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29969 "version": "0.0.0",
29970 "filename": "server/api/user/index.js",
29971 "groupTitle": "Users"
29975 "url": "/api/users/{id}/sms_accounts",
29976 "title": "GetSmsAccounts",
29979 "title": "Example usage:",
29980 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29984 "name": "GetSmsAccounts",
29986 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29987 "version": "0.0.0",
29988 "filename": "server/api/user/index.js",
29989 "groupTitle": "Users"
29993 "url": "/api/users/{id}/sms/interactions",
29994 "title": "GetSmsInteractions",
29997 "title": "Example usage:",
29998 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
30002 "name": "GetSmsInteractions",
30004 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30005 "version": "0.0.0",
30006 "filename": "server/api/user/index.js",
30007 "groupTitle": "Users"
30011 "url": "/api/users/{id}/square_projects",
30012 "title": "GetSquareProjects",
30015 "title": "Example usage:",
30016 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
30020 "name": "GetSquareProjects",
30022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30023 "version": "0.0.0",
30024 "filename": "server/api/user/index.js",
30025 "groupTitle": "Users"
30029 "url": "/api/users/{id}/teams",
30030 "title": "GetTeams",
30033 "title": "Example usage:",
30034 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30038 "name": "GetTeams",
30040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30041 "version": "0.0.0",
30042 "filename": "server/api/user/index.js",
30043 "groupTitle": "Users"
30047 "url": "/api/users",
30048 "title": "Gets a list of Users",
30051 "title": "Example usage:",
30052 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30056 "name": "GetUsers",
30058 "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>",
30059 "version": "0.0.0",
30060 "filename": "server/api/user/index.js",
30061 "groupTitle": "Users"
30065 "url": "/api/users/{id}/queues_rt",
30066 "title": "GetVoiceQueuesRt",
30069 "title": "Example usage:",
30070 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30074 "name": "GetVoiceQueuesRt",
30076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30077 "version": "0.0.0",
30078 "filename": "server/api/user/index.js",
30079 "groupTitle": "Users"
30083 "url": "/api/users/{id}/whatsapp_accounts",
30084 "title": "GetWhatsappAccounts",
30087 "title": "Example usage:",
30088 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30092 "name": "GetWhatsappAccounts",
30094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30095 "version": "0.0.0",
30096 "filename": "server/api/user/index.js",
30097 "groupTitle": "Users"
30101 "url": "/api/users/{id}/whatsapp/interactions",
30102 "title": "GetWhatsappInteractions",
30105 "title": "Example usage:",
30106 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30110 "name": "GetWhatsappInteractions",
30112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30113 "version": "0.0.0",
30114 "filename": "server/api/user/index.js",
30115 "groupTitle": "Users"
30119 "url": "/api/users/{id}/login",
30123 "title": "Example usage:",
30124 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
30130 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30131 "version": "0.0.0",
30132 "filename": "server/api/user/index.js",
30133 "groupTitle": "Users"
30137 "url": "/api/users/{id}/logout",
30141 "title": "Example usage:",
30142 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30148 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30149 "version": "0.0.0",
30150 "filename": "server/api/user/index.js",
30151 "groupTitle": "Users"
30155 "url": "/api/users/{id}/pause",
30159 "title": "Example usage:",
30160 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30166 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30167 "version": "0.0.0",
30168 "filename": "server/api/user/index.js",
30169 "groupTitle": "Users"
30173 "url": "/api/users/{id}/api_key",
30174 "title": "Remove API access key for the user",
30177 "title": "Example usage:",
30178 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30182 "name": "RemoveApiKey",
30184 "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>",
30185 "version": "0.0.0",
30186 "filename": "server/api/user/index.js",
30187 "groupTitle": "Users"
30191 "url": "/api/users/{id}/chat_interactions",
30192 "title": "Removes interactions from an agent",
30195 "title": "Example usage:",
30196 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30200 "name": "RemoveChatInteractions",
30202 "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>",
30203 "version": "0.0.0",
30204 "filename": "server/api/user/index.js",
30205 "groupTitle": "Users"
30209 "url": "/api/users/{id}/chat_websites",
30210 "title": "Removes a Chat Website from a user",
30213 "title": "Example usage:",
30214 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30218 "name": "RemoveChatWebsites",
30220 "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>",
30221 "version": "0.0.0",
30222 "filename": "server/api/user/index.js",
30223 "groupTitle": "Users"
30227 "url": "/api/users/{id}/fax_accounts",
30228 "title": "Removes a Fax Account from a user",
30231 "title": "Example usage:",
30232 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30236 "name": "RemoveFaxAccounts",
30238 "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>",
30239 "version": "0.0.0",
30240 "filename": "server/api/user/index.js",
30241 "groupTitle": "Users"
30245 "url": "/api/users/{id}/fax_interactions",
30246 "title": "Removes interactions from an agent",
30249 "title": "Example usage:",
30250 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30254 "name": "RemoveFaxInteractions",
30256 "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>",
30257 "version": "0.0.0",
30258 "filename": "server/api/user/index.js",
30259 "groupTitle": "Users"
30263 "url": "/api/users/{id}/mail_accounts",
30264 "title": "Removes a Mail Account from a user",
30267 "title": "Example usage:",
30268 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30272 "name": "RemoveMailAccounts",
30274 "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>",
30275 "version": "0.0.0",
30276 "filename": "server/api/user/index.js",
30277 "groupTitle": "Users"
30281 "url": "/api/users/{id}/mail_interactions",
30282 "title": "Removes interactions from an agent",
30285 "title": "Example usage:",
30286 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30290 "name": "RemoveMailInteractions",
30292 "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>",
30293 "version": "0.0.0",
30294 "filename": "server/api/user/index.js",
30295 "groupTitle": "Users"
30299 "url": "/api/users/{id}/openchannel_accounts",
30300 "title": "Removes a Open Channel Account from a user",
30303 "title": "Example usage:",
30304 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30308 "name": "RemoveOpenchannelAccounts",
30310 "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>",
30311 "version": "0.0.0",
30312 "filename": "server/api/user/index.js",
30313 "groupTitle": "Users"
30317 "url": "/api/users/{id}/openchannel_interactions",
30318 "title": "Removes openchannel interactions from an agent",
30321 "title": "Example usage:",
30322 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30326 "name": "RemoveOpenchannelInteractions",
30328 "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>",
30329 "version": "0.0.0",
30330 "filename": "server/api/user/index.js",
30331 "groupTitle": "Users"
30335 "url": "/api/users/{id}/queues",
30336 "title": "Remove queues to an agent",
30339 "title": "Example usage:",
30340 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30344 "name": "RemoveQueues",
30346 "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>",
30347 "version": "0.0.0",
30348 "filename": "server/api/user/index.js",
30349 "groupTitle": "Users"
30353 "url": "/api/users/{id}/sms_accounts",
30354 "title": "Removes a Sms Account from a user",
30357 "title": "Example usage:",
30358 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30362 "name": "RemoveSmsAccounts",
30364 "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>",
30365 "version": "0.0.0",
30366 "filename": "server/api/user/index.js",
30367 "groupTitle": "Users"
30371 "url": "/api/users/{id}/sms_interactions",
30372 "title": "Removes interactions from an agent",
30375 "title": "Example usage:",
30376 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30380 "name": "RemoveSmsInteractions",
30382 "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>",
30383 "version": "0.0.0",
30384 "filename": "server/api/user/index.js",
30385 "groupTitle": "Users"
30389 "url": "/api/users/{id}/square_projects",
30390 "title": "Removes a Square Project from a user",
30393 "title": "Example usage:",
30394 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30398 "name": "RemoveSquareProjects",
30400 "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>",
30401 "version": "0.0.0",
30402 "filename": "server/api/user/index.js",
30403 "groupTitle": "Users"
30407 "url": "/api/users/{id}/teams",
30408 "title": "Removes teams from an agent",
30411 "title": "Example usage:",
30412 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30416 "name": "RemoveTeams",
30418 "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>",
30419 "version": "0.0.0",
30420 "filename": "server/api/user/index.js",
30421 "groupTitle": "Users"
30425 "url": "/api/users/{id}/whatsapp_accounts",
30426 "title": "Removes a Whatsapp Account from a user",
30429 "title": "Example usage:",
30430 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30434 "name": "RemoveWhatsappAccounts",
30436 "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>",
30437 "version": "0.0.0",
30438 "filename": "server/api/user/index.js",
30439 "groupTitle": "Users"
30443 "url": "/api/users/{id}/whatsapp_interactions",
30444 "title": "Removes Whatsapp interactions from an agent",
30447 "title": "Example usage:",
30448 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30452 "name": "RemoveWhatsappInteractions",
30454 "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>",
30455 "version": "0.0.0",
30456 "filename": "server/api/user/index.js",
30457 "groupTitle": "Users"
30461 "url": "/api/users/{id}",
30462 "title": "Gets a single User",
30465 "title": "Example usage:",
30466 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30470 "name": "ShowUsers",
30472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30473 "version": "0.0.0",
30474 "filename": "server/api/user/index.js",
30475 "groupTitle": "Users"
30479 "url": "/api/users/{id}/unpause",
30480 "title": "Unpause",
30483 "title": "Example usage:",
30484 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30490 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30491 "version": "0.0.0",
30492 "filename": "server/api/user/index.js",
30493 "groupTitle": "Users"
30497 "url": "/api/users/whoami",
30501 "title": "Example usage:",
30502 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30509 "version": "0.0.0",
30510 "filename": "server/api/user/index.js",
30511 "groupTitle": "Users"
30515 "url": "/api/users/{id}/avatar",
30516 "title": "Add avatar",
30519 "title": "Example usage:",
30520 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30524 "name": "addAvatar",
30526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30527 "version": "0.0.0",
30528 "filename": "server/api/user/index.js",
30529 "groupTitle": "Users"
30533 "url": "/api/users/{id}/avatar",
30534 "title": "Get avatar",
30537 "title": "Example usage:",
30538 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30542 "name": "getAvatar",
30544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30545 "version": "0.0.0",
30546 "filename": "server/api/user/index.js",
30547 "groupTitle": "Users"
30551 "url": "/api/users/{id}",
30552 "title": "Update an existing User",
30555 "title": "Example usage:",
30556 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30560 "name": "updateUsers",
30562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30563 "version": "0.0.0",
30564 "filename": "server/api/user/index.js",
30565 "groupTitle": "Users"
30569 "url": "/api/variables",
30570 "title": "Creates a new Variable",
30573 "title": "Example usage:",
30574 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30578 "name": "CreateVariables",
30579 "group": "Variables",
30594 "field": "description",
30600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30601 "version": "0.0.0",
30602 "filename": "server/api/variable/index.js",
30603 "groupTitle": "Variables"
30607 "url": "/api/variables/{id}",
30608 "title": "Deletes a Variable",
30611 "title": "Example usage:",
30612 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30616 "name": "DeleteVariables",
30617 "group": "Variables",
30618 "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>",
30619 "version": "0.0.0",
30620 "filename": "server/api/variable/index.js",
30621 "groupTitle": "Variables"
30625 "url": "/api/variables",
30626 "title": "Gets a list of Variables",
30629 "title": "Example usage:",
30630 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30634 "name": "GetVariables",
30635 "group": "Variables",
30636 "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>",
30637 "version": "0.0.0",
30638 "filename": "server/api/variable/index.js",
30639 "groupTitle": "Variables"
30643 "url": "/api/variables/{id}",
30644 "title": "Gets a single Variable",
30647 "title": "Example usage:",
30648 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30652 "name": "ShowVariables",
30653 "group": "Variables",
30654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30655 "version": "0.0.0",
30656 "filename": "server/api/variable/index.js",
30657 "groupTitle": "Variables"
30661 "url": "/api/variables/{id}",
30662 "title": "Update an existing Variable",
30665 "title": "Example usage:",
30666 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30670 "name": "updateVariables",
30671 "group": "Variables",
30672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30673 "version": "0.0.0",
30674 "filename": "server/api/variable/index.js",
30675 "groupTitle": "Variables"
30679 "url": "/api/version/fetch",
30680 "title": "Fetch git version",
30683 "title": "Example usage:",
30684 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30688 "name": "FetchVersion",
30689 "group": "Version",
30690 "description": "<p>Motion run the following command: git fetch origin master</p>",
30691 "version": "0.0.0",
30692 "filename": "server/api/version/index.js",
30693 "groupTitle": "Version"
30697 "url": "/api/version",
30698 "title": "Gets version",
30701 "title": "Example usage:",
30702 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30706 "name": "GetVersion",
30707 "group": "Version",
30708 "description": "<p>Motion returns the current and latest motion version.</p>",
30709 "version": "0.0.0",
30710 "filename": "server/api/version/index.js",
30711 "groupTitle": "Version"
30715 "url": "/api/version/migrations",
30716 "title": "Launch database migrations",
30719 "title": "Example usage:",
30720 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30724 "name": "MigrateVersion",
30725 "group": "Version",
30726 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30727 "version": "0.0.0",
30728 "filename": "server/api/version/index.js",
30729 "groupTitle": "Version"
30733 "url": "/api/version/pull",
30734 "title": "Pull git version",
30737 "title": "Example usage:",
30738 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30742 "name": "PullVersion",
30743 "group": "Version",
30744 "description": "<p>Motion run the following command: git pull</p>",
30745 "version": "0.0.0",
30746 "filename": "server/api/version/index.js",
30747 "groupTitle": "Version"
30751 "url": "/api/version/reset",
30752 "title": "Reset git version",
30755 "title": "Example usage:",
30756 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30760 "name": "ResetVersion",
30761 "group": "Version",
30762 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30763 "version": "0.0.0",
30764 "filename": "server/api/version/index.js",
30765 "groupTitle": "Version"
30769 "url": "/api/version/restart",
30770 "title": "Restart motion2 after update",
30773 "title": "Example usage:",
30774 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30778 "name": "RestartVersion",
30779 "group": "Version",
30780 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30781 "version": "0.0.0",
30782 "filename": "server/api/version/index.js",
30783 "groupTitle": "Version"
30787 "url": "/api/voice/agents/reports/describe",
30788 "title": "Gets table info about Agent Reports",
30791 "title": "Example usage:",
30792 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30796 "name": "DescribeAgent_Reports",
30797 "group": "Voice_Agent_Reports",
30798 "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>",
30799 "version": "0.0.0",
30800 "filename": "server/api/voiceAgentReport/index.js",
30801 "groupTitle": "Voice_Agent_Reports"
30805 "url": "/api/voice/agents/reports",
30806 "title": "Gets a list of Agent Reports",
30809 "title": "Example usage:",
30810 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30814 "name": "GetAgent_Reports",
30815 "group": "Voice_Agent_Reports",
30816 "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>",
30817 "version": "0.0.0",
30818 "filename": "server/api/voiceAgentReport/index.js",
30819 "groupTitle": "Voice_Agent_Reports"
30823 "url": "/api/voice/agents/reports/{id}",
30824 "title": "Gets a single Agent Report",
30827 "title": "Example usage:",
30828 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30832 "name": "ShowAgent_Reports",
30833 "group": "Voice_Agent_Reports",
30834 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30835 "version": "0.0.0",
30836 "filename": "server/api/voiceAgentReport/index.js",
30837 "groupTitle": "Voice_Agent_Reports"
30841 "url": "/api/voice/calls/reports/describe",
30842 "title": "Gets table info about Call Reports",
30845 "title": "Example usage:",
30846 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30850 "name": "DescribeCall_Reports",
30851 "group": "Voice_Call_Reports",
30852 "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>",
30853 "version": "0.0.0",
30854 "filename": "server/api/voiceCallReport/index.js",
30855 "groupTitle": "Voice_Call_Reports"
30859 "url": "/api/voice/calls/reports",
30860 "title": "Gets a list of Call Reports",
30863 "title": "Example usage:",
30864 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30868 "name": "GetCall_Reports",
30869 "group": "Voice_Call_Reports",
30870 "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>",
30871 "version": "0.0.0",
30872 "filename": "server/api/voiceCallReport/index.js",
30873 "groupTitle": "Voice_Call_Reports"
30877 "url": "/api/voice/calls/reports/{id}",
30878 "title": "Gets a single Call Report",
30881 "title": "Example usage:",
30882 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30886 "name": "ShowCall_Reports",
30887 "group": "Voice_Call_Reports",
30888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30889 "version": "0.0.0",
30890 "filename": "server/api/voiceCallReport/index.js",
30891 "groupTitle": "Voice_Call_Reports"
30895 "url": "/api/voice/calls/reports/{id}",
30896 "title": "Update a single cdr",
30899 "title": "Example usage:",
30900 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30905 "group": "Voice_Call_Reports",
30906 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30907 "version": "0.0.0",
30908 "filename": "server/api/voiceCallReport/index.js",
30909 "groupTitle": "Voice_Call_Reports"
30913 "url": "/api/voice/chanspy",
30914 "title": "Creates a new ChanSpy",
30917 "title": "Example usage:",
30918 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30922 "name": "CreateChanSpy",
30923 "group": "Voice_ChanSpy",
30945 "field": "options",
30959 "field": "password",
30973 "field": "recordingFormat",
30980 "field": "description",
30986 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30987 "version": "0.0.0",
30988 "filename": "server/api/voiceChanSpy/index.js",
30989 "groupTitle": "Voice_ChanSpy"
30993 "url": "/api/voice/chanspy/{id}",
30994 "title": "Deletes a ChanSpy",
30997 "title": "Example usage:",
30998 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31002 "name": "DeleteChanSpy",
31003 "group": "Voice_ChanSpy",
31004 "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>",
31005 "version": "0.0.0",
31006 "filename": "server/api/voiceChanSpy/index.js",
31007 "groupTitle": "Voice_ChanSpy"
31011 "url": "/api/voice/chanspy",
31012 "title": "Gets a list of ChanSpy",
31015 "title": "Example usage:",
31016 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31020 "name": "GetChanSpy",
31021 "group": "Voice_ChanSpy",
31022 "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>",
31023 "version": "0.0.0",
31024 "filename": "server/api/voiceChanSpy/index.js",
31025 "groupTitle": "Voice_ChanSpy"
31029 "url": "/api/voice/chanspy/{id}",
31030 "title": "Gets a single ChanSpy",
31033 "title": "Example usage:",
31034 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31038 "name": "ShowChanSpy",
31039 "group": "Voice_ChanSpy",
31040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31041 "version": "0.0.0",
31042 "filename": "server/api/voiceChanSpy/index.js",
31043 "groupTitle": "Voice_ChanSpy"
31047 "url": "/api/voice/chanspy/{id}",
31048 "title": "Update an existing ChanSpy",
31051 "title": "Example usage:",
31052 "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",
31056 "name": "updateChanSpy",
31057 "group": "Voice_ChanSpy",
31058 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31059 "version": "0.0.0",
31060 "filename": "server/api/voiceChanSpy/index.js",
31061 "groupTitle": "Voice_ChanSpy"
31065 "url": "/api/voice/contexts",
31066 "title": "Create a new context",
31069 "title": "Example usage:",
31070 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31075 "group": "Voice_Contexts",
31090 "field": "description",
31097 "field": "defaultEntry",
31103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31104 "version": "0.0.0",
31105 "filename": "server/api/voiceContext/index.js",
31106 "groupTitle": "Voice_Contexts"
31110 "url": "/api/voice/contexts/{id}",
31111 "title": "Deletes a context",
31114 "title": "Example usage:",
31115 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31120 "group": "Voice_Contexts",
31121 "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>",
31122 "version": "0.0.0",
31123 "filename": "server/api/voiceContext/index.js",
31124 "groupTitle": "Voice_Contexts"
31128 "url": "/api/voice/contexts",
31129 "title": "Gets a list of Contexts",
31132 "title": "Example usage:",
31133 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31137 "name": "GetContexts",
31138 "group": "Voice_Contexts",
31139 "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>",
31140 "version": "0.0.0",
31141 "filename": "server/api/voiceContext/index.js",
31142 "groupTitle": "Voice_Contexts"
31146 "url": "/api/voice/contexts/{id}",
31147 "title": "Gets a single Context",
31150 "title": "Example usage:",
31151 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31155 "name": "ShowContexts",
31156 "group": "Voice_Contexts",
31157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31158 "version": "0.0.0",
31159 "filename": "server/api/voiceContext/index.js",
31160 "groupTitle": "Voice_Contexts"
31164 "url": "/api/voice/contexts/{id}",
31165 "title": "Update an existing context",
31168 "title": "Example usage:",
31169 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31174 "group": "Voice_Contexts",
31175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31176 "version": "0.0.0",
31177 "filename": "server/api/voiceContext/index.js",
31178 "groupTitle": "Voice_Contexts"
31182 "url": "/api/voice/dials/reports/describe",
31183 "title": "Gets table info about Dial Reports",
31186 "title": "Example usage:",
31187 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31191 "name": "DescribeDial_Reports",
31192 "group": "Voice_Dial_Reports",
31193 "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>",
31194 "version": "0.0.0",
31195 "filename": "server/api/voiceDialReport/index.js",
31196 "groupTitle": "Voice_Dial_Reports"
31200 "url": "/api/voice/dials/reports",
31201 "title": "Gets a list of Dial Reports",
31204 "title": "Example usage:",
31205 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31209 "name": "GetDial_Reports",
31210 "group": "Voice_Dial_Reports",
31211 "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>",
31212 "version": "0.0.0",
31213 "filename": "server/api/voiceDialReport/index.js",
31214 "groupTitle": "Voice_Dial_Reports"
31218 "url": "/api/voice/dials/reports/{id}",
31219 "title": "Gets a single Dial Report",
31222 "title": "Example usage:",
31223 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31227 "name": "ShowDial_Reports",
31228 "group": "Voice_Dial_Reports",
31229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31230 "version": "0.0.0",
31231 "filename": "server/api/voiceDialReport/index.js",
31232 "groupTitle": "Voice_Dial_Reports"
31236 "url": "/api/voice/extensions/{id}",
31237 "title": "Deletes a Extension",
31240 "title": "Example usage:",
31241 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31245 "name": "DeleteExtensions",
31246 "group": "Voice_Extensions",
31247 "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>",
31248 "version": "0.0.0",
31249 "filename": "server/api/voiceExtension/index.js",
31250 "groupTitle": "Voice_Extensions"
31254 "url": "/api/voice/extensions",
31255 "title": "Gets a list of Extensions",
31258 "title": "Example usage:",
31259 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31263 "name": "GetExtensions",
31264 "group": "Voice_Extensions",
31265 "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>",
31266 "version": "0.0.0",
31267 "filename": "server/api/voiceExtension/index.js",
31268 "groupTitle": "Voice_Extensions"
31272 "url": "/api/voice/extensions/{id}",
31273 "title": "Gets a single Extension",
31276 "title": "Example usage:",
31277 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31281 "name": "ShowExtensions",
31282 "group": "Voice_Extensions",
31283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31284 "version": "0.0.0",
31285 "filename": "server/api/voiceExtension/index.js",
31286 "groupTitle": "Voice_Extensions"
31290 "url": "/api/voice/extensions",
31291 "title": "Create new applications",
31294 "title": "Example usage:",
31295 "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",
31299 "name": "addApplications",
31300 "group": "Voice_Extensions",
31301 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31302 "version": "0.0.0",
31303 "filename": "server/api/voiceExtension/index.js",
31304 "groupTitle": "Voice_Extensions"
31308 "url": "/api/voice/extensions",
31309 "title": "Create an extension",
31312 "title": "Example usage:",
31313 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31318 "group": "Voice_Extensions",
31319 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31320 "version": "0.0.0",
31321 "filename": "server/api/voiceExtension/index.js",
31322 "groupTitle": "Voice_Extensions"
31326 "url": "/api/voice/extensions/{id}",
31327 "title": "Update an extension",
31330 "title": "Example usage:",
31331 "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",
31336 "group": "Voice_Extensions",
31337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31338 "version": "0.0.0",
31339 "filename": "server/api/voiceExtension/index.js",
31340 "groupTitle": "Voice_Extensions"
31344 "url": "/api/voice/mohs",
31345 "title": "Create a new a new MOH",
31348 "title": "Example usage:",
31349 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31354 "group": "Voice_MOHs",
31355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31356 "version": "0.0.0",
31357 "filename": "server/api/voiceMusicOnHold/index.js",
31358 "groupTitle": "Voice_MOHs"
31362 "url": "/api/voice/mohs/{id}/sounds",
31363 "title": "Add sound to MOH",
31366 "title": "Example usage:",
31367 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31371 "name": "AddSound",
31372 "group": "Voice_MOHs",
31373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31374 "version": "0.0.0",
31375 "filename": "server/api/voiceMusicOnHold/index.js",
31376 "groupTitle": "Voice_MOHs"
31380 "url": "/api/voice/mohs/{id}",
31381 "title": "Deletes an MOH",
31384 "title": "Example usage:",
31385 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31389 "name": "DestroyMoh",
31390 "group": "Voice_MOHs",
31391 "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>",
31392 "version": "0.0.0",
31393 "filename": "server/api/voiceMusicOnHold/index.js",
31394 "groupTitle": "Voice_MOHs"
31398 "url": "/api/voice/mohs",
31399 "title": "Gets a list of Music On Holds",
31402 "title": "Example usage:",
31403 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31407 "name": "GetMusic_On_Holds",
31408 "group": "Voice_MOHs",
31409 "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>",
31410 "version": "0.0.0",
31411 "filename": "server/api/voiceMusicOnHold/index.js",
31412 "groupTitle": "Voice_MOHs"
31416 "url": "/api/voice/mohs/{id}/sounds",
31417 "title": "Gets sounds from MOH",
31420 "title": "Example usage:",
31421 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31425 "name": "GetSounds",
31426 "group": "Voice_MOHs",
31427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31428 "version": "0.0.0",
31429 "filename": "server/api/voiceMusicOnHold/index.js",
31430 "groupTitle": "Voice_MOHs"
31434 "url": "/api/voice/mohs/{id}/sounds/{id2}",
31435 "title": "Remove sound from MOH",
31438 "title": "Example usage:",
31439 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31443 "name": "RemoveSound",
31444 "group": "Voice_MOHs",
31445 "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>",
31446 "version": "0.0.0",
31447 "filename": "server/api/voiceMusicOnHold/index.js",
31448 "groupTitle": "Voice_MOHs"
31452 "url": "/api/voice/mohs/{id}",
31453 "title": "Gets a single Music On Hold",
31456 "title": "Example usage:",
31457 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31461 "name": "ShowMusic_On_Holds",
31462 "group": "Voice_MOHs",
31463 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31464 "version": "0.0.0",
31465 "filename": "server/api/voiceMusicOnHold/index.js",
31466 "groupTitle": "Voice_MOHs"
31470 "url": "/api/voice/mohs/{id}",
31471 "title": "Update an existing Music On Hold",
31474 "title": "Example usage:",
31475 "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",
31479 "name": "updateMusic_On_Holds",
31480 "group": "Voice_MOHs",
31481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31482 "version": "0.0.0",
31483 "filename": "server/api/voiceMusicOnHold/index.js",
31484 "groupTitle": "Voice_MOHs"
31488 "url": "/api/voice/mails",
31489 "title": "Creates a new Mail",
31492 "title": "Example usage:",
31493 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31497 "name": "CreateMails",
31498 "group": "Voice_Mails",
31506 "field": "customer_id",
31513 "field": "context",
31520 "field": "mailbox",
31527 "field": "password",
31534 "field": "fullname",
31584 "field": "dialout",
31591 "field": "callback",
31613 "field": "operator",
31624 "field": "envelope",
31635 "field": "sayduration",
31642 "field": "saydurationm",
31653 "field": "sendvoicemail",
31675 "field": "nextaftercmd",
31686 "field": "forcename",
31697 "field": "forcegreetings",
31708 "field": "hidefromdir",
31722 "field": "emailsubject",
31729 "field": "emailbody",
31736 "field": "maxsecs",
31756 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31757 "version": "0.0.0",
31758 "filename": "server/api/voiceMail/index.js",
31759 "groupTitle": "Voice_Mails"
31763 "url": "/api/voice/mails/{id}",
31764 "title": "Deletes a Mail",
31767 "title": "Example usage:",
31768 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31772 "name": "DeleteMails",
31773 "group": "Voice_Mails",
31774 "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>",
31775 "version": "0.0.0",
31776 "filename": "server/api/voiceMail/index.js",
31777 "groupTitle": "Voice_Mails"
31781 "url": "/api/voice/mails",
31782 "title": "Gets a list of Mails",
31785 "title": "Example usage:",
31786 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31790 "name": "GetMails",
31791 "group": "Voice_Mails",
31792 "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>",
31793 "version": "0.0.0",
31794 "filename": "server/api/voiceMail/index.js",
31795 "groupTitle": "Voice_Mails"
31799 "url": "/api/voice/mails/{id}",
31800 "title": "Gets a single Mail",
31803 "title": "Example usage:",
31804 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31808 "name": "ShowMails",
31809 "group": "Voice_Mails",
31810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31811 "version": "0.0.0",
31812 "filename": "server/api/voiceMail/index.js",
31813 "groupTitle": "Voice_Mails"
31817 "url": "/api/voice/mails/{id}/messages",
31818 "title": "Gets voice mail messages",
31821 "title": "Example usage:",
31822 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31826 "name": "getMessages",
31827 "group": "Voice_Mails",
31828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31829 "version": "0.0.0",
31830 "filename": "server/api/voiceMail/index.js",
31831 "groupTitle": "Voice_Mails"
31835 "url": "/api/voice/mails/{id}",
31836 "title": "Update an existing Mail",
31839 "title": "Example usage:",
31840 "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",
31844 "name": "updateMails",
31845 "group": "Voice_Mails",
31846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31847 "version": "0.0.0",
31848 "filename": "server/api/voiceMail/index.js",
31849 "groupTitle": "Voice_Mails"
31853 "url": "/api/voice/mails/messages",
31854 "title": "Creates a new Message",
31857 "title": "Example usage:",
31858 "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",
31862 "name": "CreateMessages",
31863 "group": "Voice_Messages",
31892 "field": "context",
31899 "field": "macrocontext",
31906 "field": "callerid",
31913 "field": "origtime",
31920 "field": "duration",
31927 "field": "mailboxuser",
31934 "field": "mailboxcontext",
31941 "field": "recording",
31968 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31969 "version": "0.0.0",
31970 "filename": "server/api/voiceMailMessage/index.js",
31971 "groupTitle": "Voice_Messages"
31975 "url": "/api/voice/mails/messages/{id}",
31976 "title": "Deletes a Message",
31979 "title": "Example usage:",
31980 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31984 "name": "DeleteMessages",
31985 "group": "Voice_Messages",
31986 "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>",
31987 "version": "0.0.0",
31988 "filename": "server/api/voiceMailMessage/index.js",
31989 "groupTitle": "Voice_Messages"
31993 "url": "/api/voice/mails/messages",
31994 "title": "Gets a list of Messages",
31997 "title": "Example usage:",
31998 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32002 "name": "GetMessages",
32003 "group": "Voice_Messages",
32004 "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>",
32005 "version": "0.0.0",
32006 "filename": "server/api/voiceMailMessage/index.js",
32007 "groupTitle": "Voice_Messages"
32011 "url": "/api/voice/mails/messages/{id}",
32012 "title": "Gets a single Message",
32015 "title": "Example usage:",
32016 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32020 "name": "ShowMessages",
32021 "group": "Voice_Messages",
32022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32023 "version": "0.0.0",
32024 "filename": "server/api/voiceMailMessage/index.js",
32025 "groupTitle": "Voice_Messages"
32029 "url": "voice/mails/messages/{id}/download",
32030 "title": "Download Voice Message",
32033 "title": "Example usage:",
32034 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32038 "name": "download",
32039 "group": "Voice_Messages",
32040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32041 "version": "0.0.0",
32042 "filename": "server/api/voiceMailMessage/index.js",
32043 "groupTitle": "Voice_Messages"
32047 "url": "/api/voice/mails/messages/{id}",
32048 "title": "Update an existing Message",
32051 "title": "Example usage:",
32052 "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",
32056 "name": "updateMessages",
32057 "group": "Voice_Messages",
32058 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32059 "version": "0.0.0",
32060 "filename": "server/api/voiceMailMessage/index.js",
32061 "groupTitle": "Voice_Messages"
32065 "url": "/api/voice/prefixes/{id}/users",
32066 "title": "Add agents to a prefix",
32069 "title": "Example usage:",
32070 "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",
32074 "name": "AddAgents",
32075 "group": "Voice_Prefixes",
32076 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32077 "version": "0.0.0",
32078 "filename": "server/api/voicePrefix/index.js",
32079 "groupTitle": "Voice_Prefixes"
32083 "url": "/api/voice/prefixes/{id}",
32084 "title": "Deletes a Prefix",
32087 "title": "Example usage:",
32088 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32092 "name": "DeletePrefixes",
32093 "group": "Voice_Prefixes",
32094 "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>",
32095 "version": "0.0.0",
32096 "filename": "server/api/voicePrefix/index.js",
32097 "groupTitle": "Voice_Prefixes"
32101 "url": "/api/voice/prefixes/describe",
32102 "title": "Gets table info about Prefixes",
32105 "title": "Example usage:",
32106 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32110 "name": "DescribePrefixes",
32111 "group": "Voice_Prefixes",
32112 "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>",
32113 "version": "0.0.0",
32114 "filename": "server/api/voicePrefix/index.js",
32115 "groupTitle": "Voice_Prefixes"
32119 "url": "/api/voice/prefixes/{id}/users",
32120 "title": "Gets agents from prefix",
32123 "title": "Example usage:",
32124 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32128 "name": "GetAgents",
32129 "group": "Voice_Prefixes",
32130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32131 "version": "0.0.0",
32132 "filename": "server/api/voicePrefix/index.js",
32133 "groupTitle": "Voice_Prefixes"
32137 "url": "/api/voice/prefixes",
32138 "title": "Gets a list of Prefixes",
32141 "title": "Example usage:",
32142 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32146 "name": "GetPrefixes",
32147 "group": "Voice_Prefixes",
32148 "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>",
32149 "version": "0.0.0",
32150 "filename": "server/api/voicePrefix/index.js",
32151 "groupTitle": "Voice_Prefixes"
32155 "url": "/api/voice/prefixes/{id}/users",
32156 "title": "Removes agents from a prefix",
32159 "title": "Example usage:",
32160 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32164 "name": "RemoveAgents",
32165 "group": "Voice_Prefixes",
32166 "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>",
32167 "version": "0.0.0",
32168 "filename": "server/api/voicePrefix/index.js",
32169 "groupTitle": "Voice_Prefixes"
32173 "url": "/api/voice/prefixes/{id}",
32174 "title": "Gets a single Prefix",
32177 "title": "Example usage:",
32178 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32182 "name": "ShowPrefixes",
32183 "group": "Voice_Prefixes",
32184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32185 "version": "0.0.0",
32186 "filename": "server/api/voicePrefix/index.js",
32187 "groupTitle": "Voice_Prefixes"
32191 "url": "/api/voice/prefixes/{id}",
32192 "title": "Update an existing prefix",
32195 "title": "Example usage:",
32196 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32201 "group": "Voice_Prefixes",
32202 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32203 "version": "0.0.0",
32204 "filename": "server/api/voicePrefix/index.js",
32205 "groupTitle": "Voice_Prefixes"
32209 "url": "/api/voice/prefixes",
32210 "title": "Create a prefix",
32213 "title": "Example usage:",
32214 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32219 "group": "Voice_Prefixes",
32220 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32221 "version": "0.0.0",
32222 "filename": "server/api/voicePrefix/index.js",
32223 "groupTitle": "Voice_Prefixes"
32227 "url": "/api/voice/queues/reports/describe",
32228 "title": "Gets table info about Queue Reports",
32231 "title": "Example usage:",
32232 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32236 "name": "DescribeQueue_Reports",
32237 "group": "Voice_Queue_Reports",
32238 "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>",
32239 "version": "0.0.0",
32240 "filename": "server/api/voiceQueueReport/index.js",
32241 "groupTitle": "Voice_Queue_Reports"
32245 "url": "/api/voice/queues/reports",
32246 "title": "Gets a list of Queue Reports",
32249 "title": "Example usage:",
32250 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32254 "name": "GetQueue_Reports",
32255 "group": "Voice_Queue_Reports",
32256 "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>",
32257 "version": "0.0.0",
32258 "filename": "server/api/voiceQueueReport/index.js",
32259 "groupTitle": "Voice_Queue_Reports"
32263 "url": "/api/voice/queues/reports/{id}",
32264 "title": "Gets a single Queue Report",
32267 "title": "Example usage:",
32268 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32272 "name": "ShowQueue_Reports",
32273 "group": "Voice_Queue_Reports",
32274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32275 "version": "0.0.0",
32276 "filename": "server/api/voiceQueueReport/index.js",
32277 "groupTitle": "Voice_Queue_Reports"
32281 "url": "/api/voice/queues/reports/index",
32282 "title": "Get Voice Queues Report",
32285 "title": "Example usage:",
32286 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32290 "name": "getVoiceQueuesReport",
32291 "group": "Voice_Queue_Reports",
32292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32293 "version": "0.0.0",
32294 "filename": "server/api/voiceQueueReport/index.js",
32295 "groupTitle": "Voice_Queue_Reports"
32299 "url": "/api/voice/queues/{id}/users",
32300 "title": "Add agents to queue",
32303 "title": "Example usage:",
32304 "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",
32308 "name": "AddAgents",
32309 "group": "Voice_Queues",
32310 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32311 "version": "0.0.0",
32312 "filename": "server/api/voiceQueue/index.js",
32313 "groupTitle": "Voice_Queues"
32317 "url": "/api/voice/queues/{id}/blacklists",
32318 "title": "Add blacklists to a queue",
32321 "title": "Example usage:",
32322 "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",
32326 "name": "AddBlackLists",
32327 "group": "Voice_Queues",
32328 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32329 "version": "0.0.0",
32330 "filename": "server/api/voiceQueue/index.js",
32331 "groupTitle": "Voice_Queues"
32335 "url": "/api/voice/queues/{id}/lists",
32336 "title": "Add lists to a queue",
32339 "title": "Example usage:",
32340 "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",
32344 "name": "AddLists",
32345 "group": "Voice_Queues",
32346 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32347 "version": "0.0.0",
32348 "filename": "server/api/voiceQueue/index.js",
32349 "groupTitle": "Voice_Queues"
32353 "url": "/api/voice/queues/{id}/teams",
32354 "title": "Add teams to queue",
32357 "title": "Example usage:",
32358 "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",
32362 "name": "AddTeams",
32363 "group": "Voice_Queues",
32364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32365 "version": "0.0.0",
32366 "filename": "server/api/voiceQueue/index.js",
32367 "groupTitle": "Voice_Queues"
32371 "url": "/api/voice/queues/clone",
32372 "title": "Clone an existing Queue",
32375 "title": "Example usage:",
32376 "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",
32380 "name": "CloneQueues",
32381 "group": "Voice_Queues",
32382 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32383 "version": "0.0.0",
32384 "filename": "server/api/voiceQueue/index.js",
32385 "groupTitle": "Voice_Queues"
32389 "url": "/api/voice/queues",
32390 "title": "Creates a new Queue",
32393 "title": "Example usage:",
32394 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32398 "name": "CreateQueues",
32399 "group": "Voice_Queues",
32425 "field": "musiconhold",
32432 "field": "announce",
32450 "field": "strategy",
32457 "field": "servicelevel",
32464 "field": "context",
32471 "field": "penaltymemberslimit",
32478 "field": "timeout",
32492 "field": "timeoutpriority",
32506 "field": "wrapuptime",
32517 "field": "autofill",
32529 "field": "autopause",
32536 "field": "autopausedelay",
32547 "field": "autopausebusy",
32558 "field": "autopauseunavail",
32576 "field": "setinterfacevar",
32587 "field": "setqueueentryvar",
32598 "field": "setqueuevar",
32609 "field": "eventmemberstatus",
32616 "field": "membermacro",
32623 "field": "membergosub",
32630 "field": "announce_frequency",
32637 "field": "min_announce_frequency",
32644 "field": "periodic_announce_frequency",
32655 "field": "random_periodic_announce",
32666 "field": "relative_periodic_announce",
32678 "field": "announce_holdtime",
32685 "field": "announce_position",
32696 "field": "announce_to_first_user",
32703 "field": "announce_position_limit",
32718 "field": "announce_round_seconds",
32725 "field": "monitor_format",
32732 "field": "monitor_type",
32739 "field": "queue_youarenext",
32746 "field": "queue_thereare",
32753 "field": "queue_callswaiting",
32760 "field": "queue_holdtime",
32767 "field": "queue_minute",
32774 "field": "queue_minutes",
32781 "field": "queue_seconds",
32788 "field": "queue_thankyou",
32795 "field": "queue_reporthold",
32802 "field": "queue_quantity1",
32809 "field": "queue_quantity2",
32816 "field": "queue_periodic_announce",
32823 "field": "queue_less_than",
32830 "field": "periodic_announce",
32837 "field": "joinempty",
32844 "field": "leavewhenempty",
32855 "field": "reportholdtime",
32866 "field": "ringinuse",
32873 "field": "memberdelay",
32884 "field": "timeoutrestart",
32891 "field": "defaultrule",
32898 "field": "description",
32912 "field": "acwTimeout",
32919 "field": "dialActive",
32920 "description": "<p>Active/Disactive Campaign</p>"
32933 "field": "dialMethod",
32934 "description": "<p>Dial Method.</p>"
32940 "field": "dialLimitChannel",
32941 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32947 "field": "dialLimitQueue",
32948 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32954 "field": "dialPowerLevel",
32955 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32961 "\"agentBusyFactor\"",
32965 "field": "dialPredictiveOptimization",
32966 "description": "<p>Only for predictive method.</p>"
32972 "field": "dialPredictiveOptimizationPercentage",
32973 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32979 "field": "dialPredictiveInterval",
32980 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32986 "field": "dialOriginateCallerIdName",
32993 "field": "dialOriginateCallerIdNumber",
33000 "field": "dialOriginateTimeout",
33001 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33007 "field": "dialQueueOptions",
33008 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33014 "field": "dialQueueTimeout",
33015 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33021 "field": "dialQueueProject",
33022 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33028 "field": "dialCongestionMaxRetry",
33029 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33035 "field": "dialCongestionRetryFrequency",
33036 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33042 "field": "dialBusyMaxRetry",
33043 "description": "<p>#Busy Retry (min:1, max:999)</p>"
33049 "field": "dialBusyRetryFrequency",
33050 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33056 "field": "dialNoAnswerMaxRetry",
33057 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33063 "field": "dialNoAnswerRetryFrequency",
33064 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33070 "field": "dialGlobalMaxRetry",
33071 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33077 "field": "dialTimezone",
33084 "field": "dialGlobalInterval",
33091 "field": "dialPrefix",
33103 "field": "dialCheckDuplicateType",
33110 "field": "dialAMDActive",
33111 "description": "<p>Active/Disactive AMD</p>"
33117 "field": "dialAMDInitialSilence",
33118 "description": "<p>#AMD Initial Silence</p>"
33124 "field": "dialAMDGreeting",
33125 "description": "<p>#AMD Greeting</p>"
33131 "field": "dialAMDAfterGreetingSilence",
33132 "description": "<p>#AMD After Greeting Silence</p>"
33138 "field": "dialAMDTotalAnalysisTime",
33139 "description": "<p>#AMD Total Analysis Time</p>"
33145 "field": "dialAMDMinWordLength",
33146 "description": "<p>#AMD Min Word Length</p>"
33152 "field": "dialAMDBetweenWordsSilence",
33153 "description": "<p>#AMD Between Words Silence</p>"
33159 "field": "dialAMDMaximumNumberOfWords",
33160 "description": "<p>#AMD Maximum Number Of Words</p>"
33166 "field": "dialAMDSilenceThreshold",
33167 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33173 "field": "dialAMDMaximumWordLength",
33174 "description": "<p>#AMD Maximum Word Length</p>"
33180 "field": "dialRecallMeTimeout",
33181 "description": "<p>#RecallMe Timeout (min:1)</p>"
33187 "field": "dialRecallInQueue",
33188 "description": "<p>Active/Disactive Recall In Queue</p>"
33198 "field": "dialOrderByScheduledAt",
33205 "field": "dialQueueProject2",
33206 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33212 "field": "dialAgiAfterHangupClient",
33219 "field": "dialAgiAfterHangupAgent",
33226 "field": "dialRandomLastDigitCallerIdNumber",
33227 "description": "<p>Random Last Digit (min:1, max:15)</p>"
33233 "field": "dialCutDigit",
33234 "description": "<p>Cut Digit (min:1, max:15)</p>"
33240 "field": "mandatoryDispositionPauseId",
33241 "description": "<p>Status to put when mandatory disposition is enabled</p>"
33247 "field": "mandatoryDisposition",
33248 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33254 "field": "dialPredictiveIntervalMaxThreshold",
33261 "field": "dialPredictiveIntervalMinThreshold",
33267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33268 "version": "0.0.0",
33269 "filename": "server/api/voiceQueue/index.js",
33270 "groupTitle": "Voice_Queues"
33274 "url": "/api/voice/queues/{id}",
33275 "title": "Deletes a Queue",
33278 "title": "Example usage:",
33279 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33283 "name": "DeleteQueues",
33284 "group": "Voice_Queues",
33285 "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>",
33286 "version": "0.0.0",
33287 "filename": "server/api/voiceQueue/index.js",
33288 "groupTitle": "Voice_Queues"
33292 "url": "/api/voice/queues/{id}/users",
33293 "title": "Gets queue agents",
33296 "title": "Example usage:",
33297 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33301 "name": "GetAgents",
33302 "group": "Voice_Queues",
33303 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33304 "version": "0.0.0",
33305 "filename": "server/api/voiceQueue/index.js",
33306 "groupTitle": "Voice_Queues"
33310 "url": "/api/voice/queues/{id}/blacklists",
33311 "title": "Get queue blacklists",
33314 "title": "Example usage:",
33315 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33319 "name": "GetBlackLists",
33320 "group": "Voice_Queues",
33321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33322 "version": "0.0.0",
33323 "filename": "server/api/voiceQueue/index.js",
33324 "groupTitle": "Voice_Queues"
33328 "url": "/api/voice/queues/{id}/finals",
33329 "title": "Gets queue hopper finals",
33332 "title": "Example usage:",
33333 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
33337 "name": "GetHopperFinals",
33338 "group": "Voice_Queues",
33339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33340 "version": "0.0.0",
33341 "filename": "server/api/voiceQueue/index.js",
33342 "groupTitle": "Voice_Queues"
33346 "url": "/api/voice/queues/{id}/hopper_histories",
33347 "title": "Gets queue hopper histories",
33350 "title": "Example usage:",
33351 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33355 "name": "GetHopperHistories",
33356 "group": "Voice_Queues",
33357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33358 "version": "0.0.0",
33359 "filename": "server/api/voiceQueue/index.js",
33360 "groupTitle": "Voice_Queues"
33364 "url": "/api/voice/queues/{id}/hoppers",
33365 "title": "Gets queue hoppers",
33368 "title": "Example usage:",
33369 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33373 "name": "GetHoppers",
33374 "group": "Voice_Queues",
33375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33376 "version": "0.0.0",
33377 "filename": "server/api/voiceQueue/index.js",
33378 "groupTitle": "Voice_Queues"
33382 "url": "/api/voice/queues/{id}/lists",
33383 "title": "Get queue lists",
33386 "title": "Example usage:",
33387 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33391 "name": "GetLists",
33392 "group": "Voice_Queues",
33393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33394 "version": "0.0.0",
33395 "filename": "server/api/voiceQueue/index.js",
33396 "groupTitle": "Voice_Queues"
33400 "url": "/api/voice/queues/{id}/members",
33401 "title": "Gets queue members",
33404 "title": "Example usage:",
33405 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33409 "name": "GetMembers",
33410 "group": "Voice_Queues",
33411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33412 "version": "0.0.0",
33413 "filename": "server/api/voiceQueue/index.js",
33414 "groupTitle": "Voice_Queues"
33418 "url": "/api/voice/queues",
33419 "title": "Gets a list of Queues",
33422 "title": "Example usage:",
33423 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33427 "name": "GetQueues",
33428 "group": "Voice_Queues",
33429 "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>",
33430 "version": "0.0.0",
33431 "filename": "server/api/voiceQueue/index.js",
33432 "groupTitle": "Voice_Queues"
33436 "url": "/api/voice/queues/{id}/teams",
33437 "title": "Gets queue team",
33440 "title": "Example usage:",
33441 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33445 "name": "GetTeams",
33446 "group": "Voice_Queues",
33447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33448 "version": "0.0.0",
33449 "filename": "server/api/voiceQueue/index.js",
33450 "groupTitle": "Voice_Queues"
33454 "url": "/api/voice/queues/{id}/users",
33455 "title": "Removes agents from a queue",
33458 "title": "Example usage:",
33459 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33463 "name": "RemoveAgents",
33464 "group": "Voice_Queues",
33465 "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>",
33466 "version": "0.0.0",
33467 "filename": "server/api/voiceQueue/index.js",
33468 "groupTitle": "Voice_Queues"
33472 "url": "/api/voice/queues/{id}/blacklists",
33473 "title": "Remove blacklists from a queue",
33476 "title": "Example usage:",
33477 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33481 "name": "RemoveBlackLists",
33482 "group": "Voice_Queues",
33483 "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>",
33484 "version": "0.0.0",
33485 "filename": "server/api/voiceQueue/index.js",
33486 "groupTitle": "Voice_Queues"
33490 "url": "/api/voice/queues/{id}/lists",
33491 "title": "Remove lists from a queue",
33494 "title": "Example usage:",
33495 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33499 "name": "RemoveLists",
33500 "group": "Voice_Queues",
33501 "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>",
33502 "version": "0.0.0",
33503 "filename": "server/api/voiceQueue/index.js",
33504 "groupTitle": "Voice_Queues"
33508 "url": "/api/voice/queues/{id}",
33509 "title": "Gets a single Queue",
33512 "title": "Example usage:",
33513 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33517 "name": "ShowQueues",
33518 "group": "Voice_Queues",
33519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33520 "version": "0.0.0",
33521 "filename": "server/api/voiceQueue/index.js",
33522 "groupTitle": "Voice_Queues"
33526 "url": "/api/voice/queues/{id}/blacks",
33527 "title": "Gets queue hopper blacks",
33530 "title": "Example usage:",
33531 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33535 "name": "getHopperBlacks",
33536 "group": "Voice_Queues",
33537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33538 "version": "0.0.0",
33539 "filename": "server/api/voiceQueue/index.js",
33540 "groupTitle": "Voice_Queues"
33544 "url": "/api/voice/queues/{id}",
33545 "title": "Update an existing Queue",
33548 "title": "Example usage:",
33549 "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",
33553 "name": "updateQueues",
33554 "group": "Voice_Queues",
33555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33556 "version": "0.0.0",
33557 "filename": "server/api/voiceQueue/index.js",
33558 "groupTitle": "Voice_Queues"
33562 "url": "/api/voice/recordings",
33563 "title": "Creates a new Recording",
33566 "title": "Example usage:",
33567 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33571 "name": "CreateRecordings",
33572 "group": "Voice_Recordings",
33587 "field": "uniqueid",
33594 "field": "channel",
33601 "field": "membername",
33608 "field": "calleridnum",
33615 "field": "calleridname",
33622 "field": "connectedlinenum",
33629 "field": "connectedlinename",
33636 "field": "accountcode",
33643 "field": "context",
33685 "field": "userDisposition",
33692 "field": "location",
33699 "field": "transcribeName",
33706 "field": "transcribeStatus",
33713 "field": "fileUri",
33720 "field": "fileText",
33727 "field": "failureReason",
33734 "field": "sentiment",
33741 "field": "sPositive",
33748 "field": "sNegative",
33755 "field": "sNeutral",
33769 "field": "tempSentiment",
33776 "field": "createdAt",
33783 "field": "updatedAt",
33789 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33790 "version": "0.0.0",
33791 "filename": "server/api/voiceRecording/index.js",
33792 "groupTitle": "Voice_Recordings"
33796 "url": "/api/voice/recordings/describe",
33797 "title": "Gets table info about Recordings",
33800 "title": "Example usage:",
33801 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33805 "name": "DescribeRecordings",
33806 "group": "Voice_Recordings",
33807 "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>",
33808 "version": "0.0.0",
33809 "filename": "server/api/voiceRecording/index.js",
33810 "groupTitle": "Voice_Recordings"
33814 "url": "/api/voice/recordings",
33815 "title": "Gets a list of Recordings",
33818 "title": "Example usage:",
33819 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33823 "name": "GetRecordings",
33824 "group": "Voice_Recordings",
33825 "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>",
33826 "version": "0.0.0",
33827 "filename": "server/api/voiceRecording/index.js",
33828 "groupTitle": "Voice_Recordings"
33832 "url": "/api/voice/recordings/{id}",
33833 "title": "Gets a single Recording",
33836 "title": "Example usage:",
33837 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33841 "name": "ShowRecordings",
33842 "group": "Voice_Recordings",
33843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33844 "version": "0.0.0",
33845 "filename": "server/api/voiceRecording/index.js",
33846 "groupTitle": "Voice_Recordings"
33850 "url": "/api/voice/recordings/{id}",
33851 "title": "Delete voice recording",
33854 "title": "Example usage:",
33855 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33860 "group": "Voice_Recordings",
33861 "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>",
33862 "version": "0.0.0",
33863 "filename": "server/api/voiceRecording/index.js",
33864 "groupTitle": "Voice_Recordings"
33868 "url": "/api/voice/recordings/{id}/download",
33869 "title": "Download Recording",
33872 "title": "Example usage:",
33873 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33877 "name": "download",
33878 "group": "Voice_Recordings",
33879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33880 "version": "0.0.0",
33881 "filename": "server/api/voiceRecording/index.js",
33882 "groupTitle": "Voice_Recordings"
33886 "url": "/api/voice/recordings/{id}/downloads",
33887 "title": "Download Recording",
33890 "title": "Example usage:",
33891 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33895 "name": "downloads",
33896 "group": "Voice_Recordings",
33897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33898 "version": "0.0.0",
33899 "filename": "server/api/voiceRecording/index.js",
33900 "groupTitle": "Voice_Recordings"
33904 "url": "/api/voice/recordings/{id}/transcribe",
33905 "title": "Run Transcribe Recording",
33908 "title": "Example usage:",
33909 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33913 "name": "transcribe",
33914 "group": "Voice_Recordings",
33915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33916 "version": "0.0.0",
33917 "filename": "server/api/voiceRecording/index.js",
33918 "groupTitle": "Voice_Recordings"
33922 "url": "/api/voice/recordings/{id}/transcribe",
33923 "title": "Run Transcribe Recording",
33926 "title": "Example usage:",
33927 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33931 "name": "transcribe",
33932 "group": "Voice_Recordings",
33933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33934 "version": "0.0.0",
33935 "filename": "server/api/voiceRecording/index.js",
33936 "groupTitle": "Voice_Recordings"
33940 "url": "/api/voice/recordings/{id}",
33941 "title": "Update an existing Recording",
33944 "title": "Example usage:",
33945 "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",
33949 "name": "updateRecordings",
33950 "group": "Voice_Recordings",
33951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33952 "version": "0.0.0",
33953 "filename": "server/api/voiceRecording/index.js",
33954 "groupTitle": "Voice_Recordings"
33958 "url": "/api/voice/transfers/reports",
33959 "title": "Creates a new Transfer Report",
33962 "title": "Example usage:",
33963 "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",
33967 "name": "CreateTransfer_Reports",
33968 "group": "Voice_Transfer_Reports",
33994 "field": "transfererchannel",
34001 "field": "transferercalleridnum",
34008 "field": "transferercalleridname",
34015 "field": "transfererconnectedlinenum",
34022 "field": "transfererconnectedlinename",
34029 "field": "transfereraccountcode",
34036 "field": "transferercontext",
34043 "field": "transfererexten",
34050 "field": "transfererlinkedid",
34057 "field": "transfereechannel",
34064 "field": "transfereecalleridnum",
34071 "field": "transfereecalleridname",
34078 "field": "transfereeconnectedlinenum",
34085 "field": "transfereeconnectedlinename",
34092 "field": "transfereeaccountcode",
34099 "field": "transfereecontext",
34106 "field": "transfereeexten",
34113 "field": "transfereelinkedid",
34124 "field": "isexternal",
34131 "field": "context",
34138 "field": "extension",
34144 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34145 "version": "0.0.0",
34146 "filename": "server/api/voiceTransferReport/index.js",
34147 "groupTitle": "Voice_Transfer_Reports"
34151 "url": "/api/voice/transfers/reports/{id}",
34152 "title": "Deletes a Transfer Report",
34155 "title": "Example usage:",
34156 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34160 "name": "DeleteTransfer_Reports",
34161 "group": "Voice_Transfer_Reports",
34162 "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>",
34163 "version": "0.0.0",
34164 "filename": "server/api/voiceTransferReport/index.js",
34165 "groupTitle": "Voice_Transfer_Reports"
34169 "url": "/api/voice/transfers/reports",
34170 "title": "Gets a list of Transfer Reports",
34173 "title": "Example usage:",
34174 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34178 "name": "GetTransfer_Reports",
34179 "group": "Voice_Transfer_Reports",
34180 "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>",
34181 "version": "0.0.0",
34182 "filename": "server/api/voiceTransferReport/index.js",
34183 "groupTitle": "Voice_Transfer_Reports"
34187 "url": "/api/voice/transfers/reports/{id}",
34188 "title": "Gets a single Transfer Report",
34191 "title": "Example usage:",
34192 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34196 "name": "ShowTransfer_Reports",
34197 "group": "Voice_Transfer_Reports",
34198 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34199 "version": "0.0.0",
34200 "filename": "server/api/voiceTransferReport/index.js",
34201 "groupTitle": "Voice_Transfer_Reports"
34205 "url": "/api/voice/transfers/reports/{id}",
34206 "title": "Update an existing Transfer Report",
34209 "title": "Example usage:",
34210 "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",
34214 "name": "updateTransfer_Reports",
34215 "group": "Voice_Transfer_Reports",
34216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34217 "version": "0.0.0",
34218 "filename": "server/api/voiceTransferReport/index.js",
34219 "groupTitle": "Voice_Transfer_Reports"
34223 "url": "/api/integrations/vtiger/accounts",
34224 "title": "Creates a new Vtiger Account",
34227 "title": "Example usage:",
34228 "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",
34232 "name": "CreateVtiger_Accounts",
34233 "group": "Vtiger_Accounts",
34248 "field": "description",
34255 "field": "username",
34262 "field": "moduleName",
34269 "field": "remoteUri",
34276 "field": "serverUrl",
34283 "field": "accessKey",
34289 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34290 "version": "0.0.0",
34291 "filename": "server/api/intVtigerAccount/index.js",
34292 "groupTitle": "Vtiger_Accounts"
34296 "url": "/api/integrations/vtiger/accounts/{id}",
34297 "title": "Deletes a Vtiger Account",
34300 "title": "Example usage:",
34301 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34305 "name": "DeleteVtiger_Accounts",
34306 "group": "Vtiger_Accounts",
34307 "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>",
34308 "version": "0.0.0",
34309 "filename": "server/api/intVtigerAccount/index.js",
34310 "groupTitle": "Vtiger_Accounts"
34314 "url": "/api/integrations/vtiger/accounts",
34315 "title": "Gets a list of Vtiger Accounts",
34318 "title": "Example usage:",
34319 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34323 "name": "GetVtiger_Accounts",
34324 "group": "Vtiger_Accounts",
34325 "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>",
34326 "version": "0.0.0",
34327 "filename": "server/api/intVtigerAccount/index.js",
34328 "groupTitle": "Vtiger_Accounts"
34332 "url": "/api/integrations/vtiger/accounts/{id}",
34333 "title": "Gets a single Vtiger Account",
34336 "title": "Example usage:",
34337 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34341 "name": "ShowVtiger_Accounts",
34342 "group": "Vtiger_Accounts",
34343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34344 "version": "0.0.0",
34345 "filename": "server/api/intVtigerAccount/index.js",
34346 "groupTitle": "Vtiger_Accounts"
34350 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34351 "title": "Creates new configuration",
34354 "title": "Example usage:",
34355 "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",
34359 "name": "addConfiguration",
34360 "group": "Vtiger_Accounts",
34361 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34362 "version": "0.0.0",
34363 "filename": "server/api/intVtigerAccount/index.js",
34364 "groupTitle": "Vtiger_Accounts"
34368 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34369 "title": "Gets account configurations",
34372 "title": "Example usage:",
34373 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34377 "name": "getConfigurations",
34378 "group": "Vtiger_Accounts",
34379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34380 "version": "0.0.0",
34381 "filename": "server/api/intVtigerAccount/index.js",
34382 "groupTitle": "Vtiger_Accounts"
34386 "url": "/api/integrations/vtiger/accounts/{id}/fields",
34387 "title": "Gets account fields",
34390 "title": "Example usage:",
34391 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34395 "name": "getFields",
34396 "group": "Vtiger_Accounts",
34397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34398 "version": "0.0.0",
34399 "filename": "server/api/intVtigerAccount/index.js",
34400 "groupTitle": "Vtiger_Accounts"
34404 "url": "/api/integrations/vtiger/accounts/{id}",
34405 "title": "Update an existing Vtiger Account",
34408 "title": "Example usage:",
34409 "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",
34413 "name": "updateVtiger_Accounts",
34414 "group": "Vtiger_Accounts",
34415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34416 "version": "0.0.0",
34417 "filename": "server/api/intVtigerAccount/index.js",
34418 "groupTitle": "Vtiger_Accounts"
34422 "url": "/api/integrations/vtiger/configurations",
34423 "title": "Creates a new Vtiger Configuration",
34426 "title": "Example usage:",
34427 "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",
34431 "name": "CreateVtiger_Configurations",
34432 "group": "Vtiger_Configurations",
34447 "field": "description",
34453 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34454 "version": "0.0.0",
34455 "filename": "server/api/intVtigerConfiguration/index.js",
34456 "groupTitle": "Vtiger_Configurations"
34460 "url": "/api/integrations/vtiger/configurations/{id}",
34461 "title": "Deletes a Vtiger Configuration",
34464 "title": "Example usage:",
34465 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34469 "name": "DeleteVtiger_Configurations",
34470 "group": "Vtiger_Configurations",
34471 "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>",
34472 "version": "0.0.0",
34473 "filename": "server/api/intVtigerConfiguration/index.js",
34474 "groupTitle": "Vtiger_Configurations"
34478 "url": "/api/integrations/vtiger/configurations",
34479 "title": "Gets a list of Vtiger Configurations",
34482 "title": "Example usage:",
34483 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34487 "name": "GetVtiger_Configurations",
34488 "group": "Vtiger_Configurations",
34489 "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>",
34490 "version": "0.0.0",
34491 "filename": "server/api/intVtigerConfiguration/index.js",
34492 "groupTitle": "Vtiger_Configurations"
34496 "url": "/api/integrations/vtiger/configurations/{id}",
34497 "title": "Gets a single Vtiger Configuration",
34500 "title": "Example usage:",
34501 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34505 "name": "ShowVtiger_Configurations",
34506 "group": "Vtiger_Configurations",
34507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34508 "version": "0.0.0",
34509 "filename": "server/api/intVtigerConfiguration/index.js",
34510 "groupTitle": "Vtiger_Configurations"
34514 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34515 "title": "Gets configurations descriptions",
34518 "title": "Example usage:",
34519 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34523 "name": "getDescriptions",
34524 "group": "Vtiger_Configurations",
34525 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34526 "version": "0.0.0",
34527 "filename": "server/api/intVtigerConfiguration/index.js",
34528 "groupTitle": "Vtiger_Configurations"
34532 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34533 "title": "Gets configurations fields",
34536 "title": "Example usage:",
34537 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34541 "name": "getFields",
34542 "group": "Vtiger_Configurations",
34543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34544 "version": "0.0.0",
34545 "filename": "server/api/intVtigerConfiguration/index.js",
34546 "groupTitle": "Vtiger_Configurations"
34550 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34551 "title": "Gets configurations subjects",
34554 "title": "Example usage:",
34555 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34559 "name": "getSubjects",
34560 "group": "Vtiger_Configurations",
34561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34562 "version": "0.0.0",
34563 "filename": "server/api/intVtigerConfiguration/index.js",
34564 "groupTitle": "Vtiger_Configurations"
34568 "url": "/api/integrations/vtiger/configurations/{id}",
34569 "title": "Update an existing Vtiger Configuration",
34572 "title": "Example usage:",
34573 "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",
34577 "name": "updateVtiger_Configurations",
34578 "group": "Vtiger_Configurations",
34579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34580 "version": "0.0.0",
34581 "filename": "server/api/intVtigerConfiguration/index.js",
34582 "groupTitle": "Vtiger_Configurations"
34586 "url": "/api/integrations/vtiger/fields",
34587 "title": "Creates a new Vtiger Field",
34590 "title": "Example usage:",
34591 "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",
34595 "name": "CreateVtiger_Fields",
34596 "group": "Vtiger_Fields",
34606 "\"customVariable\"",
34617 "field": "content",
34633 "\"customVariable\""
34636 "field": "keyType",
34643 "field": "keyContent",
34650 "field": "idField",
34657 "field": "nameField",
34664 "field": "customField",
34671 "field": "variableName",
34677 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34678 "version": "0.0.0",
34679 "filename": "server/api/intVtigerField/index.js",
34680 "groupTitle": "Vtiger_Fields"
34684 "url": "/api/integrations/vtiger/fields/{id}",
34685 "title": "Deletes a Vtiger Field",
34688 "title": "Example usage:",
34689 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34693 "name": "DeleteVtiger_Fields",
34694 "group": "Vtiger_Fields",
34695 "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>",
34696 "version": "0.0.0",
34697 "filename": "server/api/intVtigerField/index.js",
34698 "groupTitle": "Vtiger_Fields"
34702 "url": "/api/integrations/vtiger/fields",
34703 "title": "Gets a list of Vtiger Fields",
34706 "title": "Example usage:",
34707 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34711 "name": "GetVtiger_Fields",
34712 "group": "Vtiger_Fields",
34713 "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>",
34714 "version": "0.0.0",
34715 "filename": "server/api/intVtigerField/index.js",
34716 "groupTitle": "Vtiger_Fields"
34720 "url": "/api/integrations/vtiger/fields/{id}",
34721 "title": "Gets a single Vtiger Field",
34724 "title": "Example usage:",
34725 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34729 "name": "ShowVtiger_Fields",
34730 "group": "Vtiger_Fields",
34731 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34732 "version": "0.0.0",
34733 "filename": "server/api/intVtigerField/index.js",
34734 "groupTitle": "Vtiger_Fields"
34738 "url": "/api/integrations/vtiger/fields/{id}",
34739 "title": "Update an existing Vtiger Field",
34742 "title": "Example usage:",
34743 "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",
34747 "name": "updateVtiger_Fields",
34748 "group": "Vtiger_Fields",
34749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34750 "version": "0.0.0",
34751 "filename": "server/api/intVtigerField/index.js",
34752 "groupTitle": "Vtiger_Fields"
34756 "url": "/api/webbar/answer",
34757 "title": "answer webrtc call",
34760 "title": "Example usage:",
34761 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34765 "name": "Web_Bar_answer",
34774 "field": "sessionId",
34787 "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>",
34788 "version": "0.0.0",
34789 "filename": "server/api/webbar/index.js",
34790 "groupTitle": "WebBar"
34794 "url": "/api/webbar/calls",
34795 "title": "webrtc call list",
34798 "title": "Example usage:",
34799 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34803 "name": "Web_Bar_calls",
34818 "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>",
34819 "version": "0.0.0",
34820 "filename": "server/api/webbar/index.js",
34821 "groupTitle": "WebBar"
34825 "url": "/api/webbar/hangup",
34826 "title": "hangup webrtc call",
34829 "title": "Example usage:",
34830 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34834 "name": "Web_Bar_hangup",
34843 "field": "sessionId",
34856 "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>",
34857 "version": "0.0.0",
34858 "filename": "server/api/webbar/index.js",
34859 "groupTitle": "WebBar"
34863 "url": "/api/webbar/hold",
34864 "title": "hold webrtc call",
34867 "title": "Example usage:",
34868 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34872 "name": "Web_Bar_hold",
34881 "field": "sessionId",
34894 "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>",
34895 "version": "0.0.0",
34896 "filename": "server/api/webbar/index.js",
34897 "groupTitle": "WebBar"
34901 "url": "/api/webbar/unhold",
34902 "title": "unhold webrtc call",
34905 "title": "Example usage:",
34906 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34910 "name": "Web_Bar_hold",
34919 "field": "sessionId",
34932 "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>",
34933 "version": "0.0.0",
34934 "filename": "server/api/webbar/index.js",
34935 "groupTitle": "WebBar"
34939 "url": "/api/webbar/originate",
34940 "title": "Originate new webrtc call",
34943 "title": "Example usage:",
34944 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34948 "name": "Web_Bar_originate",
34957 "field": "callNumber",
34971 "field": "callerId",
34978 "field": "callbackUrl",
34984 "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>",
34985 "version": "0.0.0",
34986 "filename": "server/api/webbar/index.js",
34987 "groupTitle": "WebBar"
34991 "url": "/api/webbar/transfer",
34992 "title": "blind transfer webrtc call",
34995 "title": "Example usage:",
34996 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35000 "name": "Web_Bar_transfer",
35016 "field": "sessionId",
35023 "field": "transferNumber",
35029 "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>",
35030 "version": "0.0.0",
35031 "filename": "server/api/webbar/index.js",
35032 "groupTitle": "WebBar"
35036 "url": "/api/whatsapp/accounts/{id}/users",
35037 "title": "Add agents to a whatsapp account",
35040 "title": "Example usage:",
35041 "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",
35045 "name": "AddAgents",
35046 "group": "Whatsapp_Accounts",
35047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35048 "version": "0.0.0",
35049 "filename": "server/api/whatsappAccount/index.js",
35050 "groupTitle": "Whatsapp_Accounts"
35054 "url": "/api/whatsapp/accounts",
35055 "title": "Creates a new Account",
35058 "title": "Example usage:",
35059 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35063 "name": "CreateAccounts",
35064 "group": "Whatsapp_Accounts",
35117 "field": "accountSid",
35124 "field": "authToken",
35131 "field": "notificationTemplate",
35138 "field": "notificationSound",
35145 "field": "notificationShake",
35152 "field": "waitForTheAssignedAgent",
35159 "field": "queueTransfer",
35166 "field": "queueTransferTimeout",
35173 "field": "agentTransfer",
35180 "field": "agentTransferTimeout",
35187 "field": "mandatoryDispositionPauseId",
35188 "description": "<p>Status to put when mandatory disposition is enabled</p>"
35194 "field": "mandatoryDisposition",
35195 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35201 "field": "description",
35207 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35208 "version": "0.0.0",
35209 "filename": "server/api/whatsappAccount/index.js",
35210 "groupTitle": "Whatsapp_Accounts"
35214 "url": "/api/whatsapp/accounts/{id}",
35215 "title": "Deletes a Account",
35218 "title": "Example usage:",
35219 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35223 "name": "DeleteAccounts",
35224 "group": "Whatsapp_Accounts",
35225 "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>",
35226 "version": "0.0.0",
35227 "filename": "server/api/whatsappAccount/index.js",
35228 "groupTitle": "Whatsapp_Accounts"
35232 "url": "/api/whatsapp/accounts/describe",
35233 "title": "Gets table info about Accounts",
35236 "title": "Example usage:",
35237 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35241 "name": "DescribeAccounts",
35242 "group": "Whatsapp_Accounts",
35243 "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>",
35244 "version": "0.0.0",
35245 "filename": "server/api/whatsappAccount/index.js",
35246 "groupTitle": "Whatsapp_Accounts"
35250 "url": "/api/whatsapp/accounts",
35251 "title": "Gets a list of Accounts",
35254 "title": "Example usage:",
35255 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35259 "name": "GetAccounts",
35260 "group": "Whatsapp_Accounts",
35261 "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>",
35262 "version": "0.0.0",
35263 "filename": "server/api/whatsappAccount/index.js",
35264 "groupTitle": "Whatsapp_Accounts"
35268 "url": "/api/whatsapp/accounts/{id}/users",
35269 "title": "Gets agents from whatsapp account",
35272 "title": "Example usage:",
35273 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35277 "name": "GetAgents",
35278 "group": "Whatsapp_Accounts",
35279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35280 "version": "0.0.0",
35281 "filename": "server/api/whatsappAccount/index.js",
35282 "groupTitle": "Whatsapp_Accounts"
35286 "url": "/api/whatsapp/accounts/{id}/users",
35287 "title": "Removes agents from a whatsapp account",
35290 "title": "Example usage:",
35291 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35295 "name": "RemoveAgents",
35296 "group": "Whatsapp_Accounts",
35297 "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>",
35298 "version": "0.0.0",
35299 "filename": "server/api/whatsappAccount/index.js",
35300 "groupTitle": "Whatsapp_Accounts"
35304 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35305 "title": "Removes canned answers from account",
35308 "title": "Example usage:",
35309 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35313 "name": "RemoveAnswers",
35314 "group": "Whatsapp_Accounts",
35315 "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>",
35316 "version": "0.0.0",
35317 "filename": "server/api/whatsappAccount/index.js",
35318 "groupTitle": "Whatsapp_Accounts"
35322 "url": "/api/whatsapp/accounts/{id}/dispositions",
35323 "title": "Removes dispositions from account",
35326 "title": "Example usage:",
35327 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35331 "name": "RemoveDispositions",
35332 "group": "Whatsapp_Accounts",
35333 "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>",
35334 "version": "0.0.0",
35335 "filename": "server/api/whatsappAccount/index.js",
35336 "groupTitle": "Whatsapp_Accounts"
35340 "url": "/api/whatsapp/accounts/{id}",
35341 "title": "Gets a single Account",
35344 "title": "Example usage:",
35345 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35349 "name": "ShowAccounts",
35350 "group": "Whatsapp_Accounts",
35351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35352 "version": "0.0.0",
35353 "filename": "server/api/whatsappAccount/index.js",
35354 "groupTitle": "Whatsapp_Accounts"
35358 "url": "/api/whatsapp/messages/{id}/accept",
35359 "title": "Accepts message",
35362 "title": "Example usage:",
35363 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35367 "name": "acceptMessage",
35368 "group": "Whatsapp_Accounts",
35369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35370 "version": "0.0.0",
35371 "filename": "server/api/whatsappMessage/index.js",
35372 "groupTitle": "Whatsapp_Accounts"
35376 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35377 "title": "Creates new canned answer",
35380 "title": "Example usage:",
35381 "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",
35385 "name": "addAnswer",
35386 "group": "Whatsapp_Accounts",
35408 "field": "description",
35421 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35422 "version": "0.0.0",
35423 "filename": "server/api/whatsappAccount/index.js",
35424 "groupTitle": "Whatsapp_Accounts"
35428 "url": "/api/whatsapp/accounts/{id}/applications",
35429 "title": "Creates new applications",
35432 "title": "Example usage:",
35433 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35437 "name": "addApplications",
35438 "group": "Whatsapp_Accounts",
35446 "field": "priority",
35460 "field": "appdata",
35467 "field": "description",
35474 "field": "interval",
35480 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35481 "version": "0.0.0",
35482 "filename": "server/api/whatsappAccount/index.js",
35483 "groupTitle": "Whatsapp_Accounts"
35487 "url": "/api/whatsapp/accounts/{id}/dispositions",
35488 "title": "Creates new disposition",
35491 "title": "Example usage:",
35492 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35496 "name": "addDisposition",
35497 "group": "Whatsapp_Accounts",
35511 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35512 "version": "0.0.0",
35513 "filename": "server/api/whatsappAccount/index.js",
35514 "groupTitle": "Whatsapp_Accounts"
35518 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35519 "title": "Gets account canned answers",
35522 "title": "Example usage:",
35523 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35527 "name": "getAnswers",
35528 "group": "Whatsapp_Accounts",
35529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35530 "version": "0.0.0",
35531 "filename": "server/api/whatsappAccount/index.js",
35532 "groupTitle": "Whatsapp_Accounts"
35536 "url": "/api/whatsapp/accounts/{id}/applications",
35537 "title": "Gets account applications",
35540 "title": "Example usage:",
35541 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35545 "name": "getApplications",
35546 "group": "Whatsapp_Accounts",
35547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35548 "version": "0.0.0",
35549 "filename": "server/api/whatsappAccount/index.js",
35550 "groupTitle": "Whatsapp_Accounts"
35554 "url": "/api/whatsapp/accounts/{id}/dispositions",
35555 "title": "Gets account dispositions",
35558 "title": "Example usage:",
35559 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35563 "name": "getDispositions",
35564 "group": "Whatsapp_Accounts",
35565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35566 "version": "0.0.0",
35567 "filename": "server/api/whatsappAccount/index.js",
35568 "groupTitle": "Whatsapp_Accounts"
35572 "url": "/api/whatsapp/accounts/{id}/notify",
35573 "title": "Notify new message",
35576 "title": "Example usage:",
35577 "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",
35582 "group": "Whatsapp_Accounts",
35583 "description": "<p>Motion 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>",
35584 "version": "0.0.0",
35585 "filename": "server/api/whatsappAccount/index.js",
35586 "groupTitle": "Whatsapp_Accounts"
35590 "url": "/api/whatsapp/messages/{id}/reject",
35591 "title": "Rejects message",
35594 "title": "Example usage:",
35595 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35599 "name": "rejectMessage",
35600 "group": "Whatsapp_Accounts",
35601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35602 "version": "0.0.0",
35603 "filename": "server/api/whatsappMessage/index.js",
35604 "groupTitle": "Whatsapp_Accounts"
35608 "url": "/api/whatsapp/accounts/{id}/send",
35609 "title": "Send new whatsapp message",
35612 "title": "Example usage:",
35613 "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",
35617 "name": "sendWhatsapp",
35618 "group": "Whatsapp_Accounts",
35619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35620 "version": "0.0.0",
35621 "filename": "server/api/whatsappAccount/index.js",
35622 "groupTitle": "Whatsapp_Accounts"
35626 "url": "/api/whatsapp/messages/{id}/status",
35627 "title": "Receive message status",
35630 "title": "Example usage:",
35631 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35635 "name": "statusMessage",
35636 "group": "Whatsapp_Accounts",
35637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35638 "version": "0.0.0",
35639 "filename": "server/api/whatsappMessage/index.js",
35640 "groupTitle": "Whatsapp_Accounts"
35644 "url": "/api/whatsapp/accounts/{id}",
35645 "title": "Update an existing Account",
35648 "title": "Example usage:",
35649 "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",
35653 "name": "updateAccounts",
35654 "group": "Whatsapp_Accounts",
35655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35656 "version": "0.0.0",
35657 "filename": "server/api/whatsappAccount/index.js",
35658 "groupTitle": "Whatsapp_Accounts"
35662 "url": "/api/whatsapp/applications",
35663 "title": "Creates a new Application",
35666 "title": "Example usage:",
35667 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35671 "name": "CreateApplications",
35672 "group": "Whatsapp_Applications",
35680 "field": "priority",
35694 "field": "appdata",
35701 "field": "description",
35708 "field": "interval",
35714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35715 "version": "0.0.0",
35716 "filename": "server/api/whatsappApplication/index.js",
35717 "groupTitle": "Whatsapp_Applications"
35721 "url": "/api/whatsapp/applications/{id}",
35722 "title": "Deletes a Application",
35725 "title": "Example usage:",
35726 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35730 "name": "DeleteApplications",
35731 "group": "Whatsapp_Applications",
35732 "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>",
35733 "version": "0.0.0",
35734 "filename": "server/api/whatsappApplication/index.js",
35735 "groupTitle": "Whatsapp_Applications"
35739 "url": "/api/whatsapp/applications",
35740 "title": "Gets a list of Applications",
35743 "title": "Example usage:",
35744 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35748 "name": "GetApplications",
35749 "group": "Whatsapp_Applications",
35750 "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>",
35751 "version": "0.0.0",
35752 "filename": "server/api/whatsappApplication/index.js",
35753 "groupTitle": "Whatsapp_Applications"
35757 "url": "/api/whatsapp/applications/{id}",
35758 "title": "Gets a single Application",
35761 "title": "Example usage:",
35762 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35766 "name": "ShowApplications",
35767 "group": "Whatsapp_Applications",
35768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35769 "version": "0.0.0",
35770 "filename": "server/api/whatsappApplication/index.js",
35771 "groupTitle": "Whatsapp_Applications"
35775 "url": "/api/whatsapp/applications/{id}",
35776 "title": "Update an existing Application",
35779 "title": "Example usage:",
35780 "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",
35784 "name": "updateApplications",
35785 "group": "Whatsapp_Applications",
35786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35787 "version": "0.0.0",
35788 "filename": "server/api/whatsappApplication/index.js",
35789 "groupTitle": "Whatsapp_Applications"
35793 "url": "/api/whatsapp/interactions/{id}/tags",
35794 "title": "Add tags to the interaction",
35797 "title": "Example usage:",
35798 "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",
35803 "group": "Whatsapp_Interactions",
35804 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35805 "version": "0.0.0",
35806 "filename": "server/api/whatsappInteraction/index.js",
35807 "groupTitle": "Whatsapp_Interactions"
35811 "url": "/api/whatsapp/interactions",
35812 "title": "Creates a new Interaction",
35815 "title": "Example usage:",
35816 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35820 "name": "CreateInteractions",
35821 "group": "Whatsapp_Interactions",
35836 "field": "closedAt",
35843 "field": "disposition",
35864 "field": "read1stAt",
35875 "field": "firstMsgDirection",
35882 "field": "lastMsgAt",
35893 "field": "lastMsgDirection",
35899 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35900 "version": "0.0.0",
35901 "filename": "server/api/whatsappInteraction/index.js",
35902 "groupTitle": "Whatsapp_Interactions"
35906 "url": "/api/whatsapp/interactions/{id}",
35907 "title": "Deletes a Interaction",
35910 "title": "Example usage:",
35911 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35915 "name": "DeleteInteractions",
35916 "group": "Whatsapp_Interactions",
35917 "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>",
35918 "version": "0.0.0",
35919 "filename": "server/api/whatsappInteraction/index.js",
35920 "groupTitle": "Whatsapp_Interactions"
35924 "url": "/api/whatsapp/interactions/describe",
35925 "title": "Gets table info about Interactions",
35928 "title": "Example usage:",
35929 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35933 "name": "DescribeInteractions",
35934 "group": "Whatsapp_Interactions",
35935 "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>",
35936 "version": "0.0.0",
35937 "filename": "server/api/whatsappInteraction/index.js",
35938 "groupTitle": "Whatsapp_Interactions"
35942 "url": "/api/whatsapp/interactions",
35943 "title": "Gets a list of Interactions",
35946 "title": "Example usage:",
35947 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35951 "name": "GetInteractions",
35952 "group": "Whatsapp_Interactions",
35953 "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>",
35954 "version": "0.0.0",
35955 "filename": "server/api/whatsappInteraction/index.js",
35956 "groupTitle": "Whatsapp_Interactions"
35960 "url": "/api/whatsapp/interactions/{id}/tags",
35961 "title": "Removes tags from interaction",
35964 "title": "Example usage:",
35965 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35969 "name": "RemoveTags",
35970 "group": "Whatsapp_Interactions",
35971 "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>",
35972 "version": "0.0.0",
35973 "filename": "server/api/whatsappInteraction/index.js",
35974 "groupTitle": "Whatsapp_Interactions"
35978 "url": "/api/whatsapp/interactions/{id}",
35979 "title": "Gets a single Interaction",
35982 "title": "Example usage:",
35983 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35987 "name": "ShowInteractions",
35988 "group": "Whatsapp_Interactions",
35989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35990 "version": "0.0.0",
35991 "filename": "server/api/whatsappInteraction/index.js",
35992 "groupTitle": "Whatsapp_Interactions"
35996 "url": "/api/whatsapp/interactions/{id}/messages",
35997 "title": "Creates new messages",
36000 "title": "Example usage:",
36001 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36005 "name": "addMessage",
36006 "group": "Whatsapp_Interactions",
36032 "field": "direction",
36039 "field": "messageId",
36066 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36067 "version": "0.0.0",
36068 "filename": "server/api/whatsappInteraction/index.js",
36069 "groupTitle": "Whatsapp_Interactions"
36073 "url": "/api/whatsapp/interactions/{id}/download",
36074 "title": "Gets interaction",
36077 "title": "Example usage:",
36078 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36082 "name": "download",
36083 "group": "Whatsapp_Interactions",
36084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36085 "version": "0.0.0",
36086 "filename": "server/api/whatsappInteraction/index.js",
36087 "groupTitle": "Whatsapp_Interactions"
36091 "url": "/api/whatsapp/interactions/{id}/messages",
36092 "title": "Gets interaction messages",
36095 "title": "Example usage:",
36096 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36100 "name": "getMessages",
36101 "group": "Whatsapp_Interactions",
36102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36103 "version": "0.0.0",
36104 "filename": "server/api/whatsappInteraction/index.js",
36105 "groupTitle": "Whatsapp_Interactions"
36109 "url": "/api/whatsapp/interactions/{id}",
36110 "title": "Update an existing Interaction",
36113 "title": "Example usage:",
36114 "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",
36118 "name": "updateInteractions",
36119 "group": "Whatsapp_Interactions",
36120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36121 "version": "0.0.0",
36122 "filename": "server/api/whatsappInteraction/index.js",
36123 "groupTitle": "Whatsapp_Interactions"
36127 "url": "/api/whatsapp/messages",
36128 "title": "Creates a new Message",
36131 "title": "Example usage:",
36132 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36136 "name": "CreateMessages",
36137 "group": "Whatsapp_Messages",
36163 "field": "direction",
36170 "field": "messageId",
36197 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36198 "version": "0.0.0",
36199 "filename": "server/api/whatsappMessage/index.js",
36200 "groupTitle": "Whatsapp_Messages"
36204 "url": "/api/whatsapp/messages/{id}",
36205 "title": "Deletes a Message",
36208 "title": "Example usage:",
36209 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36213 "name": "DeleteMessages",
36214 "group": "Whatsapp_Messages",
36215 "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>",
36216 "version": "0.0.0",
36217 "filename": "server/api/whatsappMessage/index.js",
36218 "groupTitle": "Whatsapp_Messages"
36222 "url": "/api/whatsapp/messages/describe",
36223 "title": "Gets table info about Messages",
36226 "title": "Example usage:",
36227 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36231 "name": "DescribeMessages",
36232 "group": "Whatsapp_Messages",
36233 "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>",
36234 "version": "0.0.0",
36235 "filename": "server/api/whatsappMessage/index.js",
36236 "groupTitle": "Whatsapp_Messages"
36240 "url": "/api/whatsapp/messages",
36241 "title": "Gets a list of Messages",
36244 "title": "Example usage:",
36245 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36249 "name": "GetMessages",
36250 "group": "Whatsapp_Messages",
36251 "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>",
36252 "version": "0.0.0",
36253 "filename": "server/api/whatsappMessage/index.js",
36254 "groupTitle": "Whatsapp_Messages"
36258 "url": "/api/whatsapp/messages/{id}",
36259 "title": "Gets a single Message",
36262 "title": "Example usage:",
36263 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36267 "name": "ShowMessages",
36268 "group": "Whatsapp_Messages",
36269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36270 "version": "0.0.0",
36271 "filename": "server/api/whatsappMessage/index.js",
36272 "groupTitle": "Whatsapp_Messages"
36276 "url": "/api/whatsapp/messages/{id}",
36277 "title": "Update an existing Message",
36280 "title": "Example usage:",
36281 "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",
36285 "name": "updateMessages",
36286 "group": "Whatsapp_Messages",
36287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36288 "version": "0.0.0",
36289 "filename": "server/api/whatsappMessage/index.js",
36290 "groupTitle": "Whatsapp_Messages"
36294 "url": "/api/whatsapp/reports/queue",
36295 "title": "Creates a new Whatsapp Queue Report",
36298 "title": "Example usage:",
36299 "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",
36303 "name": "CreateWhatsapp_Queue_Reports",
36304 "group": "Whatsapp_Queue_Reports",
36312 "field": "uniqueid",
36333 "field": "leaveAt",
36340 "field": "acceptAt",
36360 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36361 "version": "0.0.0",
36362 "filename": "server/api/whatsappQueueReport/index.js",
36363 "groupTitle": "Whatsapp_Queue_Reports"
36367 "url": "/api/whatsapp/reports/queue/{id}",
36368 "title": "Deletes a Whatsapp Queue Report",
36371 "title": "Example usage:",
36372 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36376 "name": "DeleteWhatsapp_Queue_Reports",
36377 "group": "Whatsapp_Queue_Reports",
36378 "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>",
36379 "version": "0.0.0",
36380 "filename": "server/api/whatsappQueueReport/index.js",
36381 "groupTitle": "Whatsapp_Queue_Reports"
36385 "url": "/api/whatsapp/reports/queue/describe",
36386 "title": "Gets table info about Whatsapp Queue Reports",
36389 "title": "Example usage:",
36390 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36394 "name": "DescribeWhatsapp_Queue_Reports",
36395 "group": "Whatsapp_Queue_Reports",
36396 "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>",
36397 "version": "0.0.0",
36398 "filename": "server/api/whatsappQueueReport/index.js",
36399 "groupTitle": "Whatsapp_Queue_Reports"
36403 "url": "/api/whatsapp/reports/queue",
36404 "title": "Gets a list of Whatsapp Queue Reports",
36407 "title": "Example usage:",
36408 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36412 "name": "GetWhatsapp_Queue_Reports",
36413 "group": "Whatsapp_Queue_Reports",
36414 "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>",
36415 "version": "0.0.0",
36416 "filename": "server/api/whatsappQueueReport/index.js",
36417 "groupTitle": "Whatsapp_Queue_Reports"
36421 "url": "/api/whatsapp/reports/queue/{id}",
36422 "title": "Gets a single Whatsapp Queue Report",
36425 "title": "Example usage:",
36426 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36430 "name": "ShowWhatsapp_Queue_Reports",
36431 "group": "Whatsapp_Queue_Reports",
36432 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36433 "version": "0.0.0",
36434 "filename": "server/api/whatsappQueueReport/index.js",
36435 "groupTitle": "Whatsapp_Queue_Reports"
36439 "url": "/api/whatsapp/reports/queue/{id}",
36440 "title": "Update an existing Whatsapp Queue Report",
36443 "title": "Example usage:",
36444 "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",
36448 "name": "updateWhatsapp_Queue_Reports",
36449 "group": "Whatsapp_Queue_Reports",
36450 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36451 "version": "0.0.0",
36452 "filename": "server/api/whatsappQueueReport/index.js",
36453 "groupTitle": "Whatsapp_Queue_Reports"
36457 "url": "/api/whatsapp/queues/{id}/users",
36458 "title": "Add agents to a queue",
36461 "title": "Example usage:",
36462 "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",
36466 "name": "AddAgents",
36467 "group": "Whatsapp_Queues",
36468 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36469 "version": "0.0.0",
36470 "filename": "server/api/whatsappQueue/index.js",
36471 "groupTitle": "Whatsapp_Queues"
36475 "url": "/api/whatsapp/queues/{id}/teams",
36476 "title": "Add teams to a queue",
36479 "title": "Example usage:",
36480 "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",
36484 "name": "AddTeams",
36485 "group": "Whatsapp_Queues",
36486 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36487 "version": "0.0.0",
36488 "filename": "server/api/whatsappQueue/index.js",
36489 "groupTitle": "Whatsapp_Queues"
36493 "url": "/api/whatsapp/queues",
36494 "title": "Creates a new Queue",
36497 "title": "Example usage:",
36498 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36502 "name": "CreateQueues",
36503 "group": "Whatsapp_Queues",
36518 "field": "timeout",
36530 "field": "strategy",
36537 "field": "description",
36543 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36544 "version": "0.0.0",
36545 "filename": "server/api/whatsappQueue/index.js",
36546 "groupTitle": "Whatsapp_Queues"
36550 "url": "/api/whatsapp/queues/{id}",
36551 "title": "Deletes a Queue",
36554 "title": "Example usage:",
36555 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36559 "name": "DeleteQueues",
36560 "group": "Whatsapp_Queues",
36561 "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>",
36562 "version": "0.0.0",
36563 "filename": "server/api/whatsappQueue/index.js",
36564 "groupTitle": "Whatsapp_Queues"
36568 "url": "/api/whatsapp/queues/describe",
36569 "title": "Gets table info about Queues",
36572 "title": "Example usage:",
36573 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36577 "name": "DescribeQueues",
36578 "group": "Whatsapp_Queues",
36579 "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>",
36580 "version": "0.0.0",
36581 "filename": "server/api/whatsappQueue/index.js",
36582 "groupTitle": "Whatsapp_Queues"
36586 "url": "/api/whatsapp/queues/{id}/users",
36587 "title": "Gets queue agents",
36590 "title": "Example usage:",
36591 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36595 "name": "GetAgents",
36596 "group": "Whatsapp_Queues",
36597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36598 "version": "0.0.0",
36599 "filename": "server/api/whatsappQueue/index.js",
36600 "groupTitle": "Whatsapp_Queues"
36604 "url": "/api/whatsapp/queues/{id}/members",
36605 "title": "GetMembers",
36608 "title": "Example usage:",
36609 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36613 "name": "GetMembers",
36614 "group": "Whatsapp_Queues",
36615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36616 "version": "0.0.0",
36617 "filename": "server/api/whatsappQueue/index.js",
36618 "groupTitle": "Whatsapp_Queues"
36622 "url": "/api/whatsapp/queues",
36623 "title": "Gets a list of Queues",
36626 "title": "Example usage:",
36627 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36631 "name": "GetQueues",
36632 "group": "Whatsapp_Queues",
36633 "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>",
36634 "version": "0.0.0",
36635 "filename": "server/api/whatsappQueue/index.js",
36636 "groupTitle": "Whatsapp_Queues"
36640 "url": "/api/whatsapp/queues/{id}/teams",
36641 "title": "Gets queues list",
36644 "title": "Example usage:",
36645 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36649 "name": "GetTeams",
36650 "group": "Whatsapp_Queues",
36651 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36652 "version": "0.0.0",
36653 "filename": "server/api/whatsappQueue/index.js",
36654 "groupTitle": "Whatsapp_Queues"
36658 "url": "/api/whatsapp/queues/{id}/users",
36659 "title": "Removes agents from a queue",
36662 "title": "Example usage:",
36663 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36667 "name": "RemoveAgents",
36668 "group": "Whatsapp_Queues",
36669 "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>",
36670 "version": "0.0.0",
36671 "filename": "server/api/whatsappQueue/index.js",
36672 "groupTitle": "Whatsapp_Queues"
36676 "url": "/api/whatsapp/queues/{id}",
36677 "title": "Gets a single Queue",
36680 "title": "Example usage:",
36681 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36685 "name": "ShowQueues",
36686 "group": "Whatsapp_Queues",
36687 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36688 "version": "0.0.0",
36689 "filename": "server/api/whatsappQueue/index.js",
36690 "groupTitle": "Whatsapp_Queues"
36694 "url": "/api/whatsapp/queues/{id}",
36695 "title": "Update an existing Queue",
36698 "title": "Example usage:",
36699 "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",
36703 "name": "updateQueues",
36704 "group": "Whatsapp_Queues",
36705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36706 "version": "0.0.0",
36707 "filename": "server/api/whatsappQueue/index.js",
36708 "groupTitle": "Whatsapp_Queues"
36712 "url": "/api/whatsapp/reports/transfer",
36713 "title": "Creates a new Whatsapp Transfer Report",
36716 "title": "Example usage:",
36717 "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",
36721 "name": "CreateWhatsapp_Transfer_Reports",
36722 "group": "Whatsapp_Transfer_Reports",
36730 "field": "uniqueid",
36749 "field": "transferredAt",
36755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36756 "version": "0.0.0",
36757 "filename": "server/api/whatsappTransferReport/index.js",
36758 "groupTitle": "Whatsapp_Transfer_Reports"
36762 "url": "/api/whatsapp/reports/transfer/{id}",
36763 "title": "Deletes a Whatsapp Transfer Report",
36766 "title": "Example usage:",
36767 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36771 "name": "DeleteWhatsapp_Transfer_Reports",
36772 "group": "Whatsapp_Transfer_Reports",
36773 "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>",
36774 "version": "0.0.0",
36775 "filename": "server/api/whatsappTransferReport/index.js",
36776 "groupTitle": "Whatsapp_Transfer_Reports"
36780 "url": "/api/whatsapp/reports/transfer/describe",
36781 "title": "Gets table info about Whatsapp Transfer Reports",
36784 "title": "Example usage:",
36785 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36789 "name": "DescribeWhatsapp_Transfer_Reports",
36790 "group": "Whatsapp_Transfer_Reports",
36791 "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>",
36792 "version": "0.0.0",
36793 "filename": "server/api/whatsappTransferReport/index.js",
36794 "groupTitle": "Whatsapp_Transfer_Reports"
36798 "url": "/api/whatsapp/reports/transfer",
36799 "title": "Gets a list of Whatsapp Transfer Reports",
36802 "title": "Example usage:",
36803 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36807 "name": "GetWhatsapp_Transfer_Reports",
36808 "group": "Whatsapp_Transfer_Reports",
36809 "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>",
36810 "version": "0.0.0",
36811 "filename": "server/api/whatsappTransferReport/index.js",
36812 "groupTitle": "Whatsapp_Transfer_Reports"
36816 "url": "/api/whatsapp/reports/transfer/{id}",
36817 "title": "Gets a single Whatsapp Transfer Report",
36820 "title": "Example usage:",
36821 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36825 "name": "ShowWhatsapp_Transfer_Reports",
36826 "group": "Whatsapp_Transfer_Reports",
36827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36828 "version": "0.0.0",
36829 "filename": "server/api/whatsappTransferReport/index.js",
36830 "groupTitle": "Whatsapp_Transfer_Reports"
36834 "url": "/api/whatsapp/reports/transfer/{id}",
36835 "title": "Update an existing Whatsapp Transfer Report",
36838 "title": "Example usage:",
36839 "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",
36843 "name": "updateWhatsapp_Transfer_Reports",
36844 "group": "Whatsapp_Transfer_Reports",
36845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36846 "version": "0.0.0",
36847 "filename": "server/api/whatsappTransferReport/index.js",
36848 "groupTitle": "Whatsapp_Transfer_Reports"
36852 "url": "/api/integrations/zendesk/accounts",
36853 "title": "Creates a new Zendesk Account",
36856 "title": "Example usage:",
36857 "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",
36861 "name": "CreateZendesk_Accounts",
36862 "group": "Zendesk_Accounts",
36877 "field": "description",
36884 "field": "username",
36891 "field": "password",
36905 "field": "remoteUri",
36916 "field": "authType",
36923 "field": "serverUrl",
36930 "\"integrationTab\"",
36940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36941 "version": "0.0.0",
36942 "filename": "server/api/intZendeskAccount/index.js",
36943 "groupTitle": "Zendesk_Accounts"
36947 "url": "/api/integrations/zendesk/accounts/{id}",
36948 "title": "Deletes a Zendesk Account",
36951 "title": "Example usage:",
36952 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36956 "name": "DeleteZendesk_Accounts",
36957 "group": "Zendesk_Accounts",
36958 "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>",
36959 "version": "0.0.0",
36960 "filename": "server/api/intZendeskAccount/index.js",
36961 "groupTitle": "Zendesk_Accounts"
36965 "url": "/api/integrations/zendesk/accounts",
36966 "title": "Gets a list of Zendesk Accounts",
36969 "title": "Example usage:",
36970 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36974 "name": "GetZendesk_Accounts",
36975 "group": "Zendesk_Accounts",
36976 "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>",
36977 "version": "0.0.0",
36978 "filename": "server/api/intZendeskAccount/index.js",
36979 "groupTitle": "Zendesk_Accounts"
36983 "url": "/api/integrations/zendesk/accounts/{id}",
36984 "title": "Gets a single Zendesk Account",
36987 "title": "Example usage:",
36988 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36992 "name": "ShowZendesk_Accounts",
36993 "group": "Zendesk_Accounts",
36994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36995 "version": "0.0.0",
36996 "filename": "server/api/intZendeskAccount/index.js",
36997 "groupTitle": "Zendesk_Accounts"
37001 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37002 "title": "Creates new configuration",
37005 "title": "Example usage:",
37006 "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",
37010 "name": "addConfiguration",
37011 "group": "Zendesk_Accounts",
37012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37013 "version": "0.0.0",
37014 "filename": "server/api/intZendeskAccount/index.js",
37015 "groupTitle": "Zendesk_Accounts"
37019 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37020 "title": "Gets account configurations",
37023 "title": "Example usage:",
37024 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37028 "name": "getConfigurations",
37029 "group": "Zendesk_Accounts",
37030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37031 "version": "0.0.0",
37032 "filename": "server/api/intZendeskAccount/index.js",
37033 "groupTitle": "Zendesk_Accounts"
37037 "url": "/api/integrations/zendesk/accounts/{id}/fields",
37038 "title": "Gets account fields",
37041 "title": "Example usage:",
37042 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37046 "name": "getFields",
37047 "group": "Zendesk_Accounts",
37048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37049 "version": "0.0.0",
37050 "filename": "server/api/intZendeskAccount/index.js",
37051 "groupTitle": "Zendesk_Accounts"
37055 "url": "/api/integrations/zendesk/accounts/{id}",
37056 "title": "Update an existing Zendesk Account",
37059 "title": "Example usage:",
37060 "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",
37064 "name": "updateZendesk_Accounts",
37065 "group": "Zendesk_Accounts",
37066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37067 "version": "0.0.0",
37068 "filename": "server/api/intZendeskAccount/index.js",
37069 "groupTitle": "Zendesk_Accounts"
37073 "url": "/api/integrations/zendesk/configurations",
37074 "title": "Creates a new Zendesk Configuration",
37077 "title": "Example usage:",
37078 "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",
37082 "name": "CreateZendesk_Configurations",
37083 "group": "Zendesk_Configurations",
37098 "field": "description",
37104 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37105 "version": "0.0.0",
37106 "filename": "server/api/intZendeskConfiguration/index.js",
37107 "groupTitle": "Zendesk_Configurations"
37111 "url": "/api/integrations/zendesk/configurations/{id}",
37112 "title": "Deletes a Zendesk Configuration",
37115 "title": "Example usage:",
37116 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37120 "name": "DeleteZendesk_Configurations",
37121 "group": "Zendesk_Configurations",
37122 "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>",
37123 "version": "0.0.0",
37124 "filename": "server/api/intZendeskConfiguration/index.js",
37125 "groupTitle": "Zendesk_Configurations"
37129 "url": "/api/integrations/zendesk/configurations",
37130 "title": "Gets a list of Zendesk Configurations",
37133 "title": "Example usage:",
37134 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37138 "name": "GetZendesk_Configurations",
37139 "group": "Zendesk_Configurations",
37140 "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>",
37141 "version": "0.0.0",
37142 "filename": "server/api/intZendeskConfiguration/index.js",
37143 "groupTitle": "Zendesk_Configurations"
37147 "url": "/api/integrations/zendesk/configurations/{id}",
37148 "title": "Gets a single Zendesk Configuration",
37151 "title": "Example usage:",
37152 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37156 "name": "ShowZendesk_Configurations",
37157 "group": "Zendesk_Configurations",
37158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37159 "version": "0.0.0",
37160 "filename": "server/api/intZendeskConfiguration/index.js",
37161 "groupTitle": "Zendesk_Configurations"
37165 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37166 "title": "Gets configurations descriptions",
37169 "title": "Example usage:",
37170 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37174 "name": "getDescriptions",
37175 "group": "Zendesk_Configurations",
37176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37177 "version": "0.0.0",
37178 "filename": "server/api/intZendeskConfiguration/index.js",
37179 "groupTitle": "Zendesk_Configurations"
37183 "url": "/api/integrations/zendesk/configurations/{id}/fields",
37184 "title": "Gets configurations fields",
37187 "title": "Example usage:",
37188 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37192 "name": "getFields",
37193 "group": "Zendesk_Configurations",
37194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37195 "version": "0.0.0",
37196 "filename": "server/api/intZendeskConfiguration/index.js",
37197 "groupTitle": "Zendesk_Configurations"
37201 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37202 "title": "Gets configurations subjects",
37205 "title": "Example usage:",
37206 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37210 "name": "getSubjects",
37211 "group": "Zendesk_Configurations",
37212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37213 "version": "0.0.0",
37214 "filename": "server/api/intZendeskConfiguration/index.js",
37215 "groupTitle": "Zendesk_Configurations"
37219 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37220 "title": "Gets configurations tags",
37223 "title": "Example usage:",
37224 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37229 "group": "Zendesk_Configurations",
37230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37231 "version": "0.0.0",
37232 "filename": "server/api/intZendeskConfiguration/index.js",
37233 "groupTitle": "Zendesk_Configurations"
37237 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37238 "title": "Sets new tags",
37241 "title": "Example usage:",
37242 "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",
37247 "group": "Zendesk_Configurations",
37248 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37249 "version": "0.0.0",
37250 "filename": "server/api/intZendeskConfiguration/index.js",
37251 "groupTitle": "Zendesk_Configurations"
37255 "url": "/api/integrations/zendesk/configurations/{id}",
37256 "title": "Update an existing Zendesk Configuration",
37259 "title": "Example usage:",
37260 "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",
37264 "name": "updateZendesk_Configurations",
37265 "group": "Zendesk_Configurations",
37266 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37267 "version": "0.0.0",
37268 "filename": "server/api/intZendeskConfiguration/index.js",
37269 "groupTitle": "Zendesk_Configurations"
37273 "url": "/api/integrations/zendesk/fields",
37274 "title": "Creates a new Zendesk Field",
37277 "title": "Example usage:",
37278 "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",
37282 "name": "CreateZendesk_Fields",
37283 "group": "Zendesk_Fields",
37293 "\"customVariable\"",
37304 "field": "content",
37320 "\"customVariable\""
37323 "field": "keyType",
37330 "field": "keyContent",
37337 "field": "idField",
37344 "field": "nameField",
37351 "field": "customField",
37358 "field": "variableName",
37364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37365 "version": "0.0.0",
37366 "filename": "server/api/intZendeskField/index.js",
37367 "groupTitle": "Zendesk_Fields"
37371 "url": "/api/integrations/zendesk/fields/{id}",
37372 "title": "Deletes a Zendesk Field",
37375 "title": "Example usage:",
37376 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37380 "name": "DeleteZendesk_Fields",
37381 "group": "Zendesk_Fields",
37382 "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>",
37383 "version": "0.0.0",
37384 "filename": "server/api/intZendeskField/index.js",
37385 "groupTitle": "Zendesk_Fields"
37389 "url": "/api/integrations/zendesk/fields",
37390 "title": "Gets a list of Zendesk Fields",
37393 "title": "Example usage:",
37394 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37398 "name": "GetZendesk_Fields",
37399 "group": "Zendesk_Fields",
37400 "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>",
37401 "version": "0.0.0",
37402 "filename": "server/api/intZendeskField/index.js",
37403 "groupTitle": "Zendesk_Fields"
37407 "url": "/api/integrations/zendesk/fields/{id}",
37408 "title": "Gets a single Zendesk Field",
37411 "title": "Example usage:",
37412 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37416 "name": "ShowZendesk_Fields",
37417 "group": "Zendesk_Fields",
37418 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37419 "version": "0.0.0",
37420 "filename": "server/api/intZendeskField/index.js",
37421 "groupTitle": "Zendesk_Fields"
37425 "url": "/api/integrations/zendesk/fields/{id}",
37426 "title": "Update an existing Zendesk Field",
37429 "title": "Example usage:",
37430 "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",
37434 "name": "updateZendesk_Fields",
37435 "group": "Zendesk_Fields",
37436 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37437 "version": "0.0.0",
37438 "filename": "server/api/intZendeskField/index.js",
37439 "groupTitle": "Zendesk_Fields"
37443 "url": "/api/integrations/zoho/accounts",
37444 "title": "Creates a new Zoho Account",
37447 "title": "Example usage:",
37448 "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",
37452 "name": "CreateZoho_Accounts",
37453 "group": "Zoho_Accounts",
37468 "field": "description",
37489 "field": "clientId",
37496 "field": "clientSecret",
37503 "field": "serverUrl",
37517 "field": "refreshToken",
37523 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37524 "version": "0.0.0",
37525 "filename": "server/api/intZohoAccount/index.js",
37526 "groupTitle": "Zoho_Accounts"
37530 "url": "/api/integrations/zoho/accounts/{id}",
37531 "title": "Deletes a Zoho Account",
37534 "title": "Example usage:",
37535 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37539 "name": "DeleteZoho_Accounts",
37540 "group": "Zoho_Accounts",
37541 "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>",
37542 "version": "0.0.0",
37543 "filename": "server/api/intZohoAccount/index.js",
37544 "groupTitle": "Zoho_Accounts"
37548 "url": "/api/integrations/zoho/accounts",
37549 "title": "Gets a list of Zoho Accounts",
37552 "title": "Example usage:",
37553 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37557 "name": "GetZoho_Accounts",
37558 "group": "Zoho_Accounts",
37559 "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>",
37560 "version": "0.0.0",
37561 "filename": "server/api/intZohoAccount/index.js",
37562 "groupTitle": "Zoho_Accounts"
37566 "url": "/api/integrations/zoho/accounts/{id}",
37567 "title": "Gets a single Zoho Account",
37570 "title": "Example usage:",
37571 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37575 "name": "ShowZoho_Accounts",
37576 "group": "Zoho_Accounts",
37577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37578 "version": "0.0.0",
37579 "filename": "server/api/intZohoAccount/index.js",
37580 "groupTitle": "Zoho_Accounts"
37584 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37585 "title": "Creates new configuration",
37588 "title": "Example usage:",
37589 "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",
37593 "name": "addConfiguration",
37594 "group": "Zoho_Accounts",
37595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37596 "version": "0.0.0",
37597 "filename": "server/api/intZohoAccount/index.js",
37598 "groupTitle": "Zoho_Accounts"
37602 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37603 "title": "Gets account configurations",
37606 "title": "Example usage:",
37607 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37611 "name": "getConfigurations",
37612 "group": "Zoho_Accounts",
37613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37614 "version": "0.0.0",
37615 "filename": "server/api/intZohoAccount/index.js",
37616 "groupTitle": "Zoho_Accounts"
37620 "url": "/api/integrations/zoho/accounts/{id}/fields",
37621 "title": "Gets account fields",
37624 "title": "Example usage:",
37625 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37629 "name": "getFields",
37630 "group": "Zoho_Accounts",
37631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37632 "version": "0.0.0",
37633 "filename": "server/api/intZohoAccount/index.js",
37634 "groupTitle": "Zoho_Accounts"
37638 "url": "/api/integrations/zoho/accounts/{id}",
37639 "title": "Update an existing Zoho Account",
37642 "title": "Example usage:",
37643 "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",
37647 "name": "updateZoho_Accounts",
37648 "group": "Zoho_Accounts",
37649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37650 "version": "0.0.0",
37651 "filename": "server/api/intZohoAccount/index.js",
37652 "groupTitle": "Zoho_Accounts"
37656 "url": "/api/integrations/zoho/configurations",
37657 "title": "Creates a new Zoho Configuration",
37660 "title": "Example usage:",
37661 "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",
37665 "name": "CreateZoho_Configurations",
37666 "group": "Zoho_Configurations",
37686 "field": "moduleCreate",
37693 "\"contact_lead\"",
37698 "field": "moduleSearch",
37705 "field": "description",
37711 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37712 "version": "0.0.0",
37713 "filename": "server/api/intZohoConfiguration/index.js",
37714 "groupTitle": "Zoho_Configurations"
37718 "url": "/api/integrations/zoho/configurations/{id}",
37719 "title": "Deletes a Zoho Configuration",
37722 "title": "Example usage:",
37723 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37727 "name": "DeleteZoho_Configurations",
37728 "group": "Zoho_Configurations",
37729 "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>",
37730 "version": "0.0.0",
37731 "filename": "server/api/intZohoConfiguration/index.js",
37732 "groupTitle": "Zoho_Configurations"
37736 "url": "/api/integrations/zoho/configurations",
37737 "title": "Gets a list of Zoho Configurations",
37740 "title": "Example usage:",
37741 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37745 "name": "GetZoho_Configurations",
37746 "group": "Zoho_Configurations",
37747 "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>",
37748 "version": "0.0.0",
37749 "filename": "server/api/intZohoConfiguration/index.js",
37750 "groupTitle": "Zoho_Configurations"
37754 "url": "/api/integrations/zoho/configurations/{id}",
37755 "title": "Gets a single Zoho Configuration",
37758 "title": "Example usage:",
37759 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37763 "name": "ShowZoho_Configurations",
37764 "group": "Zoho_Configurations",
37765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37766 "version": "0.0.0",
37767 "filename": "server/api/intZohoConfiguration/index.js",
37768 "groupTitle": "Zoho_Configurations"
37772 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37773 "title": "Gets configurations descriptions",
37776 "title": "Example usage:",
37777 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37781 "name": "getDescriptions",
37782 "group": "Zoho_Configurations",
37783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37784 "version": "0.0.0",
37785 "filename": "server/api/intZohoConfiguration/index.js",
37786 "groupTitle": "Zoho_Configurations"
37790 "url": "/api/integrations/zoho/configurations/{id}/fields",
37791 "title": "Gets configurations fields",
37794 "title": "Example usage:",
37795 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37799 "name": "getFields",
37800 "group": "Zoho_Configurations",
37801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37802 "version": "0.0.0",
37803 "filename": "server/api/intZohoConfiguration/index.js",
37804 "groupTitle": "Zoho_Configurations"
37808 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37809 "title": "Gets configurations subjects",
37812 "title": "Example usage:",
37813 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37817 "name": "getSubjects",
37818 "group": "Zoho_Configurations",
37819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37820 "version": "0.0.0",
37821 "filename": "server/api/intZohoConfiguration/index.js",
37822 "groupTitle": "Zoho_Configurations"
37826 "url": "/api/integrations/zoho/configurations/{id}",
37827 "title": "Update an existing Zoho Configuration",
37830 "title": "Example usage:",
37831 "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",
37835 "name": "updateZoho_Configurations",
37836 "group": "Zoho_Configurations",
37837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37838 "version": "0.0.0",
37839 "filename": "server/api/intZohoConfiguration/index.js",
37840 "groupTitle": "Zoho_Configurations"
37844 "url": "/api/integrations/zoho/fields",
37845 "title": "Creates a new Zoho Field",
37848 "title": "Example usage:",
37849 "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",
37853 "name": "CreateZoho_Fields",
37854 "group": "Zoho_Fields",
37864 "\"customVariable\"",
37875 "field": "content",
37891 "\"customVariable\""
37894 "field": "keyType",
37901 "field": "keyContent",
37908 "field": "idField",
37915 "field": "nameField",
37922 "field": "customField",
37929 "field": "variableName",
37935 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37936 "version": "0.0.0",
37937 "filename": "server/api/intZohoField/index.js",
37938 "groupTitle": "Zoho_Fields"
37942 "url": "/api/integrations/zoho/fields/{id}",
37943 "title": "Deletes a Zoho Field",
37946 "title": "Example usage:",
37947 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37951 "name": "DeleteZoho_Fields",
37952 "group": "Zoho_Fields",
37953 "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>",
37954 "version": "0.0.0",
37955 "filename": "server/api/intZohoField/index.js",
37956 "groupTitle": "Zoho_Fields"
37960 "url": "/api/integrations/zoho/fields",
37961 "title": "Gets a list of Zoho Fields",
37964 "title": "Example usage:",
37965 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37969 "name": "GetZoho_Fields",
37970 "group": "Zoho_Fields",
37971 "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>",
37972 "version": "0.0.0",
37973 "filename": "server/api/intZohoField/index.js",
37974 "groupTitle": "Zoho_Fields"
37978 "url": "/api/integrations/zoho/fields/{id}",
37979 "title": "Gets a single Zoho Field",
37982 "title": "Example usage:",
37983 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37987 "name": "ShowZoho_Fields",
37988 "group": "Zoho_Fields",
37989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37990 "version": "0.0.0",
37991 "filename": "server/api/intZohoField/index.js",
37992 "groupTitle": "Zoho_Fields"
37996 "url": "/api/integrations/zoho/fields/{id}",
37997 "title": "Update an existing Zoho Field",
38000 "title": "Example usage:",
38001 "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",
38005 "name": "updateZoho_Fields",
38006 "group": "Zoho_Fields",
38007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38008 "version": "0.0.0",
38009 "filename": "server/api/intZohoField/index.js",
38010 "groupTitle": "Zoho_Fields"
38015 "title": "Creates a new Cdr",
38018 "title": "Example usage:",
38019 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38023 "name": "CreateCdrs",
38032 "field": "calldate",
38060 "field": "dcontext",
38067 "field": "channel",
38074 "field": "dstchannel",
38081 "field": "lastapp",
38088 "field": "lastdata",
38095 "field": "duration",
38102 "field": "billsec",
38109 "field": "disposition",
38116 "field": "amaflags",
38123 "field": "accountcode",
38130 "field": "userfield",
38137 "field": "uniqueid",
38144 "field": "linkedid",
38151 "field": "sequence",
38158 "field": "peeraccount",
38178 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38179 "version": "0.0.0",
38180 "filename": "server/api/cdr/index.js",
38181 "groupTitle": "cdr"
38185 "url": "/api/cdr/{id}",
38186 "title": "Deletes a Cdr",
38189 "title": "Example usage:",
38190 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38194 "name": "DeleteCdrs",
38196 "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>",
38197 "version": "0.0.0",
38198 "filename": "server/api/cdr/index.js",
38199 "groupTitle": "cdr"
38203 "url": "/api/cdr/describe",
38204 "title": "Gets table info about Cdrs",
38207 "title": "Example usage:",
38208 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38212 "name": "DescribeCdrs",
38214 "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>",
38215 "version": "0.0.0",
38216 "filename": "server/api/cdr/index.js",
38217 "groupTitle": "cdr"
38222 "title": "Gets a list of Cdrs",
38225 "title": "Example usage:",
38226 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38232 "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>",
38233 "version": "0.0.0",
38234 "filename": "server/api/cdr/index.js",
38235 "groupTitle": "cdr"
38239 "url": "/api/cdr/{id}",
38240 "title": "Gets a single Cdr",
38243 "title": "Example usage:",
38244 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38248 "name": "ShowCdrs",
38250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38251 "version": "0.0.0",
38252 "filename": "server/api/cdr/index.js",
38253 "groupTitle": "cdr"
38257 "url": "/api/cdr/{id}",
38258 "title": "Update an existing Cdr",
38261 "title": "Example usage:",
38262 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38266 "name": "updateCdrs",
38268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38269 "version": "0.0.0",
38270 "filename": "server/api/cdr/index.js",
38271 "groupTitle": "cdr"
38275 "url": "/api/voiceQueuesLog",
38276 "title": "Creates a new VoiceQueuesLog",
38279 "title": "Example usage:",
38280 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38284 "name": "CreateVoiceQueuesLogs",
38285 "group": "voiceQueuesLog",
38307 "field": "queuename",
38376 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38377 "version": "0.0.0",
38378 "filename": "server/api/voiceQueuesLog/index.js",
38379 "groupTitle": "voiceQueuesLog"
38383 "url": "/api/voiceQueuesLog/{id}",
38384 "title": "Deletes a VoiceQueuesLog",
38387 "title": "Example usage:",
38388 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38392 "name": "DeleteVoiceQueuesLogs",
38393 "group": "voiceQueuesLog",
38394 "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>",
38395 "version": "0.0.0",
38396 "filename": "server/api/voiceQueuesLog/index.js",
38397 "groupTitle": "voiceQueuesLog"
38401 "url": "/api/voiceQueuesLog",
38402 "title": "Gets a list of VoiceQueuesLogs",
38405 "title": "Example usage:",
38406 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38410 "name": "GetVoiceQueuesLogs",
38411 "group": "voiceQueuesLog",
38412 "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>",
38413 "version": "0.0.0",
38414 "filename": "server/api/voiceQueuesLog/index.js",
38415 "groupTitle": "voiceQueuesLog"
38419 "url": "/api/voiceQueuesLog/{id}",
38420 "title": "Gets a single VoiceQueuesLog",
38423 "title": "Example usage:",
38424 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38428 "name": "ShowVoiceQueuesLogs",
38429 "group": "voiceQueuesLog",
38430 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38431 "version": "0.0.0",
38432 "filename": "server/api/voiceQueuesLog/index.js",
38433 "groupTitle": "voiceQueuesLog"
38437 "url": "/api/voiceQueuesLog/{id}",
38438 "title": "Update an existing VoiceQueuesLog",
38441 "title": "Example usage:",
38442 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38446 "name": "updateVoiceQueuesLogs",
38447 "group": "voiceQueuesLog",
38448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38449 "version": "0.0.0",
38450 "filename": "server/api/voiceQueuesLog/index.js",
38451 "groupTitle": "voiceQueuesLog"