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/local",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/local -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/authLocal/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/google",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/google -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/authGoogle/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",
2187 "field": "secondDisposition",
2194 "field": "thirdDisposition",
2208 "field": "browserName",
2215 "field": "browserVersion",
2229 "field": "osVersion",
2236 "field": "deviceModel",
2243 "field": "deviceVendor",
2250 "field": "deviceType",
2264 "field": "customerIp",
2271 "field": "formData",
2278 "field": "read1stAt",
2285 "field": "lastMsgAt",
2296 "field": "lastMsgDirection",
2303 "field": "closeReason",
2310 "field": "customerPort",
2317 "field": "vidaooSessionId",
2323 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2325 "filename": "server/api/chatInteraction/index.js",
2326 "groupTitle": "Chat_Interactions"
2330 "url": "/api/chat/interactions/{id}",
2331 "title": "Deletes a Interaction",
2334 "title": "Example usage:",
2335 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2339 "name": "DeleteInteractions",
2340 "group": "Chat_Interactions",
2341 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2343 "filename": "server/api/chatInteraction/index.js",
2344 "groupTitle": "Chat_Interactions"
2348 "url": "/api/chat/interactions/describe",
2349 "title": "Gets table info about Interactions",
2352 "title": "Example usage:",
2353 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2357 "name": "DescribeInteractions",
2358 "group": "Chat_Interactions",
2359 "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>",
2361 "filename": "server/api/chatInteraction/index.js",
2362 "groupTitle": "Chat_Interactions"
2366 "url": "/api/chat/interactions",
2367 "title": "Gets a list of Interactions",
2370 "title": "Example usage:",
2371 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2375 "name": "GetInteractions",
2376 "group": "Chat_Interactions",
2377 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2379 "filename": "server/api/chatInteraction/index.js",
2380 "groupTitle": "Chat_Interactions"
2384 "url": "/api/chat/interactions/{id}/tags",
2385 "title": "Removes tags from interaction",
2388 "title": "Example usage:",
2389 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2393 "name": "RemoveTags",
2394 "group": "Chat_Interactions",
2395 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2397 "filename": "server/api/chatInteraction/index.js",
2398 "groupTitle": "Chat_Interactions"
2402 "url": "/api/chat/interactions/{id}",
2403 "title": "Gets a single Interaction",
2406 "title": "Example usage:",
2407 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2411 "name": "ShowInteractions",
2412 "group": "Chat_Interactions",
2413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2415 "filename": "server/api/chatInteraction/index.js",
2416 "groupTitle": "Chat_Interactions"
2420 "url": "/api/chat/interactions/{id}/abandon",
2421 "title": "Abandon interaction",
2424 "title": "Example usage:",
2425 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2430 "group": "Chat_Interactions",
2431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2433 "filename": "server/api/chatInteraction/index.js",
2434 "groupTitle": "Chat_Interactions"
2438 "url": "/api/chat/interactions/{id}/messages",
2439 "title": "Creates new messages",
2442 "title": "Example usage:",
2443 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2447 "name": "addMessage",
2448 "group": "Chat_Interactions",
2481 "field": "direction",
2494 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2496 "filename": "server/api/chatInteraction/index.js",
2497 "groupTitle": "Chat_Interactions"
2501 "url": "/api/chat/interactions/{id}/close",
2502 "title": "Close Interaction",
2505 "title": "Example usage:",
2506 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2510 "name": "addMessage",
2511 "group": "Chat_Interactions",
2512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2514 "filename": "server/api/chatInteraction/index.js",
2515 "groupTitle": "Chat_Interactions"
2519 "url": "/api/chat/interactions/{id}/attachment_upload",
2520 "title": "Add attachment",
2523 "title": "Example usage:",
2524 "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",
2528 "name": "attachmentUpload",
2529 "group": "Chat_Interactions",
2530 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2532 "filename": "server/api/chatInteraction/index.js",
2533 "groupTitle": "Chat_Interactions"
2537 "url": "/api/chat/interactions/{id}/vidaoo",
2538 "title": "Create Vidaoo Session",
2541 "title": "Example usage:",
2542 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2546 "name": "createVidaooSession",
2547 "group": "Chat_Interactions",
2548 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2550 "filename": "server/api/chatInteraction/index.js",
2551 "groupTitle": "Chat_Interactions"
2555 "url": "/api/chat/interactions/{id}/custom_update",
2556 "title": "Update interaction",
2559 "title": "Example usage:",
2560 "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",
2564 "name": "customUpdate",
2565 "group": "Chat_Interactions",
2566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2568 "filename": "server/api/chatInteraction/index.js",
2569 "groupTitle": "Chat_Interactions"
2573 "url": "/api/chat/interactions/{id}/download",
2574 "title": "Gets interaction",
2577 "title": "Example usage:",
2578 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2583 "group": "Chat_Interactions",
2584 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2586 "filename": "server/api/chatInteraction/index.js",
2587 "groupTitle": "Chat_Interactions"
2591 "url": "/api/chat/interactions/{id}/messages",
2592 "title": "Gets interaction messages",
2595 "title": "Example usage:",
2596 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2600 "name": "getMessages",
2601 "group": "Chat_Interactions",
2602 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2604 "filename": "server/api/chatInteraction/index.js",
2605 "groupTitle": "Chat_Interactions"
2609 "url": "/api/chat/interactions/{id}/my_messages",
2610 "title": "Gets interaction messages",
2613 "title": "Example usage:",
2614 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2618 "name": "getMyMessages",
2619 "group": "Chat_Interactions",
2620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2622 "filename": "server/api/chatInteraction/index.js",
2623 "groupTitle": "Chat_Interactions"
2627 "url": "/api/chat/interactions/{id}",
2628 "title": "Update an existing Interaction",
2631 "title": "Example usage:",
2632 "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",
2636 "name": "updateInteractions",
2637 "group": "Chat_Interactions",
2638 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2640 "filename": "server/api/chatInteraction/index.js",
2641 "groupTitle": "Chat_Interactions"
2645 "url": "/api/chat/internal/messages",
2646 "title": "Creates a new Message",
2649 "title": "Example usage:",
2650 "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",
2654 "name": "CreateMessages",
2655 "group": "Chat_Internal_Messages",
2677 "field": "ChatInternalMessageId",
2683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2685 "filename": "server/api/chatInternalMessage/index.js",
2686 "groupTitle": "Chat_Internal_Messages"
2690 "url": "/api/chat/internal/messages/{id}",
2691 "title": "Deletes a Message",
2694 "title": "Example usage:",
2695 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2699 "name": "DeleteMessages",
2700 "group": "Chat_Internal_Messages",
2701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2703 "filename": "server/api/chatInternalMessage/index.js",
2704 "groupTitle": "Chat_Internal_Messages"
2708 "url": "/api/chat/internal/messages/describe",
2709 "title": "Gets table info about Messages",
2712 "title": "Example usage:",
2713 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2717 "name": "DescribeMessages",
2718 "group": "Chat_Internal_Messages",
2719 "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>",
2721 "filename": "server/api/chatInternalMessage/index.js",
2722 "groupTitle": "Chat_Internal_Messages"
2726 "url": "/api/chat/internal/messages",
2727 "title": "Gets a list of Messages",
2730 "title": "Example usage:",
2731 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2735 "name": "GetMessages",
2736 "group": "Chat_Internal_Messages",
2737 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2739 "filename": "server/api/chatInternalMessage/index.js",
2740 "groupTitle": "Chat_Internal_Messages"
2744 "url": "/api/chat/internal/messages/{id}",
2745 "title": "Gets a single Message",
2748 "title": "Example usage:",
2749 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2753 "name": "ShowMessages",
2754 "group": "Chat_Internal_Messages",
2755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2757 "filename": "server/api/chatInternalMessage/index.js",
2758 "groupTitle": "Chat_Internal_Messages"
2762 "url": "/api/chat/internal/messages/{id}",
2763 "title": "Update an existing Message",
2766 "title": "Example usage:",
2767 "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",
2771 "name": "updateMessages",
2772 "group": "Chat_Internal_Messages",
2773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2775 "filename": "server/api/chatInternalMessage/index.js",
2776 "groupTitle": "Chat_Internal_Messages"
2780 "url": "/api/chat/messages",
2781 "title": "Creates a new Message",
2784 "title": "Example usage:",
2785 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2789 "name": "CreateMessages",
2790 "group": "Chat_Messages",
2823 "field": "direction",
2836 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2838 "filename": "server/api/chatMessage/index.js",
2839 "groupTitle": "Chat_Messages"
2843 "url": "/api/chat/messages/{id}",
2844 "title": "Deletes a Message",
2847 "title": "Example usage:",
2848 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2852 "name": "DeleteMessages",
2853 "group": "Chat_Messages",
2854 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2856 "filename": "server/api/chatMessage/index.js",
2857 "groupTitle": "Chat_Messages"
2861 "url": "/api/chat/messages/describe",
2862 "title": "Gets table info about Messages",
2865 "title": "Example usage:",
2866 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2870 "name": "DescribeMessages",
2871 "group": "Chat_Messages",
2872 "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>",
2874 "filename": "server/api/chatMessage/index.js",
2875 "groupTitle": "Chat_Messages"
2879 "url": "/api/chat/messages",
2880 "title": "Gets a list of Messages",
2883 "title": "Example usage:",
2884 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2888 "name": "GetMessages",
2889 "group": "Chat_Messages",
2890 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2892 "filename": "server/api/chatMessage/index.js",
2893 "groupTitle": "Chat_Messages"
2897 "url": "/api/chat/messages/{id}",
2898 "title": "Gets a single Message",
2901 "title": "Example usage:",
2902 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2906 "name": "ShowMessages",
2907 "group": "Chat_Messages",
2908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2910 "filename": "server/api/chatMessage/index.js",
2911 "groupTitle": "Chat_Messages"
2915 "url": "/api/chat/messages/{id}",
2916 "title": "Update an existing Message",
2919 "title": "Example usage:",
2920 "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",
2924 "name": "updateMessages",
2925 "group": "Chat_Messages",
2926 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2928 "filename": "server/api/chatMessage/index.js",
2929 "groupTitle": "Chat_Messages"
2933 "url": "/api/chat/offline_messages",
2934 "title": "Creates a new OfflineMessage",
2937 "title": "Example usage:",
2938 "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",
2942 "name": "CreateOfflineMessages",
2943 "group": "Chat_Offline_Messages",
2957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2959 "filename": "server/api/chatOfflineMessage/index.js",
2960 "groupTitle": "Chat_Offline_Messages"
2964 "url": "/api/chat/offline_messages/{id}",
2965 "title": "Deletes a OfflineMessage",
2968 "title": "Example usage:",
2969 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2973 "name": "DeleteOfflineMessages",
2974 "group": "Chat_Offline_Messages",
2975 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2977 "filename": "server/api/chatOfflineMessage/index.js",
2978 "groupTitle": "Chat_Offline_Messages"
2982 "url": "/api/chat/offline_messages/describe",
2983 "title": "Gets table info about OfflineMessages",
2986 "title": "Example usage:",
2987 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
2991 "name": "DescribeOfflineMessages",
2992 "group": "Chat_Offline_Messages",
2993 "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>",
2995 "filename": "server/api/chatOfflineMessage/index.js",
2996 "groupTitle": "Chat_Offline_Messages"
3000 "url": "/api/chat/offline_messages",
3001 "title": "Gets a list of OfflineMessages",
3004 "title": "Example usage:",
3005 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3009 "name": "GetOfflineMessages",
3010 "group": "Chat_Offline_Messages",
3011 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3013 "filename": "server/api/chatOfflineMessage/index.js",
3014 "groupTitle": "Chat_Offline_Messages"
3018 "url": "/api/chat/offline_messages/{id}",
3019 "title": "Gets a single OfflineMessage",
3022 "title": "Example usage:",
3023 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3027 "name": "ShowOfflineMessages",
3028 "group": "Chat_Offline_Messages",
3029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3031 "filename": "server/api/chatOfflineMessage/index.js",
3032 "groupTitle": "Chat_Offline_Messages"
3036 "url": "/api/chat/offline_messages/{id}",
3037 "title": "Update an existing OfflineMessage",
3040 "title": "Example usage:",
3041 "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",
3045 "name": "updateOfflineMessages",
3046 "group": "Chat_Offline_Messages",
3047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3049 "filename": "server/api/chatOfflineMessage/index.js",
3050 "groupTitle": "Chat_Offline_Messages"
3054 "url": "/api/chat/proactive_actions",
3055 "title": "Creates a new Proactive Action",
3058 "title": "Example usage:",
3059 "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",
3063 "name": "CreateProactive_Actions",
3064 "group": "Chat_Proactive_Actions",
3090 "field": "selector",
3103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3105 "filename": "server/api/chatProactiveAction/index.js",
3106 "groupTitle": "Chat_Proactive_Actions"
3110 "url": "/api/chat/proactive_actions/{id}",
3111 "title": "Deletes a Proactive Action",
3114 "title": "Example usage:",
3115 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3119 "name": "DeleteProactive_Actions",
3120 "group": "Chat_Proactive_Actions",
3121 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3123 "filename": "server/api/chatProactiveAction/index.js",
3124 "groupTitle": "Chat_Proactive_Actions"
3128 "url": "/api/chat/proactive_actions/{id}",
3129 "title": "Gets a single Proactive Action",
3132 "title": "Example usage:",
3133 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3137 "name": "ShowProactive_Actions",
3138 "group": "Chat_Proactive_Actions",
3139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3141 "filename": "server/api/chatProactiveAction/index.js",
3142 "groupTitle": "Chat_Proactive_Actions"
3146 "url": "/api/chat/proactive_actions/{id}",
3147 "title": "Update an existing Proactive Action",
3150 "title": "Example usage:",
3151 "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",
3155 "name": "updateProactive_Actions",
3156 "group": "Chat_Proactive_Actions",
3157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3159 "filename": "server/api/chatProactiveAction/index.js",
3160 "groupTitle": "Chat_Proactive_Actions"
3164 "url": "/api/chat/reports/queue",
3165 "title": "Creates a new Chat Queue Report",
3168 "title": "Example usage:",
3169 "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",
3173 "name": "CreateChat_Queue_Reports",
3174 "group": "Chat_Queue_Reports",
3182 "field": "uniqueid",
3210 "field": "acceptAt",
3230 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3232 "filename": "server/api/chatQueueReport/index.js",
3233 "groupTitle": "Chat_Queue_Reports"
3237 "url": "/api/chat/reports/queue/{id}",
3238 "title": "Deletes a Chat Queue Report",
3241 "title": "Example usage:",
3242 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3246 "name": "DeleteChat_Queue_Reports",
3247 "group": "Chat_Queue_Reports",
3248 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3250 "filename": "server/api/chatQueueReport/index.js",
3251 "groupTitle": "Chat_Queue_Reports"
3255 "url": "/api/chat/reports/queue/describe",
3256 "title": "Gets table info about Chat Queue Reports",
3259 "title": "Example usage:",
3260 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3264 "name": "DescribeChat_Queue_Reports",
3265 "group": "Chat_Queue_Reports",
3266 "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>",
3268 "filename": "server/api/chatQueueReport/index.js",
3269 "groupTitle": "Chat_Queue_Reports"
3273 "url": "/api/chat/reports/queue",
3274 "title": "Gets a list of Chat Queue Reports",
3277 "title": "Example usage:",
3278 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3282 "name": "GetChat_Queue_Reports",
3283 "group": "Chat_Queue_Reports",
3284 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3286 "filename": "server/api/chatQueueReport/index.js",
3287 "groupTitle": "Chat_Queue_Reports"
3291 "url": "/api/chat/reports/queue/{id}",
3292 "title": "Gets a single Chat Queue Report",
3295 "title": "Example usage:",
3296 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3300 "name": "ShowChat_Queue_Reports",
3301 "group": "Chat_Queue_Reports",
3302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3304 "filename": "server/api/chatQueueReport/index.js",
3305 "groupTitle": "Chat_Queue_Reports"
3309 "url": "/api/chat/reports/queue/{id}",
3310 "title": "Update an existing Chat Queue Report",
3313 "title": "Example usage:",
3314 "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",
3318 "name": "updateChat_Queue_Reports",
3319 "group": "Chat_Queue_Reports",
3320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3322 "filename": "server/api/chatQueueReport/index.js",
3323 "groupTitle": "Chat_Queue_Reports"
3327 "url": "/api/chat/queues/{id}/users",
3328 "title": "Add agents to a queue",
3331 "title": "Example usage:",
3332 "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",
3336 "name": "AddAgents",
3337 "group": "Chat_Queues",
3338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3340 "filename": "server/api/chatQueue/index.js",
3341 "groupTitle": "Chat_Queues"
3345 "url": "/api/chat/queues/{id}/teams",
3346 "title": "Add teams to a queue",
3349 "title": "Example usage:",
3350 "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",
3355 "group": "Chat_Queues",
3356 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3358 "filename": "server/api/chatQueue/index.js",
3359 "groupTitle": "Chat_Queues"
3363 "url": "/api/chat/queues",
3364 "title": "Creates a new Queue",
3367 "title": "Example usage:",
3368 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3372 "name": "CreateQueues",
3373 "group": "Chat_Queues",
3388 "field": "description",
3407 "field": "strategy",
3413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3415 "filename": "server/api/chatQueue/index.js",
3416 "groupTitle": "Chat_Queues"
3420 "url": "/api/chat/queues/{id}",
3421 "title": "Deletes a Queue",
3424 "title": "Example usage:",
3425 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3429 "name": "DeleteQueues",
3430 "group": "Chat_Queues",
3431 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3433 "filename": "server/api/chatQueue/index.js",
3434 "groupTitle": "Chat_Queues"
3438 "url": "/api/chat/queues/describe",
3439 "title": "Gets table info about Queues",
3442 "title": "Example usage:",
3443 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3447 "name": "DescribeQueues",
3448 "group": "Chat_Queues",
3449 "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>",
3451 "filename": "server/api/chatQueue/index.js",
3452 "groupTitle": "Chat_Queues"
3456 "url": "/api/chat/queues/{id}/users",
3457 "title": "Gets queue agents",
3460 "title": "Example usage:",
3461 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3465 "name": "GetAgents",
3466 "group": "Chat_Queues",
3467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3469 "filename": "server/api/chatQueue/index.js",
3470 "groupTitle": "Chat_Queues"
3474 "url": "/api/chat/queues/{id}/members",
3475 "title": "GetMembers",
3478 "title": "Example usage:",
3479 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3483 "name": "GetMembers",
3484 "group": "Chat_Queues",
3485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3487 "filename": "server/api/chatQueue/index.js",
3488 "groupTitle": "Chat_Queues"
3492 "url": "/api/chat/queues",
3493 "title": "Gets a list of Queues",
3496 "title": "Example usage:",
3497 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3501 "name": "GetQueues",
3502 "group": "Chat_Queues",
3503 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3505 "filename": "server/api/chatQueue/index.js",
3506 "groupTitle": "Chat_Queues"
3510 "url": "/api/chat/queues/{id}/teams",
3511 "title": "Gets queues list",
3514 "title": "Example usage:",
3515 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3520 "group": "Chat_Queues",
3521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3523 "filename": "server/api/chatQueue/index.js",
3524 "groupTitle": "Chat_Queues"
3528 "url": "/api/chat/queues/{id}/users",
3529 "title": "Removes agents from a queue",
3532 "title": "Example usage:",
3533 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3537 "name": "RemoveAgents",
3538 "group": "Chat_Queues",
3539 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3541 "filename": "server/api/chatQueue/index.js",
3542 "groupTitle": "Chat_Queues"
3546 "url": "/api/chat/queues/{id}",
3547 "title": "Gets a single Queue",
3550 "title": "Example usage:",
3551 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3555 "name": "ShowQueues",
3556 "group": "Chat_Queues",
3557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3559 "filename": "server/api/chatQueue/index.js",
3560 "groupTitle": "Chat_Queues"
3564 "url": "/api/chat/queues/{id}",
3565 "title": "Update an existing Queue",
3568 "title": "Example usage:",
3569 "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",
3573 "name": "updateQueues",
3574 "group": "Chat_Queues",
3575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3577 "filename": "server/api/chatQueue/index.js",
3578 "groupTitle": "Chat_Queues"
3582 "url": "/api/chat/reports/transfer",
3583 "title": "Creates a new Chat Transfer Report",
3586 "title": "Example usage:",
3587 "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",
3591 "name": "CreateChat_Transfer_Reports",
3592 "group": "Chat_Transfer_Reports",
3600 "field": "uniqueid",
3619 "field": "transferredAt",
3625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3627 "filename": "server/api/chatTransferReport/index.js",
3628 "groupTitle": "Chat_Transfer_Reports"
3632 "url": "/api/chat/reports/transfer/{id}",
3633 "title": "Deletes a Chat Transfer Report",
3636 "title": "Example usage:",
3637 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3641 "name": "DeleteChat_Transfer_Reports",
3642 "group": "Chat_Transfer_Reports",
3643 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3645 "filename": "server/api/chatTransferReport/index.js",
3646 "groupTitle": "Chat_Transfer_Reports"
3650 "url": "/api/chat/reports/transfer/describe",
3651 "title": "Gets table info about Chat Transfer Reports",
3654 "title": "Example usage:",
3655 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3659 "name": "DescribeChat_Transfer_Reports",
3660 "group": "Chat_Transfer_Reports",
3661 "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>",
3663 "filename": "server/api/chatTransferReport/index.js",
3664 "groupTitle": "Chat_Transfer_Reports"
3668 "url": "/api/chat/reports/transfer",
3669 "title": "Gets a list of Chat Transfer Reports",
3672 "title": "Example usage:",
3673 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3677 "name": "GetChat_Transfer_Reports",
3678 "group": "Chat_Transfer_Reports",
3679 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3681 "filename": "server/api/chatTransferReport/index.js",
3682 "groupTitle": "Chat_Transfer_Reports"
3686 "url": "/api/chat/reports/transfer/{id}",
3687 "title": "Gets a single Chat Transfer Report",
3690 "title": "Example usage:",
3691 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3695 "name": "ShowChat_Transfer_Reports",
3696 "group": "Chat_Transfer_Reports",
3697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3699 "filename": "server/api/chatTransferReport/index.js",
3700 "groupTitle": "Chat_Transfer_Reports"
3704 "url": "/api/chat/reports/transfer/{id}",
3705 "title": "Update an existing Chat Transfer Report",
3708 "title": "Example usage:",
3709 "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",
3713 "name": "updateChat_Transfer_Reports",
3714 "group": "Chat_Transfer_Reports",
3715 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3717 "filename": "server/api/chatTransferReport/index.js",
3718 "groupTitle": "Chat_Transfer_Reports"
3722 "url": "/api/chat/websites/{id}/users",
3723 "title": "Add agents to a website",
3726 "title": "Example usage:",
3727 "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",
3731 "name": "AddAgents",
3732 "group": "Chat_Websites",
3733 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3735 "filename": "server/api/chatWebsite/index.js",
3736 "groupTitle": "Chat_Websites"
3740 "url": "/api/chat/websites",
3741 "title": "Creates a new Website",
3744 "title": "Example usage:",
3745 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3749 "name": "CreateWebsites",
3750 "group": "Chat_Websites",
3772 "field": "description",
3786 "field": "mapKeyOffline",
3800 "field": "agentAlias",
3807 "field": "customerAlias",
3821 "field": "color_button",
3828 "field": "textColor",
3835 "field": "fontSize",
3849 "field": "animation",
3860 "field": "header_shape",
3867 "field": "header_online",
3874 "field": "start_chat_button",
3881 "field": "offline_chat_button",
3888 "field": "header_offline",
3895 "field": "download_transcript",
3909 "field": "whiteLabel",
3916 "field": "defaultWhiteLabel",
3930 "field": "closingQuestion",
3937 "field": "formSubmitSuccessMessage",
3944 "field": "formSubmitFailureMessage",
3951 "field": "noteTitle",
3958 "field": "placeholderMessage",
3965 "field": "closingMessage",
3972 "field": "closingMessageButton",
3979 "field": "skipMessageButton",
3986 "field": "conditionAgreement",
3993 "field": "enableRating",
4000 "field": "enableFeedback",
4007 "field": "enableSendButton",
4014 "field": "feedbackTitle",
4025 "field": "ratingType",
4032 "field": "ratingStarsNumber",
4039 "field": "onlineForm",
4046 "field": "offlineForm",
4060 "field": "autoclose",
4067 "field": "enableCustomerWriting",
4074 "field": "forwardTranscript",
4081 "field": "forwardTranscriptMessage",
4088 "field": "forwardOffline",
4095 "field": "forwardOfflineAddress",
4102 "field": "waitingTitle",
4109 "field": "waitingMessage",
4116 "field": "offlineMessageSubject",
4123 "field": "offlineMessageBody",
4130 "field": "enableUnmanagedNote",
4137 "field": "unmanagedMessage",
4144 "field": "skipUnmanaged",
4151 "field": "sendUnmanaged",
4158 "field": "enableCustomerAttachment",
4165 "field": "enableCustomerCheckmarks",
4172 "field": "agentAvatar",
4179 "field": "showAgentAvatar",
4186 "field": "timezone",
4193 "field": "notificationTemplate",
4200 "field": "notificationSound",
4207 "field": "notificationShake",
4214 "field": "hideWhenOffline",
4221 "field": "agentIdentifier",
4228 "field": "waitForTheAssignedAgent",
4235 "field": "alignment",
4242 "field": "verticalAlignment",
4249 "field": "messagesAlignment",
4256 "field": "defaultTitle",
4263 "field": "customerAvatar",
4270 "field": "showCustomerAvatar",
4277 "field": "messageFontSize",
4284 "field": "backgroundColor",
4291 "field": "queueTransfer",
4298 "field": "queueTransferTimeout",
4305 "field": "agentTransfer",
4312 "field": "agentTransferTimeout",
4319 "field": "systemAlias",
4326 "field": "systemAvatar",
4333 "field": "mandatoryDispositionPauseId",
4334 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4340 "field": "mandatoryDisposition",
4341 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4347 "field": "vidaooEscalation",
4354 "field": "vidaooApiKey",
4360 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4362 "filename": "server/api/chatWebsite/index.js",
4363 "groupTitle": "Chat_Websites"
4367 "url": "/api/chat/websites/{id}",
4368 "title": "Deletes a Website",
4371 "title": "Example usage:",
4372 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4376 "name": "DeleteWebsites",
4377 "group": "Chat_Websites",
4378 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4380 "filename": "server/api/chatWebsite/index.js",
4381 "groupTitle": "Chat_Websites"
4385 "url": "/api/chat/websites/describe",
4386 "title": "Gets table info about Websites",
4389 "title": "Example usage:",
4390 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4394 "name": "DescribeWebsites",
4395 "group": "Chat_Websites",
4396 "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>",
4398 "filename": "server/api/chatWebsite/index.js",
4399 "groupTitle": "Chat_Websites"
4403 "url": "/api/chat/websites/{id}/users",
4404 "title": "Gets agents from website",
4407 "title": "Example usage:",
4408 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4412 "name": "GetAgents",
4413 "group": "Chat_Websites",
4414 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4416 "filename": "server/api/chatWebsite/index.js",
4417 "groupTitle": "Chat_Websites"
4421 "url": "/api/chat/websites",
4422 "title": "Gets a list of Websites",
4425 "title": "Example usage:",
4426 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4430 "name": "GetWebsites",
4431 "group": "Chat_Websites",
4432 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4434 "filename": "server/api/chatWebsite/index.js",
4435 "groupTitle": "Chat_Websites"
4439 "url": "/api/chat/websites/{id}/users",
4440 "title": "Removes agents from a website",
4443 "title": "Example usage:",
4444 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4448 "name": "RemoveAgents",
4449 "group": "Chat_Websites",
4450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4452 "filename": "server/api/chatWebsite/index.js",
4453 "groupTitle": "Chat_Websites"
4457 "url": "/api/chat/websites/{id}/canned_answers",
4458 "title": "Removes canned answers from account",
4461 "title": "Example usage:",
4462 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4466 "name": "RemoveAnswers",
4467 "group": "Chat_Websites",
4468 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4470 "filename": "server/api/chatWebsite/index.js",
4471 "groupTitle": "Chat_Websites"
4475 "url": "/api/chat/websites/{id}/dispositions",
4476 "title": "Removes canned answers from account",
4479 "title": "Example usage:",
4480 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4484 "name": "RemoveDispositions",
4485 "group": "Chat_Websites",
4486 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4488 "filename": "server/api/chatWebsite/index.js",
4489 "groupTitle": "Chat_Websites"
4493 "url": "/api/chat/websites/{id}",
4494 "title": "Gets a single Website",
4497 "title": "Example usage:",
4498 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4502 "name": "ShowWebsites",
4503 "group": "Chat_Websites",
4504 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4506 "filename": "server/api/chatWebsite/index.js",
4507 "groupTitle": "Chat_Websites"
4511 "url": "/api/chat/messages/{id}/accept",
4512 "title": "Accepts message",
4515 "title": "Example usage:",
4516 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4520 "name": "acceptMessage",
4521 "group": "Chat_Websites",
4522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4524 "filename": "server/api/chatMessage/index.js",
4525 "groupTitle": "Chat_Websites"
4529 "url": "/api/chat/websites/{id}/canned_answers",
4530 "title": "Creates new canned answer",
4533 "title": "Example usage:",
4534 "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",
4538 "name": "addAnswer",
4539 "group": "Chat_Websites",
4561 "field": "description",
4574 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4576 "filename": "server/api/chatWebsite/index.js",
4577 "groupTitle": "Chat_Websites"
4581 "url": "/api/chat/websites/{id}/applications",
4582 "title": "Creates new applications",
4585 "title": "Example usage:",
4586 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4590 "name": "addApplications",
4591 "group": "Chat_Websites",
4599 "field": "priority",
4620 "field": "description",
4627 "field": "interval",
4633 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4635 "filename": "server/api/chatWebsite/index.js",
4636 "groupTitle": "Chat_Websites"
4640 "url": "/api/chat/websites/{id}/avatar",
4641 "title": "Add avatar",
4644 "title": "Example usage:",
4645 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4649 "name": "addAvatar",
4650 "group": "Chat_Websites",
4651 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4653 "filename": "server/api/chatWebsite/index.js",
4654 "groupTitle": "Chat_Websites"
4658 "url": "/api/chat/websites/{id}/customer_avatar",
4659 "title": "Add customer avatar",
4662 "title": "Example usage:",
4663 "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",
4667 "name": "addCustomerAvatar",
4668 "group": "Chat_Websites",
4669 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4671 "filename": "server/api/chatWebsite/index.js",
4672 "groupTitle": "Chat_Websites"
4676 "url": "/api/chat/websites/{id}/dispositions",
4677 "title": "Creates new disposition",
4680 "title": "Example usage:",
4681 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4685 "name": "addDisposition",
4686 "group": "Chat_Websites",
4713 "field": "description",
4719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4721 "filename": "server/api/chatWebsite/index.js",
4722 "groupTitle": "Chat_Websites"
4726 "url": "/api/chat/accounts/{id}/interactions",
4727 "title": "Creates new interactions",
4730 "title": "Example usage:",
4731 "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",
4735 "name": "addInteraction",
4736 "group": "Chat_Websites",
4751 "field": "ratingValue",
4762 "field": "ratingType",
4769 "field": "ratingMessage",
4776 "field": "pathTranscript",
4783 "field": "mailTranscript",
4790 "field": "closedAt",
4797 "field": "disposition",
4804 "field": "secondDisposition",
4811 "field": "thirdDisposition",
4825 "field": "browserName",
4832 "field": "browserVersion",
4846 "field": "osVersion",
4853 "field": "deviceModel",
4860 "field": "deviceVendor",
4867 "field": "deviceType",
4881 "field": "customerIp",
4888 "field": "formData",
4895 "field": "read1stAt",
4902 "field": "lastMsgAt",
4913 "field": "lastMsgDirection",
4920 "field": "closeReason",
4927 "field": "customerPort",
4934 "field": "vidaooSessionId",
4940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4942 "filename": "server/api/chatWebsite/index.js",
4943 "groupTitle": "Chat_Websites"
4947 "url": "/api/chat/websites/{id}/logo",
4948 "title": "Add logo",
4951 "title": "Example usage:",
4952 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4957 "group": "Chat_Websites",
4958 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4960 "filename": "server/api/chatWebsite/index.js",
4961 "groupTitle": "Chat_Websites"
4965 "url": "/api/chat/websites/{id}/proactive_actions",
4966 "title": "Creates new Proactive Actions",
4969 "title": "Example usage:",
4970 "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",
4974 "name": "addProactiveActions",
4975 "group": "Chat_Websites",
5001 "field": "selector",
5014 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5016 "filename": "server/api/chatWebsite/index.js",
5017 "groupTitle": "Chat_Websites"
5021 "url": "/api/chat/websites/{id}/system_avatar",
5022 "title": "Add system avatar",
5025 "title": "Example usage:",
5026 "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",
5030 "name": "addSystemAvatar",
5031 "group": "Chat_Websites",
5032 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5034 "filename": "server/api/chatWebsite/index.js",
5035 "groupTitle": "Chat_Websites"
5039 "url": "/api/chat/websites/{id}/canned_answers",
5040 "title": "Gets account canned answers",
5043 "title": "Example usage:",
5044 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5048 "name": "getAnswers",
5049 "group": "Chat_Websites",
5050 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5052 "filename": "server/api/chatWebsite/index.js",
5053 "groupTitle": "Chat_Websites"
5057 "url": "/api/chat/websites/{id}/applications",
5058 "title": "Gets Website Applications",
5061 "title": "Example usage:",
5062 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5066 "name": "getApplications",
5067 "group": "Chat_Websites",
5068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5070 "filename": "server/api/chatWebsite/index.js",
5071 "groupTitle": "Chat_Websites"
5075 "url": "/api/chat/websites/{id}/avatar",
5076 "title": "Get avatar",
5079 "title": "Example usage:",
5080 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5084 "name": "getAvatar",
5085 "group": "Chat_Websites",
5086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5088 "filename": "server/api/chatWebsite/index.js",
5089 "groupTitle": "Chat_Websites"
5093 "url": "/api/chat/websites/{id}/customer_avatar",
5094 "title": "Get Customer Avatar",
5097 "title": "Example usage:",
5098 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5102 "name": "getCustomerAvatar",
5103 "group": "Chat_Websites",
5104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5106 "filename": "server/api/chatWebsite/index.js",
5107 "groupTitle": "Chat_Websites"
5111 "url": "/api/chat/websites/{id}/dispositions",
5112 "title": "Gets account dispositions",
5115 "title": "Example usage:",
5116 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5120 "name": "getDispositions",
5121 "group": "Chat_Websites",
5122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5124 "filename": "server/api/chatWebsite/index.js",
5125 "groupTitle": "Chat_Websites"
5129 "url": "/api/chat/websites/{id}/fields",
5130 "title": "Gets Website Fields",
5133 "title": "Example usage:",
5134 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5138 "name": "getFields",
5139 "group": "Chat_Websites",
5140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5142 "filename": "server/api/chatWebsite/index.js",
5143 "groupTitle": "Chat_Websites"
5147 "url": "/api/chat/websites/{id}/interactions",
5148 "title": "Gets Website Interactions",
5151 "title": "Example usage:",
5152 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5156 "name": "getInteraction",
5157 "group": "Chat_Websites",
5158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5160 "filename": "server/api/chatWebsite/index.js",
5161 "groupTitle": "Chat_Websites"
5165 "url": "/api/chat/websites/{id}/logo",
5166 "title": "Get logo",
5169 "title": "Example usage:",
5170 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5175 "group": "Chat_Websites",
5176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5178 "filename": "server/api/chatWebsite/index.js",
5179 "groupTitle": "Chat_Websites"
5183 "url": "/api/chat/websites/{id}/offline_messages",
5184 "title": "Gets Website Offline Messages",
5187 "title": "Example usage:",
5188 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5192 "name": "getOfflineMessages",
5193 "group": "Chat_Websites",
5194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5196 "filename": "server/api/chatWebsite/index.js",
5197 "groupTitle": "Chat_Websites"
5201 "url": "/api/chat/websites/{id}/proactive_actions",
5202 "title": "Gets Website Proactive Actions",
5205 "title": "Example usage:",
5206 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5210 "name": "getProactiveActions",
5211 "group": "Chat_Websites",
5212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5214 "filename": "server/api/chatWebsite/index.js",
5215 "groupTitle": "Chat_Websites"
5219 "url": "/api/chat/websites/{id}/snippet",
5220 "title": "Gets Website Snippet",
5223 "title": "Example usage:",
5224 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5228 "name": "getSnippet",
5229 "group": "Chat_Websites",
5230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5232 "filename": "server/api/chatWebsite/index.js",
5233 "groupTitle": "Chat_Websites"
5237 "url": "/api/chat/websites/{id}/system_avatar",
5238 "title": "Get System Avatar",
5241 "title": "Example usage:",
5242 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5246 "name": "getSystemAvatar",
5247 "group": "Chat_Websites",
5248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5250 "filename": "server/api/chatWebsite/index.js",
5251 "groupTitle": "Chat_Websites"
5255 "url": "/api/chat/websites/{id}/notify",
5256 "title": "Notify new message",
5259 "title": "Example usage:",
5260 "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",
5265 "group": "Chat_Websites",
5266 "description": "<p>Motion 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>",
5268 "filename": "server/api/chatWebsite/index.js",
5269 "groupTitle": "Chat_Websites"
5273 "url": "/api/chat/websites/{id}/offline",
5274 "title": "Offline message",
5277 "title": "Example usage:",
5278 "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",
5283 "group": "Chat_Websites",
5284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5286 "filename": "server/api/chatWebsite/index.js",
5287 "groupTitle": "Chat_Websites"
5291 "url": "/api/chat/messages/{id}/reject",
5292 "title": "Rejects message",
5295 "title": "Example usage:",
5296 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5300 "name": "rejectMessage",
5301 "group": "Chat_Websites",
5302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5304 "filename": "server/api/chatMessage/index.js",
5305 "groupTitle": "Chat_Websites"
5309 "url": "/api/chat/websites/{id}",
5310 "title": "Update an existing Website",
5313 "title": "Example usage:",
5314 "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",
5318 "name": "updateWebsites",
5319 "group": "Chat_Websites",
5320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5322 "filename": "server/api/chatWebsite/index.js",
5323 "groupTitle": "Chat_Websites"
5327 "url": "/api/cloudProviders",
5328 "title": "Creates a new CloudProvider",
5331 "title": "Example usage:",
5332 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5336 "name": "CreateCloudProviders",
5337 "group": "CloudProviders",
5376 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5378 "filename": "server/api/cloudProvider/index.js",
5379 "groupTitle": "CloudProviders"
5383 "url": "/api/cloudProviders/{id}",
5384 "title": "Deletes a CloudProvider",
5387 "title": "Example usage:",
5388 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5392 "name": "DeleteCloudProviders",
5393 "group": "CloudProviders",
5394 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5396 "filename": "server/api/cloudProvider/index.js",
5397 "groupTitle": "CloudProviders"
5401 "url": "/api/cloudProviders",
5402 "title": "Gets a list of CloudProviders",
5405 "title": "Example usage:",
5406 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5410 "name": "GetCloudProviders",
5411 "group": "CloudProviders",
5412 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5414 "filename": "server/api/cloudProvider/index.js",
5415 "groupTitle": "CloudProviders"
5419 "url": "/api/cloudProviders/{id}",
5420 "title": "Gets a single CloudProvider",
5423 "title": "Example usage:",
5424 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5428 "name": "ShowCloudProviders",
5429 "group": "CloudProviders",
5430 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5432 "filename": "server/api/cloudProvider/index.js",
5433 "groupTitle": "CloudProviders"
5437 "url": "/api/cloudProviders/{id}",
5438 "title": "Update an existing CloudProvider",
5441 "title": "Example usage:",
5442 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5446 "name": "updateCloudProviders",
5447 "group": "CloudProviders",
5448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5450 "filename": "server/api/cloudProvider/index.js",
5451 "groupTitle": "CloudProviders"
5455 "url": "/api/cm/companies",
5456 "title": "Creates a new Company",
5459 "title": "Example usage:",
5460 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5464 "name": "CreateCompanies",
5465 "group": "Cm_Companies",
5487 "field": "companyId",
5529 "field": "postalCode",
5557 "field": "emailDomain",
5571 "field": "sPostalCode",
5585 "field": "sCountry",
5592 "field": "description",
5598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5600 "filename": "server/api/cmCompany/index.js",
5601 "groupTitle": "Cm_Companies"
5605 "url": "/api/cm/companies/{id}",
5606 "title": "Deletes a Company",
5609 "title": "Example usage:",
5610 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5614 "name": "DeleteCompanies",
5615 "group": "Cm_Companies",
5616 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5618 "filename": "server/api/cmCompany/index.js",
5619 "groupTitle": "Cm_Companies"
5623 "url": "/api/cm/companies/describe",
5624 "title": "Gets table info about Companies",
5627 "title": "Example usage:",
5628 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5632 "name": "DescribeCompanies",
5633 "group": "Cm_Companies",
5634 "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>",
5636 "filename": "server/api/cmCompany/index.js",
5637 "groupTitle": "Cm_Companies"
5641 "url": "/api/cm/companies",
5642 "title": "Gets a list of Companies",
5645 "title": "Example usage:",
5646 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5650 "name": "GetCompanies",
5651 "group": "Cm_Companies",
5652 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5654 "filename": "server/api/cmCompany/index.js",
5655 "groupTitle": "Cm_Companies"
5659 "url": "/api/cm/companies/{id}",
5660 "title": "Gets a single Company",
5663 "title": "Example usage:",
5664 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5668 "name": "ShowCompanies",
5669 "group": "Cm_Companies",
5670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5672 "filename": "server/api/cmCompany/index.js",
5673 "groupTitle": "Cm_Companies"
5677 "url": "/api/cm/companies/{id}/contacts",
5678 "title": "Creates new contacts",
5681 "title": "Example usage:",
5682 "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",
5686 "name": "addContacts",
5687 "group": "Cm_Companies",
5695 "field": "firstName",
5702 "field": "lastName",
5716 "field": "postalCode",
5737 "field": "dateOfBirth",
5744 "field": "description",
5786 "field": "facebook",
5842 "field": "telegram",
5856 "field": "priority",
5863 "field": "scheduledat",
5869 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5871 "filename": "server/api/cmCompany/index.js",
5872 "groupTitle": "Cm_Companies"
5876 "url": "/api/cm/companies/{id}/contacts",
5877 "title": "Gets List Contacts",
5880 "title": "Example usage:",
5881 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5885 "name": "getContacts",
5886 "group": "Cm_Companies",
5887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5889 "filename": "server/api/cmCompany/index.js",
5890 "groupTitle": "Cm_Companies"
5894 "url": "/api/cm/companies/{id}",
5895 "title": "Update an existing Company",
5898 "title": "Example usage:",
5899 "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",
5903 "name": "updateCompanies",
5904 "group": "Cm_Companies",
5905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5907 "filename": "server/api/cmCompany/index.js",
5908 "groupTitle": "Cm_Companies"
5912 "url": "/api/cm/contacts/{id}",
5913 "title": "Deletes a Contact",
5916 "title": "Example usage:",
5917 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5921 "name": "DeleteContacts",
5922 "group": "Cm_Contacts",
5923 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5925 "filename": "server/api/cmContact/index.js",
5926 "groupTitle": "Cm_Contacts"
5930 "url": "/api/cm/contacts/describe",
5931 "title": "Gets table info about Contacts",
5934 "title": "Example usage:",
5935 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5939 "name": "DescribeContacts",
5940 "group": "Cm_Contacts",
5941 "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>",
5943 "filename": "server/api/cmContact/index.js",
5944 "groupTitle": "Cm_Contacts"
5948 "url": "/api/cm/contacts",
5949 "title": "Gets a list of Contacts",
5952 "title": "Example usage:",
5953 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5957 "name": "GetContacts",
5958 "group": "Cm_Contacts",
5959 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5961 "filename": "server/api/cmContact/index.js",
5962 "groupTitle": "Cm_Contacts"
5966 "url": "/api/cm/contacts/{id}/finals",
5967 "title": "Gets contact hopper finals",
5970 "title": "Example usage:",
5971 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
5975 "name": "GetHopperFinals",
5976 "group": "Cm_Contacts",
5977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5979 "filename": "server/api/cmContact/index.js",
5980 "groupTitle": "Cm_Contacts"
5984 "url": "/api/cm/contacts/{id}/hopper_histories",
5985 "title": "Gets contact hopper histories",
5988 "title": "Example usage:",
5989 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
5993 "name": "GetHopperHistories",
5994 "group": "Cm_Contacts",
5995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5997 "filename": "server/api/cmContact/index.js",
5998 "groupTitle": "Cm_Contacts"
6002 "url": "/api/cm/contacts/{id}/hoppers",
6003 "title": "Gets contact hoppers",
6006 "title": "Example usage:",
6007 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6011 "name": "GetHoppers",
6012 "group": "Cm_Contacts",
6013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6015 "filename": "server/api/cmContact/index.js",
6016 "groupTitle": "Cm_Contacts"
6020 "url": "/api/cm/contacts/create_many",
6021 "title": "Create Contacts",
6024 "title": "Example usage:",
6025 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6029 "name": "bulkCreate",
6030 "group": "Cm_Contacts",
6031 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6033 "filename": "server/api/cmContact/index.js",
6034 "groupTitle": "Cm_Contacts"
6038 "url": "/api/cm/contacts",
6039 "title": "Create Contact",
6042 "title": "Example usage:",
6043 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6048 "group": "Cm_Contacts",
6049 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6051 "filename": "server/api/cmContact/index.js",
6052 "groupTitle": "Cm_Contacts"
6056 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6057 "title": "Gets contact hopper blacks",
6060 "title": "Example usage:",
6061 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6065 "name": "getJscriptySessions",
6066 "group": "Cm_Contacts",
6067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6069 "filename": "server/api/cmContact/index.js",
6070 "groupTitle": "Cm_Contacts"
6074 "url": "/api/cm/contacts/{id}/tags",
6075 "title": "Gets configurations tags",
6078 "title": "Example usage:",
6079 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6084 "group": "Cm_Contacts",
6085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6087 "filename": "server/api/cmContact/index.js",
6088 "groupTitle": "Cm_Contacts"
6092 "url": "/api/cm/contacts/merge",
6093 "title": "Merge Contact",
6096 "title": "Example usage:",
6097 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6102 "group": "Cm_Contacts",
6103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6105 "filename": "server/api/cmContact/index.js",
6106 "groupTitle": "Cm_Contacts"
6110 "url": "/api/cm/contacts/{id}/tags",
6111 "title": "Sets new tags",
6114 "title": "Example usage:",
6115 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6120 "group": "Cm_Contacts",
6121 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6123 "filename": "server/api/cmContact/index.js",
6124 "groupTitle": "Cm_Contacts"
6128 "url": "/api/cm/contacts/{id}",
6129 "title": "Gets a single Contact",
6132 "title": "Example usage:",
6133 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6138 "group": "Cm_Contacts",
6139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6141 "filename": "server/api/cmContact/index.js",
6142 "groupTitle": "Cm_Contacts"
6146 "url": "/api/cm/contacts/{id}",
6147 "title": "Update a single Contact",
6150 "title": "Example usage:",
6151 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6156 "group": "Cm_Contacts",
6157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6159 "filename": "server/api/cmContact/index.js",
6160 "groupTitle": "Cm_Contacts"
6164 "url": "/api/cm/custom_fields/{id}",
6165 "title": "Deletes a Custom Field",
6168 "title": "Example usage:",
6169 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6173 "name": "DeleteCustom_Fields",
6174 "group": "Cm_Custom_Fields",
6175 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6177 "filename": "server/api/cmCustomField/index.js",
6178 "groupTitle": "Cm_Custom_Fields"
6182 "url": "/api/cm/custom_fields",
6183 "title": "Gets a list of Custom Fields",
6186 "title": "Example usage:",
6187 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6191 "name": "GetCustom_Fields",
6192 "group": "Cm_Custom_Fields",
6193 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6195 "filename": "server/api/cmCustomField/index.js",
6196 "groupTitle": "Cm_Custom_Fields"
6200 "url": "/api/cm/custom_fields/{id}",
6201 "title": "Gets a single Custom Field",
6204 "title": "Example usage:",
6205 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6209 "name": "ShowCustom_Fields",
6210 "group": "Cm_Custom_Fields",
6211 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6213 "filename": "server/api/cmCustomField/index.js",
6214 "groupTitle": "Cm_Custom_Fields"
6218 "url": "/api/cm/custom_fields/{id}",
6219 "title": "Update an existing Custom Field",
6222 "title": "Example usage:",
6223 "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",
6227 "name": "updateCustom_Fields",
6228 "group": "Cm_Custom_Fields",
6229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6231 "filename": "server/api/cmCustomField/index.js",
6232 "groupTitle": "Cm_Custom_Fields"
6236 "url": "/api/cm/hopper",
6237 "title": "Creates a new Hopper",
6240 "title": "Example usage:",
6241 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6245 "name": "CreateHopper",
6246 "group": "Cm_Hopper",
6268 "field": "scheduledat",
6275 "field": "countbusyretry",
6282 "field": "countcongestionretry",
6289 "field": "countnoanswerretry",
6296 "field": "callback",
6303 "field": "callbackuniqueid",
6310 "field": "callbackat",
6317 "field": "priority",
6324 "field": "recallme",
6331 "field": "ContactId",
6352 "field": "VoiceQueueId",
6359 "field": "CampaignId",
6366 "field": "countnosuchnumberretry",
6373 "field": "countdropretry",
6380 "field": "countabandonedretry",
6387 "field": "countmachineretry",
6394 "field": "countagentrejectretry",
6400 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6402 "filename": "server/api/cmHopper/index.js",
6403 "groupTitle": "Cm_Hopper"
6407 "url": "/api/cm/hopper/describe",
6408 "title": "Gets table info about Hopper",
6411 "title": "Example usage:",
6412 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6416 "name": "DescribeHopper",
6417 "group": "Cm_Hopper",
6418 "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>",
6420 "filename": "server/api/cmHopper/index.js",
6421 "groupTitle": "Cm_Hopper"
6425 "url": "/api/cm/hopper",
6426 "title": "Gets a list of Hopper",
6429 "title": "Example usage:",
6430 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6434 "name": "GetHopper",
6435 "group": "Cm_Hopper",
6436 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6438 "filename": "server/api/cmHopper/index.js",
6439 "groupTitle": "Cm_Hopper"
6443 "url": "/api/cm/hopper/{id}",
6444 "title": "Gets a single Hopper",
6447 "title": "Example usage:",
6448 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6452 "name": "ShowHopper",
6453 "group": "Cm_Hopper",
6454 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6456 "filename": "server/api/cmHopper/index.js",
6457 "groupTitle": "Cm_Hopper"
6461 "url": "/api/cm/hopper_black/{id}",
6462 "title": "Deletes a Hopper Black",
6465 "title": "Example usage:",
6466 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6470 "name": "DeleteHopper_Black",
6471 "group": "Cm_Hopper_Black",
6472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6474 "filename": "server/api/cmHopperBlack/index.js",
6475 "groupTitle": "Cm_Hopper_Black"
6479 "url": "/api/cm/hopper_black/describe",
6480 "title": "Gets table info about Hopper Black",
6483 "title": "Example usage:",
6484 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6488 "name": "DescribeHopper_Black",
6489 "group": "Cm_Hopper_Black",
6490 "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>",
6492 "filename": "server/api/cmHopperBlack/index.js",
6493 "groupTitle": "Cm_Hopper_Black"
6497 "url": "/api/cm/hopper_black",
6498 "title": "Gets a list of Hopper Black",
6501 "title": "Example usage:",
6502 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6506 "name": "GetHopper_Black",
6507 "group": "Cm_Hopper_Black",
6508 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6510 "filename": "server/api/cmHopperBlack/index.js",
6511 "groupTitle": "Cm_Hopper_Black"
6515 "url": "/api/cm/hopper_black/{id}",
6516 "title": "Gets a single Hopper Black",
6519 "title": "Example usage:",
6520 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6524 "name": "ShowHopper_Black",
6525 "group": "Cm_Hopper_Black",
6526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6528 "filename": "server/api/cmHopperBlack/index.js",
6529 "groupTitle": "Cm_Hopper_Black"
6533 "url": "/api/cm/hopper_black/{id}",
6534 "title": "Update an existing Hopper Black",
6537 "title": "Example usage:",
6538 "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",
6542 "name": "updateHopper_Black",
6543 "group": "Cm_Hopper_Black",
6544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6546 "filename": "server/api/cmHopperBlack/index.js",
6547 "groupTitle": "Cm_Hopper_Black"
6551 "url": "/api/cm/hopper_final/checkContactHopper",
6552 "title": "Check if contact is in hopper",
6555 "title": "Example usage:",
6556 "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",
6560 "name": "/checkContactHopper",
6561 "group": "Cm_Hopper_Final",
6562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6564 "filename": "server/api/cmHopperFinal/index.js",
6565 "groupTitle": "Cm_Hopper_Final"
6569 "url": "/api/cm/hopper_final/describe",
6570 "title": "Gets table info about HopperFinal",
6573 "title": "Example usage:",
6574 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6578 "name": "DescribeHopperFinal",
6579 "group": "Cm_Hopper_Final",
6580 "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>",
6582 "filename": "server/api/cmHopperFinal/index.js",
6583 "groupTitle": "Cm_Hopper_Final"
6587 "url": "/api/cm/hopper_final",
6588 "title": "Gets a list of HopperFinal",
6591 "title": "Example usage:",
6592 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6596 "name": "GetHopperFinal",
6597 "group": "Cm_Hopper_Final",
6598 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6600 "filename": "server/api/cmHopperFinal/index.js",
6601 "groupTitle": "Cm_Hopper_Final"
6605 "url": "/api/cm/hopper_final/{id}",
6606 "title": "Gets a single HopperFinal",
6609 "title": "Example usage:",
6610 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6614 "name": "ShowHopperFinal",
6615 "group": "Cm_Hopper_Final",
6616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6618 "filename": "server/api/cmHopperFinal/index.js",
6619 "groupTitle": "Cm_Hopper_Final"
6623 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6624 "title": "Return number contacts for attributes",
6627 "title": "Example usage:",
6628 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6632 "name": "countContactsIvrCampaignHopperFinal",
6633 "group": "Cm_Hopper_Final",
6634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6636 "filename": "server/api/cmHopperFinal/index.js",
6637 "groupTitle": "Cm_Hopper_Final"
6641 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6642 "title": "Return number contacts for attributes",
6645 "title": "Example usage:",
6646 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6650 "name": "countContactsQueueCampaignHopperFinal",
6651 "group": "Cm_Hopper_Final",
6652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6654 "filename": "server/api/cmHopperFinal/index.js",
6655 "groupTitle": "Cm_Hopper_Final"
6659 "url": "/api/cm/hopper_final/campaign/{id}",
6660 "title": "Move contacts in hopper",
6663 "title": "Example usage:",
6664 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6668 "name": "moveContactsIvrCampaignHopperFinal",
6669 "group": "Cm_Hopper_Final",
6670 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6672 "filename": "server/api/cmHopperFinal/index.js",
6673 "groupTitle": "Cm_Hopper_Final"
6677 "url": "/api/cm/hopper_final/voice/queue/{id}",
6678 "title": "Move contacts in hopper",
6681 "title": "Example usage:",
6682 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6686 "name": "moveContactsQueueCampaignHopperFinal",
6687 "group": "Cm_Hopper_Final",
6688 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6690 "filename": "server/api/cmHopperFinal/index.js",
6691 "groupTitle": "Cm_Hopper_Final"
6695 "url": "/api/cm/hopper_final/{id}",
6696 "title": "Update a single hopper final",
6699 "title": "Example usage:",
6700 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6705 "group": "Cm_Hopper_Final",
6706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6708 "filename": "server/api/cmHopperFinal/index.js",
6709 "groupTitle": "Cm_Hopper_Final"
6713 "url": "/api/cm/hopper_history",
6714 "title": "Creates a new HopperHistory",
6717 "title": "Example usage:",
6718 "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",
6722 "name": "CreateHopperHistory",
6723 "group": "Cm_Hopper_History",
6738 "field": "statedesc",
6745 "field": "scheduledat",
6752 "field": "countbusyretry",
6759 "field": "countcongestionretry",
6766 "field": "countnoanswerretry",
6773 "field": "countglobal",
6780 "field": "uniqueid",
6787 "field": "originatecalleridnum",
6794 "field": "originatecalleridname",
6801 "field": "calleridnum",
6808 "field": "calleridname",
6815 "field": "starttime",
6822 "field": "responsetime",
6829 "field": "answertime",
6836 "field": "droptime",
6850 "field": "ringtime",
6857 "field": "holdtime",
6864 "field": "talktime",
6871 "field": "followuptime",
6878 "field": "dropreason",
6885 "field": "campaign",
6892 "field": "campaigntype",
6899 "field": "membername",
6927 "field": "callback",
6934 "field": "callbackuniqueid",
6941 "field": "callbackat",
6948 "field": "recallme",
6955 "field": "editedat",
6969 "field": "countnosuchnumberretry",
6976 "field": "countdropretry",
6983 "field": "countabandonedretry",
6990 "field": "countmachineretry",
6997 "field": "countagentrejectretry",
7003 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7005 "filename": "server/api/cmHopperHistory/index.js",
7006 "groupTitle": "Cm_Hopper_History"
7010 "url": "/api/cm/hopper_history/describe",
7011 "title": "Gets table info about HopperHistory",
7014 "title": "Example usage:",
7015 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7019 "name": "DescribeHopperHistory",
7020 "group": "Cm_Hopper_History",
7021 "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>",
7023 "filename": "server/api/cmHopperHistory/index.js",
7024 "groupTitle": "Cm_Hopper_History"
7028 "url": "/api/cm/hopper_history",
7029 "title": "Gets a list of HopperHistory",
7032 "title": "Example usage:",
7033 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7037 "name": "GetHopperHistory",
7038 "group": "Cm_Hopper_History",
7039 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7041 "filename": "server/api/cmHopperHistory/index.js",
7042 "groupTitle": "Cm_Hopper_History"
7046 "url": "/api/cm/hopper_history/{id}",
7047 "title": "Gets a single HopperHistory",
7050 "title": "Example usage:",
7051 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7055 "name": "ShowHopperHistory",
7056 "group": "Cm_Hopper_History",
7057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7059 "filename": "server/api/cmHopperHistory/index.js",
7060 "groupTitle": "Cm_Hopper_History"
7064 "url": "/api/cm/hopper_history/{id}",
7065 "title": "Update a single hopper history",
7068 "title": "Example usage:",
7069 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7074 "group": "Cm_Hopper_History",
7075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7077 "filename": "server/api/cmHopperHistory/index.js",
7078 "groupTitle": "Cm_Hopper_History"
7082 "url": "/api/cm/hopper/{id}",
7083 "title": "Delete Hopper",
7086 "title": "Example usage:",
7087 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7092 "group": "Cm_Hopper",
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/cmHopper/index.js",
7096 "groupTitle": "Cm_Hopper"
7100 "url": "/api/cm/hopper/opencontacts",
7101 "title": "Gets Open Contacts",
7104 "title": "Example usage:",
7105 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7109 "name": "getOpenContacts",
7110 "group": "Cm_Hopper",
7111 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7113 "filename": "server/api/cmHopper/index.js",
7114 "groupTitle": "Cm_Hopper"
7118 "url": "/api/cm/hopper/preview",
7119 "title": "Gets Preview Dialer Contacts",
7122 "title": "Example usage:",
7123 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7127 "name": "getPreview",
7128 "group": "Cm_Hopper",
7129 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7131 "filename": "server/api/cmHopper/index.js",
7132 "groupTitle": "Cm_Hopper"
7136 "url": "/api/cm/hopper/{id}",
7137 "title": "Update an existing Hopper",
7140 "title": "Example usage:",
7141 "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",
7145 "name": "updateHopper",
7146 "group": "Cm_Hopper",
7147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7149 "filename": "server/api/cmHopper/index.js",
7150 "groupTitle": "Cm_Hopper"
7154 "url": "/api/cm/lists",
7155 "title": "Creates a new List",
7158 "title": "Example usage:",
7159 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7163 "name": "CreateLists",
7164 "group": "Cm_Lists",
7179 "field": "description",
7186 "field": "dialPrefix",
7192 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7194 "filename": "server/api/cmList/index.js",
7195 "groupTitle": "Cm_Lists"
7199 "url": "/api/cm/lists/{id}",
7200 "title": "Deletes a List",
7203 "title": "Example usage:",
7204 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7208 "name": "DeleteLists",
7209 "group": "Cm_Lists",
7210 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7212 "filename": "server/api/cmList/index.js",
7213 "groupTitle": "Cm_Lists"
7217 "url": "/api/cm/lists/describe",
7218 "title": "Gets table info about Lists",
7221 "title": "Example usage:",
7222 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7226 "name": "DescribeLists",
7227 "group": "Cm_Lists",
7228 "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>",
7230 "filename": "server/api/cmList/index.js",
7231 "groupTitle": "Cm_Lists"
7235 "url": "/api/cm/lists/{id}/users",
7236 "title": "Gets agents from list",
7239 "title": "Example usage:",
7240 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7244 "name": "GetAgents",
7245 "group": "Cm_Lists",
7246 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7248 "filename": "server/api/cmList/index.js",
7249 "groupTitle": "Cm_Lists"
7253 "url": "/api/cm/lists",
7254 "title": "Gets a list of Lists",
7257 "title": "Example usage:",
7258 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7263 "group": "Cm_Lists",
7264 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7266 "filename": "server/api/cmList/index.js",
7267 "groupTitle": "Cm_Lists"
7271 "url": "/api/cm/lists/{id}/users",
7272 "title": "Removes agents from a list",
7275 "title": "Example usage:",
7276 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7280 "name": "RemoveAgents",
7281 "group": "Cm_Lists",
7282 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7284 "filename": "server/api/cmList/index.js",
7285 "groupTitle": "Cm_Lists"
7289 "url": "/api/cm/lists/{id}/dispositions",
7290 "title": "Removes dispositions from account",
7293 "title": "Example usage:",
7294 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7298 "name": "RemoveDispositions",
7299 "group": "Cm_Lists",
7300 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7302 "filename": "server/api/cmList/index.js",
7303 "groupTitle": "Cm_Lists"
7307 "url": "/api/cm/lists/{id}",
7308 "title": "Gets a single List",
7311 "title": "Example usage:",
7312 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7316 "name": "ShowLists",
7317 "group": "Cm_Lists",
7318 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7320 "filename": "server/api/cmList/index.js",
7321 "groupTitle": "Cm_Lists"
7325 "url": "/api/cm/lists/{id}/users",
7326 "title": "Adds agents to a list",
7329 "title": "Example usage:",
7330 "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",
7334 "name": "addAgents",
7335 "group": "Cm_Lists",
7336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7338 "filename": "server/api/cmList/index.js",
7339 "groupTitle": "Cm_Lists"
7343 "url": "/api/cm/lists/{id}/contacts",
7344 "title": "Creates new contacts",
7347 "title": "Example usage:",
7348 "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",
7352 "name": "addContacts",
7353 "group": "Cm_Lists",
7361 "field": "firstName",
7368 "field": "lastName",
7382 "field": "postalCode",
7403 "field": "dateOfBirth",
7410 "field": "description",
7452 "field": "facebook",
7508 "field": "telegram",
7522 "field": "priority",
7529 "field": "scheduledat",
7535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7537 "filename": "server/api/cmList/index.js",
7538 "groupTitle": "Cm_Lists"
7542 "url": "/api/cm/lists/{id}/fields",
7543 "title": "Creates a new custom field",
7546 "title": "Example usage:",
7547 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7551 "name": "addCustomField",
7552 "group": "Cm_Lists",
7553 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7555 "filename": "server/api/cmList/index.js",
7556 "groupTitle": "Cm_Lists"
7560 "url": "/api/cm/lists/{id}/dispositions",
7561 "title": "Creates new disposition",
7564 "title": "Example usage:",
7565 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7569 "name": "addDisposition",
7570 "group": "Cm_Lists",
7597 "field": "description",
7603 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7605 "filename": "server/api/cmList/index.js",
7606 "groupTitle": "Cm_Lists"
7610 "url": "/api/cm/lists/{id}/contacts",
7611 "title": "Gets List Contacts",
7614 "title": "Example usage:",
7615 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7619 "name": "getContacts",
7620 "group": "Cm_Lists",
7621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7623 "filename": "server/api/cmList/index.js",
7624 "groupTitle": "Cm_Lists"
7628 "url": "/api/cm/lists/{id}/fields",
7629 "title": "Gets Custom Fields",
7632 "title": "Example usage:",
7633 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7637 "name": "getCustomFields",
7638 "group": "Cm_Lists",
7639 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7641 "filename": "server/api/cmList/index.js",
7642 "groupTitle": "Cm_Lists"
7646 "url": "/api/cm/lists/{id}/dispositions",
7647 "title": "Gets list dispositions",
7650 "title": "Example usage:",
7651 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7655 "name": "getDispositions",
7656 "group": "Cm_Lists",
7657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7659 "filename": "server/api/cmList/index.js",
7660 "groupTitle": "Cm_Lists"
7664 "url": "/api/cm/lists/{id}/contacts/csv",
7665 "title": "Gets CSV List Contacts",
7668 "title": "Example usage:",
7669 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7674 "group": "Cm_Lists",
7675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7677 "filename": "server/api/cmList/index.js",
7678 "groupTitle": "Cm_Lists"
7682 "url": "/api/cm/lists/{id}",
7683 "title": "Update an existing List",
7686 "title": "Example usage:",
7687 "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",
7691 "name": "updateLists",
7692 "group": "Cm_Lists",
7693 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7695 "filename": "server/api/cmList/index.js",
7696 "groupTitle": "Cm_Lists"
7700 "url": "/api/cm/contacts/upload/:id",
7701 "title": "Import new contacts by csv",
7704 "title": "Example usage:",
7705 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7710 "group": "Cm_contacts",
7711 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7713 "filename": "server/api/cmContact/index.js",
7714 "groupTitle": "Cm_contacts"
7718 "url": "/api/cm/contacts/upload",
7719 "title": "Upload csv",
7722 "title": "Example usage:",
7723 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7728 "group": "Cm_contacts",
7729 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7731 "filename": "server/api/cmContact/index.js",
7732 "groupTitle": "Cm_contacts"
7736 "url": "/api/cm/contacts/csv",
7737 "title": "Create new contacts by csv",
7740 "title": "Example usage:",
7741 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7745 "name": "uploadCsv",
7746 "group": "Cm_contacts",
7747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7749 "filename": "server/api/cmContact/index.js",
7750 "groupTitle": "Cm_contacts"
7754 "url": "/api/conditions/{id}",
7755 "title": "Deletes a Condition",
7758 "title": "Example usage:",
7759 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7763 "name": "DeleteConditions",
7764 "group": "Conditions",
7765 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7767 "filename": "server/api/condition/index.js",
7768 "groupTitle": "Conditions"
7772 "url": "/api/conditions/{id}",
7773 "title": "Update an existing Condition",
7776 "title": "Example usage:",
7777 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7781 "name": "updateConditions",
7782 "group": "Conditions",
7783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7785 "filename": "server/api/condition/index.js",
7786 "groupTitle": "Conditions"
7790 "url": "/api/cm/custom_field",
7791 "title": "Create a new custom field",
7794 "title": "Example usage:",
7795 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7799 "name": "CreateCustomField",
7800 "group": "Custom_Fields",
7801 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7803 "filename": "server/api/cmCustomField/index.js",
7804 "groupTitle": "Custom_Fields"
7808 "url": "/api/dashboards/items",
7809 "title": "Create dasboard item",
7812 "title": "Example usage:",
7813 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7818 "group": "Dashboard_Items",
7819 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7821 "filename": "server/api/dashboardItem/index.js",
7822 "groupTitle": "Dashboard_Items"
7826 "url": "/api/dashboards/items/{id}",
7827 "title": "Deletes a Dashboard Item",
7830 "title": "Example usage:",
7831 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7835 "name": "DeleteDashboard_Items",
7836 "group": "Dashboard_Items",
7837 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7839 "filename": "server/api/dashboardItem/index.js",
7840 "groupTitle": "Dashboard_Items"
7844 "url": "/api/dashboards/items/{id}",
7845 "title": "Gets a single Dashboard Item",
7848 "title": "Example usage:",
7849 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7853 "name": "ShowDashboard_Items",
7854 "group": "Dashboard_Items",
7855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7857 "filename": "server/api/dashboardItem/index.js",
7858 "groupTitle": "Dashboard_Items"
7862 "url": "/api/dashboards/items/{id}",
7863 "title": "Update an existing item",
7866 "title": "Example usage:",
7867 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7872 "group": "Dashboard_Items",
7873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7875 "filename": "server/api/dashboardItem/index.js",
7876 "groupTitle": "Dashboard_Items"
7880 "url": "/api/dashboards/clone",
7881 "title": "Clone an existing Dashboard",
7884 "title": "Example usage:",
7885 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7889 "name": "CloneDashboards",
7890 "group": "Dashboards",
7891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7893 "filename": "server/api/dashboard/index.js",
7894 "groupTitle": "Dashboards"
7898 "url": "/api/dashboards",
7899 "title": "Creates a new Dashboard",
7902 "title": "Example usage:",
7903 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7907 "name": "CreateDashboards",
7908 "group": "Dashboards",
7923 "field": "description",
7929 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7931 "filename": "server/api/dashboard/index.js",
7932 "groupTitle": "Dashboards"
7936 "url": "/api/dashboards/{id}",
7937 "title": "Deletes a Dashboard",
7940 "title": "Example usage:",
7941 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7945 "name": "DeleteDashboards",
7946 "group": "Dashboards",
7947 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7949 "filename": "server/api/dashboard/index.js",
7950 "groupTitle": "Dashboards"
7954 "url": "/api/dashboards",
7955 "title": "Gets a list of Dashboards",
7958 "title": "Example usage:",
7959 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7963 "name": "GetDashboards",
7964 "group": "Dashboards",
7965 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7967 "filename": "server/api/dashboard/index.js",
7968 "groupTitle": "Dashboards"
7972 "url": "/api/dashboards/{id}",
7973 "title": "Gets a single Dashboard",
7976 "title": "Example usage:",
7977 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
7981 "name": "ShowDashboards",
7982 "group": "Dashboards",
7983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7985 "filename": "server/api/dashboard/index.js",
7986 "groupTitle": "Dashboards"
7990 "url": "/api/dashboards/{id}/items",
7991 "title": "Creates new item",
7994 "title": "Example usage:",
7995 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8000 "group": "Dashboards",
8001 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8003 "filename": "server/api/dashboard/index.js",
8004 "groupTitle": "Dashboards"
8008 "url": "/api/dashboards/{id}/items",
8009 "title": "Gets items",
8012 "title": "Example usage:",
8013 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8018 "group": "Dashboards",
8019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8021 "filename": "server/api/dashboard/index.js",
8022 "groupTitle": "Dashboards"
8026 "url": "/api/dashboards/{id}",
8027 "title": "Update an existing Dashboard",
8030 "title": "Example usage:",
8031 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8035 "name": "updateDashboards",
8036 "group": "Dashboards",
8037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8039 "filename": "server/api/dashboard/index.js",
8040 "groupTitle": "Dashboards"
8044 "url": "/api/integrations/desk/accounts",
8045 "title": "Creates a new Desk Account",
8048 "title": "Example usage:",
8049 "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",
8053 "name": "CreateDesk_Accounts",
8054 "group": "Desk_Accounts",
8069 "field": "description",
8076 "field": "username",
8083 "field": "remoteUri",
8093 "field": "authType",
8100 "field": "password",
8107 "field": "consumerKey",
8114 "field": "consumerSecret",
8128 "field": "tokenSecret",
8135 "field": "serverUrl",
8142 "\"integrationTab\"",
8152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8154 "filename": "server/api/intDeskAccount/index.js",
8155 "groupTitle": "Desk_Accounts"
8159 "url": "/api/integrations/desk/accounts/{id}",
8160 "title": "Deletes a Desk Account",
8163 "title": "Example usage:",
8164 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8168 "name": "DeleteDesk_Accounts",
8169 "group": "Desk_Accounts",
8170 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8172 "filename": "server/api/intDeskAccount/index.js",
8173 "groupTitle": "Desk_Accounts"
8177 "url": "/api/integrations/desk/accounts",
8178 "title": "Gets a list of Desk Accounts",
8181 "title": "Example usage:",
8182 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8186 "name": "GetDesk_Accounts",
8187 "group": "Desk_Accounts",
8188 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8190 "filename": "server/api/intDeskAccount/index.js",
8191 "groupTitle": "Desk_Accounts"
8195 "url": "/api/integrations/desk/accounts/{id}",
8196 "title": "Gets a single Desk Account",
8199 "title": "Example usage:",
8200 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8204 "name": "ShowDesk_Accounts",
8205 "group": "Desk_Accounts",
8206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8208 "filename": "server/api/intDeskAccount/index.js",
8209 "groupTitle": "Desk_Accounts"
8213 "url": "/api/integrations/desk/accounts/{id}/configurations",
8214 "title": "Creates new configuration",
8217 "title": "Example usage:",
8218 "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",
8222 "name": "addConfiguration",
8223 "group": "Desk_Accounts",
8224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8226 "filename": "server/api/intDeskAccount/index.js",
8227 "groupTitle": "Desk_Accounts"
8231 "url": "/api/integrations/desk/accounts/{id}/configurations",
8232 "title": "Gets account configurations",
8235 "title": "Example usage:",
8236 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8240 "name": "getConfigurations",
8241 "group": "Desk_Accounts",
8242 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8244 "filename": "server/api/intDeskAccount/index.js",
8245 "groupTitle": "Desk_Accounts"
8249 "url": "/api/integrations/desk/accounts/{id}/fields",
8250 "title": "Gets account fields",
8253 "title": "Example usage:",
8254 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8258 "name": "getFields",
8259 "group": "Desk_Accounts",
8260 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8262 "filename": "server/api/intDeskAccount/index.js",
8263 "groupTitle": "Desk_Accounts"
8267 "url": "/api/integrations/desk/accounts/{id}",
8268 "title": "Update an existing Desk Account",
8271 "title": "Example usage:",
8272 "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",
8276 "name": "updateDesk_Accounts",
8277 "group": "Desk_Accounts",
8278 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8280 "filename": "server/api/intDeskAccount/index.js",
8281 "groupTitle": "Desk_Accounts"
8285 "url": "/api/integrations/desk/configurations",
8286 "title": "Creates a new Desk Configuration",
8289 "title": "Example usage:",
8290 "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",
8294 "name": "CreateDesk_Configurations",
8295 "group": "Desk_Configurations",
8310 "field": "description",
8316 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8318 "filename": "server/api/intDeskConfiguration/index.js",
8319 "groupTitle": "Desk_Configurations"
8323 "url": "/api/integrations/desk/configurations/{id}",
8324 "title": "Deletes a Desk Configuration",
8327 "title": "Example usage:",
8328 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8332 "name": "DeleteDesk_Configurations",
8333 "group": "Desk_Configurations",
8334 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8336 "filename": "server/api/intDeskConfiguration/index.js",
8337 "groupTitle": "Desk_Configurations"
8341 "url": "/api/integrations/desk/configurations",
8342 "title": "Gets a list of Desk Configurations",
8345 "title": "Example usage:",
8346 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8350 "name": "GetDesk_Configurations",
8351 "group": "Desk_Configurations",
8352 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8354 "filename": "server/api/intDeskConfiguration/index.js",
8355 "groupTitle": "Desk_Configurations"
8359 "url": "/api/integrations/desk/configurations/{id}",
8360 "title": "Gets a single Desk Configuration",
8363 "title": "Example usage:",
8364 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8368 "name": "ShowDesk_Configurations",
8369 "group": "Desk_Configurations",
8370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8372 "filename": "server/api/intDeskConfiguration/index.js",
8373 "groupTitle": "Desk_Configurations"
8377 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8378 "title": "Gets configurations descriptions",
8381 "title": "Example usage:",
8382 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8386 "name": "getDescriptions",
8387 "group": "Desk_Configurations",
8388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8390 "filename": "server/api/intDeskConfiguration/index.js",
8391 "groupTitle": "Desk_Configurations"
8395 "url": "/api/integrations/desk/configurations/{id}/fields",
8396 "title": "Gets configurations fields",
8399 "title": "Example usage:",
8400 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8404 "name": "getFields",
8405 "group": "Desk_Configurations",
8406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8408 "filename": "server/api/intDeskConfiguration/index.js",
8409 "groupTitle": "Desk_Configurations"
8413 "url": "/api/integrations/desk/configurations/{id}/subjects",
8414 "title": "Gets configurations subjects",
8417 "title": "Example usage:",
8418 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8422 "name": "getSubjects",
8423 "group": "Desk_Configurations",
8424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8426 "filename": "server/api/intDeskConfiguration/index.js",
8427 "groupTitle": "Desk_Configurations"
8431 "url": "/api/integrations/desk/configurations/{id}/tags",
8432 "title": "Gets configurations tags",
8435 "title": "Example usage:",
8436 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8441 "group": "Desk_Configurations",
8442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8444 "filename": "server/api/intDeskConfiguration/index.js",
8445 "groupTitle": "Desk_Configurations"
8449 "url": "/api/integrations/desk/configurations/{id}/tags",
8450 "title": "Sets new tags",
8453 "title": "Example usage:",
8454 "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",
8459 "group": "Desk_Configurations",
8460 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8462 "filename": "server/api/intDeskConfiguration/index.js",
8463 "groupTitle": "Desk_Configurations"
8467 "url": "/api/integrations/desk/configurations/{id}",
8468 "title": "Update an existing Desk Configuration",
8471 "title": "Example usage:",
8472 "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",
8476 "name": "updateDesk_Configurations",
8477 "group": "Desk_Configurations",
8478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8480 "filename": "server/api/intDeskConfiguration/index.js",
8481 "groupTitle": "Desk_Configurations"
8485 "url": "/api/integrations/desk/fields",
8486 "title": "Creates a new Desk Field",
8489 "title": "Example usage:",
8490 "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",
8494 "name": "CreateDesk_Fields",
8495 "group": "Desk_Fields",
8505 "\"customVariable\"",
8532 "\"customVariable\""
8542 "field": "keyContent",
8556 "field": "nameField",
8563 "field": "customField",
8570 "field": "variableName",
8576 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8578 "filename": "server/api/intDeskField/index.js",
8579 "groupTitle": "Desk_Fields"
8583 "url": "/api/integrations/desk/fields/{id}",
8584 "title": "Deletes a Desk Field",
8587 "title": "Example usage:",
8588 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8592 "name": "DeleteDesk_Fields",
8593 "group": "Desk_Fields",
8594 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8596 "filename": "server/api/intDeskField/index.js",
8597 "groupTitle": "Desk_Fields"
8601 "url": "/api/integrations/desk/fields",
8602 "title": "Gets a list of Desk Fields",
8605 "title": "Example usage:",
8606 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8610 "name": "GetDesk_Fields",
8611 "group": "Desk_Fields",
8612 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8614 "filename": "server/api/intDeskField/index.js",
8615 "groupTitle": "Desk_Fields"
8619 "url": "/api/integrations/desk/fields/{id}",
8620 "title": "Gets a single Desk Field",
8623 "title": "Example usage:",
8624 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8628 "name": "ShowDesk_Fields",
8629 "group": "Desk_Fields",
8630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8632 "filename": "server/api/intDeskField/index.js",
8633 "groupTitle": "Desk_Fields"
8637 "url": "/api/integrations/desk/fields/{id}",
8638 "title": "Update an existing Desk Field",
8641 "title": "Example usage:",
8642 "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",
8646 "name": "updateDesk_Fields",
8647 "group": "Desk_Fields",
8648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8650 "filename": "server/api/intDeskField/index.js",
8651 "groupTitle": "Desk_Fields"
8655 "url": "/api/dispositions",
8656 "title": "Creates a new Disposition",
8659 "title": "Example usage:",
8660 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8664 "name": "CreateDispositions",
8665 "group": "Dispositions",
8692 "field": "description",
8698 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8700 "filename": "server/api/disposition/index.js",
8701 "groupTitle": "Dispositions"
8705 "url": "/api/dispositions/{id}",
8706 "title": "Deletes a Disposition",
8709 "title": "Example usage:",
8710 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8714 "name": "DeleteDispositions",
8715 "group": "Dispositions",
8716 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8718 "filename": "server/api/disposition/index.js",
8719 "groupTitle": "Dispositions"
8723 "url": "/api/dispositions",
8724 "title": "Gets a list of Dispositions",
8727 "title": "Example usage:",
8728 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8732 "name": "GetDispositions",
8733 "group": "Dispositions",
8734 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8736 "filename": "server/api/disposition/index.js",
8737 "groupTitle": "Dispositions"
8741 "url": "/api/dispositions/{id}",
8742 "title": "Gets a single Disposition",
8745 "title": "Example usage:",
8746 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8750 "name": "ShowDispositions",
8751 "group": "Dispositions",
8752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8754 "filename": "server/api/disposition/index.js",
8755 "groupTitle": "Dispositions"
8759 "url": "/api/dispositions/{id}",
8760 "title": "Update an existing Disposition",
8763 "title": "Example usage:",
8764 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8768 "name": "updateDispositions",
8769 "group": "Dispositions",
8770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8772 "filename": "server/api/disposition/index.js",
8773 "groupTitle": "Dispositions"
8777 "url": "/api/integrations/dynamics365/accounts",
8778 "title": "Creates a new Dynamics365 Account",
8781 "title": "Example usage:",
8782 "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",
8786 "name": "CreateDynamics365_Accounts",
8787 "group": "Dynamics365_Accounts",
8802 "field": "username",
8809 "field": "password",
8816 "field": "remoteUri",
8823 "field": "tenantId",
8830 "field": "clientId",
8837 "field": "clientSecret",
8844 "field": "serverUrl",
8851 "field": "description",
8857 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8859 "filename": "server/api/intDynamics365Account/index.js",
8860 "groupTitle": "Dynamics365_Accounts"
8864 "url": "/api/integrations/dynamics365/accounts/{id}",
8865 "title": "Deletes a Dynamics365 Account",
8868 "title": "Example usage:",
8869 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8873 "name": "DeleteDynamics365_Accounts",
8874 "group": "Dynamics365_Accounts",
8875 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8877 "filename": "server/api/intDynamics365Account/index.js",
8878 "groupTitle": "Dynamics365_Accounts"
8882 "url": "/api/integrations/dynamics365/accounts",
8883 "title": "Gets a list of Dynamics365 Accounts",
8886 "title": "Example usage:",
8887 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8891 "name": "GetDynamics365_Accounts",
8892 "group": "Dynamics365_Accounts",
8893 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8895 "filename": "server/api/intDynamics365Account/index.js",
8896 "groupTitle": "Dynamics365_Accounts"
8900 "url": "/api/integrations/dynamics365/accounts/{id}",
8901 "title": "Gets a single Dynamics365 Account",
8904 "title": "Example usage:",
8905 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8909 "name": "ShowDynamics365_Accounts",
8910 "group": "Dynamics365_Accounts",
8911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8913 "filename": "server/api/intDynamics365Account/index.js",
8914 "groupTitle": "Dynamics365_Accounts"
8918 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8919 "title": "Creates new configuration",
8922 "title": "Example usage:",
8923 "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",
8927 "name": "addConfiguration",
8928 "group": "Dynamics365_Accounts",
8929 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8931 "filename": "server/api/intDynamics365Account/index.js",
8932 "groupTitle": "Dynamics365_Accounts"
8936 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8937 "title": "Gets account configurations",
8940 "title": "Example usage:",
8941 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8945 "name": "getConfigurations",
8946 "group": "Dynamics365_Accounts",
8947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8949 "filename": "server/api/intDynamics365Account/index.js",
8950 "groupTitle": "Dynamics365_Accounts"
8954 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8955 "title": "Gets account fields",
8958 "title": "Example usage:",
8959 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8963 "name": "getFields",
8964 "group": "Dynamics365_Accounts",
8965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8967 "filename": "server/api/intDynamics365Account/index.js",
8968 "groupTitle": "Dynamics365_Accounts"
8972 "url": "/api/integrations/dynamics365/accounts/{id}",
8973 "title": "Update an existing Dynamics365 Account",
8976 "title": "Example usage:",
8977 "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",
8981 "name": "updateDynamics365_Accounts",
8982 "group": "Dynamics365_Accounts",
8983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8985 "filename": "server/api/intDynamics365Account/index.js",
8986 "groupTitle": "Dynamics365_Accounts"
8990 "url": "/api/integrations/dynamics365/configurations",
8991 "title": "Creates a new Dynamics365 Configuration",
8994 "title": "Example usage:",
8995 "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",
8999 "name": "CreateDynamics365_Configurations",
9000 "group": "Dynamics365_Configurations",
9015 "field": "description",
9026 "field": "ticketType",
9032 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9034 "filename": "server/api/intDynamics365Configuration/index.js",
9035 "groupTitle": "Dynamics365_Configurations"
9039 "url": "/api/integrations/dynamics365/configurations/{id}",
9040 "title": "Deletes a Dynamics365 Configuration",
9043 "title": "Example usage:",
9044 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9048 "name": "DeleteDynamics365_Configurations",
9049 "group": "Dynamics365_Configurations",
9050 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9052 "filename": "server/api/intDynamics365Configuration/index.js",
9053 "groupTitle": "Dynamics365_Configurations"
9057 "url": "/api/integrations/dynamics365/configurations",
9058 "title": "Gets a list of Dynamics365 Configurations",
9061 "title": "Example usage:",
9062 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9066 "name": "GetDynamics365_Configurations",
9067 "group": "Dynamics365_Configurations",
9068 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9070 "filename": "server/api/intDynamics365Configuration/index.js",
9071 "groupTitle": "Dynamics365_Configurations"
9075 "url": "/api/integrations/dynamics365/configurations/{id}",
9076 "title": "Gets a single Dynamics365 Configuration",
9079 "title": "Example usage:",
9080 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9084 "name": "ShowDynamics365_Configurations",
9085 "group": "Dynamics365_Configurations",
9086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9088 "filename": "server/api/intDynamics365Configuration/index.js",
9089 "groupTitle": "Dynamics365_Configurations"
9093 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9094 "title": "Gets configurations descriptions",
9097 "title": "Example usage:",
9098 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9102 "name": "getDescriptions",
9103 "group": "Dynamics365_Configurations",
9104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9106 "filename": "server/api/intDynamics365Configuration/index.js",
9107 "groupTitle": "Dynamics365_Configurations"
9111 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9112 "title": "Gets configurations fields",
9115 "title": "Example usage:",
9116 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9120 "name": "getFields",
9121 "group": "Dynamics365_Configurations",
9122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9124 "filename": "server/api/intDynamics365Configuration/index.js",
9125 "groupTitle": "Dynamics365_Configurations"
9129 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9130 "title": "Gets configurations subjects",
9133 "title": "Example usage:",
9134 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9138 "name": "getSubjects",
9139 "group": "Dynamics365_Configurations",
9140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9142 "filename": "server/api/intDynamics365Configuration/index.js",
9143 "groupTitle": "Dynamics365_Configurations"
9147 "url": "/api/integrations/dynamics365/configurations/{id}",
9148 "title": "Update an existing Dynamics365 Configuration",
9151 "title": "Example usage:",
9152 "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",
9156 "name": "updateDynamics365_Configurations",
9157 "group": "Dynamics365_Configurations",
9158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9160 "filename": "server/api/intDynamics365Configuration/index.js",
9161 "groupTitle": "Dynamics365_Configurations"
9165 "url": "/api/integrations/dynamics365/fields",
9166 "title": "Creates a new Dynamics365 Field",
9169 "title": "Example usage:",
9170 "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",
9174 "name": "CreateDynamics365_Fields",
9175 "group": "Dynamics365_Fields",
9185 "\"customVariable\"",
9212 "\"customVariable\""
9222 "field": "keyContent",
9236 "field": "nameField",
9243 "field": "customField",
9250 "field": "variableName",
9256 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9258 "filename": "server/api/intDynamics365Field/index.js",
9259 "groupTitle": "Dynamics365_Fields"
9263 "url": "/api/integrations/dynamics365/fields/{id}",
9264 "title": "Deletes a Dynamics365 Field",
9267 "title": "Example usage:",
9268 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9272 "name": "DeleteDynamics365_Fields",
9273 "group": "Dynamics365_Fields",
9274 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9276 "filename": "server/api/intDynamics365Field/index.js",
9277 "groupTitle": "Dynamics365_Fields"
9281 "url": "/api/integrations/dynamics365/fields",
9282 "title": "Gets a list of Dynamics365 Fields",
9285 "title": "Example usage:",
9286 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9290 "name": "GetDynamics365_Fields",
9291 "group": "Dynamics365_Fields",
9292 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9294 "filename": "server/api/intDynamics365Field/index.js",
9295 "groupTitle": "Dynamics365_Fields"
9299 "url": "/api/integrations/dynamics365/fields/{id}",
9300 "title": "Gets a single Dynamics365 Field",
9303 "title": "Example usage:",
9304 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9308 "name": "ShowDynamics365_Fields",
9309 "group": "Dynamics365_Fields",
9310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9312 "filename": "server/api/intDynamics365Field/index.js",
9313 "groupTitle": "Dynamics365_Fields"
9317 "url": "/api/integrations/dynamics365/fields/{id}",
9318 "title": "Update an existing Dynamics365 Field",
9321 "title": "Example usage:",
9322 "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",
9326 "name": "updateDynamics365_Fields",
9327 "group": "Dynamics365_Fields",
9328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9330 "filename": "server/api/intDynamics365Field/index.js",
9331 "groupTitle": "Dynamics365_Fields"
9335 "url": "/api/fax/accounts/{id}/users",
9336 "title": "Add agents to a fax account",
9339 "title": "Example usage:",
9340 "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",
9344 "name": "AddAgents",
9345 "group": "Fax_Accounts",
9346 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9348 "filename": "server/api/faxAccount/index.js",
9349 "groupTitle": "Fax_Accounts"
9353 "url": "/api/fax/accounts",
9354 "title": "Creates a new Account",
9357 "title": "Example usage:",
9358 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9362 "name": "CreateAccounts",
9363 "group": "Fax_Accounts",
9378 "field": "description",
9396 "field": "headerinfo",
9403 "field": "localstationid",
9454 "field": "faxdetect",
9461 "field": "t38timeout",
9488 "field": "notificationTemplate",
9495 "field": "notificationSound",
9502 "field": "notificationShake",
9509 "field": "waitForTheAssignedAgent",
9516 "field": "queueTransfer",
9523 "field": "queueTransferTimeout",
9530 "field": "agentTransfer",
9537 "field": "agentTransferTimeout",
9544 "field": "mandatoryDispositionPauseId",
9545 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9551 "field": "mandatoryDisposition",
9552 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9557 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9559 "filename": "server/api/faxAccount/index.js",
9560 "groupTitle": "Fax_Accounts"
9564 "url": "/api/fax/accounts/{id}",
9565 "title": "Deletes a Account",
9568 "title": "Example usage:",
9569 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9573 "name": "DeleteAccounts",
9574 "group": "Fax_Accounts",
9575 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9577 "filename": "server/api/faxAccount/index.js",
9578 "groupTitle": "Fax_Accounts"
9582 "url": "/api/fax/accounts/describe",
9583 "title": "Gets table info about Accounts",
9586 "title": "Example usage:",
9587 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9591 "name": "DescribeAccounts",
9592 "group": "Fax_Accounts",
9593 "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>",
9595 "filename": "server/api/faxAccount/index.js",
9596 "groupTitle": "Fax_Accounts"
9600 "url": "/api/fax/accounts",
9601 "title": "Gets a list of Accounts",
9604 "title": "Example usage:",
9605 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9609 "name": "GetAccounts",
9610 "group": "Fax_Accounts",
9611 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9613 "filename": "server/api/faxAccount/index.js",
9614 "groupTitle": "Fax_Accounts"
9618 "url": "/api/fax/accounts/{id}/users",
9619 "title": "Gets agents from fax account",
9622 "title": "Example usage:",
9623 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9627 "name": "GetAgents",
9628 "group": "Fax_Accounts",
9629 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9631 "filename": "server/api/faxAccount/index.js",
9632 "groupTitle": "Fax_Accounts"
9636 "url": "/api/fax/accounts/{id}/users",
9637 "title": "Removes agents from a fax account",
9640 "title": "Example usage:",
9641 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9645 "name": "RemoveAgents",
9646 "group": "Fax_Accounts",
9647 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9649 "filename": "server/api/faxAccount/index.js",
9650 "groupTitle": "Fax_Accounts"
9654 "url": "/api/fax/accounts/{id}/canned_answers",
9655 "title": "Removes canned answers from account",
9658 "title": "Example usage:",
9659 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9663 "name": "RemoveAnswers",
9664 "group": "Fax_Accounts",
9665 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9667 "filename": "server/api/faxAccount/index.js",
9668 "groupTitle": "Fax_Accounts"
9672 "url": "/api/fax/accounts/{id}/dispositions",
9673 "title": "Removes dispositions from account",
9676 "title": "Example usage:",
9677 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9681 "name": "RemoveDispositions",
9682 "group": "Fax_Accounts",
9683 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9685 "filename": "server/api/faxAccount/index.js",
9686 "groupTitle": "Fax_Accounts"
9690 "url": "/api/fax/accounts/{id}",
9691 "title": "Gets a single Account",
9694 "title": "Example usage:",
9695 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9699 "name": "ShowAccounts",
9700 "group": "Fax_Accounts",
9701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9703 "filename": "server/api/faxAccount/index.js",
9704 "groupTitle": "Fax_Accounts"
9708 "url": "/api/fax/accounts/{id}/canned_answers",
9709 "title": "Creates new canned answer",
9712 "title": "Example usage:",
9713 "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",
9717 "name": "addAnswer",
9718 "group": "Fax_Accounts",
9740 "field": "description",
9753 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9755 "filename": "server/api/faxAccount/index.js",
9756 "groupTitle": "Fax_Accounts"
9760 "url": "/api/fax/accounts/addaccountapplications",
9761 "title": "Creates new account and applications",
9764 "title": "Example usage:",
9765 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9769 "name": "addApplications",
9770 "group": "Fax_Accounts",
9778 "field": "priority",
9799 "field": "description",
9806 "field": "interval",
9812 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9814 "filename": "server/api/faxAccount/index.js",
9815 "groupTitle": "Fax_Accounts"
9819 "url": "/api/fax/accounts/{id}/applications",
9820 "title": "Creates new applications",
9823 "title": "Example usage:",
9824 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9828 "name": "addApplications",
9829 "group": "Fax_Accounts",
9837 "field": "priority",
9858 "field": "description",
9865 "field": "interval",
9871 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9873 "filename": "server/api/faxAccount/index.js",
9874 "groupTitle": "Fax_Accounts"
9878 "url": "/api/fax/accounts/{id}/dispositions",
9879 "title": "Creates new disposition",
9882 "title": "Example usage:",
9883 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9887 "name": "addDisposition",
9888 "group": "Fax_Accounts",
9915 "field": "description",
9921 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9923 "filename": "server/api/faxAccount/index.js",
9924 "groupTitle": "Fax_Accounts"
9928 "url": "/api/fax/accounts/{id}/interactions",
9929 "title": "Creates new interactions",
9932 "title": "Example usage:",
9933 "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",
9937 "name": "addInteraction",
9938 "group": "Fax_Accounts",
9953 "field": "closedAt",
9960 "field": "disposition",
9967 "field": "secondDisposition",
9974 "field": "thirdDisposition",
9988 "field": "read1stAt",
10006 "field": "firstMsgDirection",
10013 "field": "lastMsgAt",
10024 "field": "lastMsgDirection",
10030 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10031 "version": "0.0.0",
10032 "filename": "server/api/faxAccount/index.js",
10033 "groupTitle": "Fax_Accounts"
10037 "url": "/api/fax/accounts/{id}/canned_answers",
10038 "title": "Gets account canned answers",
10041 "title": "Example usage:",
10042 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10046 "name": "getAnswers",
10047 "group": "Fax_Accounts",
10048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10049 "version": "0.0.0",
10050 "filename": "server/api/faxAccount/index.js",
10051 "groupTitle": "Fax_Accounts"
10055 "url": "/api/fax/accounts/{id}/applications",
10056 "title": "Gets account pplications",
10059 "title": "Example usage:",
10060 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10064 "name": "getApplications",
10065 "group": "Fax_Accounts",
10066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10067 "version": "0.0.0",
10068 "filename": "server/api/faxAccount/index.js",
10069 "groupTitle": "Fax_Accounts"
10073 "url": "/api/fax/accounts/{id}/dispositions",
10074 "title": "Gets account dispositions",
10077 "title": "Example usage:",
10078 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10082 "name": "getDispositions",
10083 "group": "Fax_Accounts",
10084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10085 "version": "0.0.0",
10086 "filename": "server/api/faxAccount/index.js",
10087 "groupTitle": "Fax_Accounts"
10091 "url": "/api/fax/accounts/{id}/interactions",
10092 "title": "Gets account interactions",
10095 "title": "Example usage:",
10096 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10100 "name": "getInteraction",
10101 "group": "Fax_Accounts",
10102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10103 "version": "0.0.0",
10104 "filename": "server/api/faxAccount/index.js",
10105 "groupTitle": "Fax_Accounts"
10109 "url": "/api/fax/accounts/{id}/messages",
10110 "title": "Gets account messages",
10113 "title": "Example usage:",
10114 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10118 "name": "getMessages",
10119 "group": "Fax_Accounts",
10120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10121 "version": "0.0.0",
10122 "filename": "server/api/faxAccount/index.js",
10123 "groupTitle": "Fax_Accounts"
10127 "url": "/api/fax/accounts/{id}/send",
10128 "title": "Send new fax",
10131 "title": "Example usage:",
10132 "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",
10137 "group": "Fax_Accounts",
10138 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10139 "version": "0.0.0",
10140 "filename": "server/api/faxAccount/index.js",
10141 "groupTitle": "Fax_Accounts"
10145 "url": "/api/fax/accounts/{id}",
10146 "title": "Update an existing Account",
10149 "title": "Example usage:",
10150 "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",
10154 "name": "updateAccounts",
10155 "group": "Fax_Accounts",
10156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10157 "version": "0.0.0",
10158 "filename": "server/api/faxAccount/index.js",
10159 "groupTitle": "Fax_Accounts"
10163 "url": "/api/fax/accounts/updateaccountapplications",
10164 "title": "Update account and applications",
10167 "title": "Example usage:",
10168 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10172 "name": "updateApplications",
10173 "group": "Fax_Accounts",
10181 "field": "priority",
10195 "field": "appdata",
10202 "field": "description",
10209 "field": "interval",
10215 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10216 "version": "0.0.0",
10217 "filename": "server/api/faxAccount/index.js",
10218 "groupTitle": "Fax_Accounts"
10222 "url": "/api/fax/applications",
10223 "title": "Creates a new Application",
10226 "title": "Example usage:",
10227 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10231 "name": "CreateApplications",
10232 "group": "Fax_Applications",
10240 "field": "priority",
10254 "field": "appdata",
10261 "field": "description",
10268 "field": "interval",
10274 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10275 "version": "0.0.0",
10276 "filename": "server/api/faxApplication/index.js",
10277 "groupTitle": "Fax_Applications"
10281 "url": "/api/fax/applications/{id}",
10282 "title": "Deletes a Application",
10285 "title": "Example usage:",
10286 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10290 "name": "DeleteApplications",
10291 "group": "Fax_Applications",
10292 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10293 "version": "0.0.0",
10294 "filename": "server/api/faxApplication/index.js",
10295 "groupTitle": "Fax_Applications"
10299 "url": "/api/fax/applications",
10300 "title": "Gets a list of Applications",
10303 "title": "Example usage:",
10304 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10308 "name": "GetApplications",
10309 "group": "Fax_Applications",
10310 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10311 "version": "0.0.0",
10312 "filename": "server/api/faxApplication/index.js",
10313 "groupTitle": "Fax_Applications"
10317 "url": "/api/fax/applications/{id}",
10318 "title": "Gets a single Application",
10321 "title": "Example usage:",
10322 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10326 "name": "ShowApplications",
10327 "group": "Fax_Applications",
10328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10329 "version": "0.0.0",
10330 "filename": "server/api/faxApplication/index.js",
10331 "groupTitle": "Fax_Applications"
10335 "url": "/api/fax/applications/{id}",
10336 "title": "Update an existing Application",
10339 "title": "Example usage:",
10340 "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",
10344 "name": "updateApplications",
10345 "group": "Fax_Applications",
10346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10347 "version": "0.0.0",
10348 "filename": "server/api/faxApplication/index.js",
10349 "groupTitle": "Fax_Applications"
10353 "url": "/api/fax/interactions/{id}/tags",
10354 "title": "Add tags to the interaction",
10357 "title": "Example usage:",
10358 "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",
10363 "group": "Fax_Interactions",
10364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10365 "version": "0.0.0",
10366 "filename": "server/api/faxInteraction/index.js",
10367 "groupTitle": "Fax_Interactions"
10371 "url": "/api/fax/interactions",
10372 "title": "Creates a new Interaction",
10375 "title": "Example usage:",
10376 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10380 "name": "CreateInteractions",
10381 "group": "Fax_Interactions",
10396 "field": "closedAt",
10403 "field": "disposition",
10410 "field": "secondDisposition",
10417 "field": "thirdDisposition",
10431 "field": "read1stAt",
10449 "field": "firstMsgDirection",
10456 "field": "lastMsgAt",
10467 "field": "lastMsgDirection",
10473 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10474 "version": "0.0.0",
10475 "filename": "server/api/faxInteraction/index.js",
10476 "groupTitle": "Fax_Interactions"
10480 "url": "/api/fax/interactions/{id}",
10481 "title": "Deletes a Interaction",
10484 "title": "Example usage:",
10485 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10489 "name": "DeleteInteractions",
10490 "group": "Fax_Interactions",
10491 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10492 "version": "0.0.0",
10493 "filename": "server/api/faxInteraction/index.js",
10494 "groupTitle": "Fax_Interactions"
10498 "url": "/api/fax/interactions/describe",
10499 "title": "Gets table info about Interactions",
10502 "title": "Example usage:",
10503 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10507 "name": "DescribeInteractions",
10508 "group": "Fax_Interactions",
10509 "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>",
10510 "version": "0.0.0",
10511 "filename": "server/api/faxInteraction/index.js",
10512 "groupTitle": "Fax_Interactions"
10516 "url": "/api/fax/interactions",
10517 "title": "Gets a list of Interactions",
10520 "title": "Example usage:",
10521 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10525 "name": "GetInteractions",
10526 "group": "Fax_Interactions",
10527 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10528 "version": "0.0.0",
10529 "filename": "server/api/faxInteraction/index.js",
10530 "groupTitle": "Fax_Interactions"
10534 "url": "/api/fax/interactions/{id}/tags",
10535 "title": "Removes tags from interaction",
10538 "title": "Example usage:",
10539 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10543 "name": "RemoveTags",
10544 "group": "Fax_Interactions",
10545 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10546 "version": "0.0.0",
10547 "filename": "server/api/faxInteraction/index.js",
10548 "groupTitle": "Fax_Interactions"
10552 "url": "/api/fax/interactions/{id}",
10553 "title": "Gets a single Interaction",
10556 "title": "Example usage:",
10557 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10561 "name": "ShowInteractions",
10562 "group": "Fax_Interactions",
10563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10564 "version": "0.0.0",
10565 "filename": "server/api/faxInteraction/index.js",
10566 "groupTitle": "Fax_Interactions"
10570 "url": "/api/fax/interactions/{id}/messages",
10571 "title": "Creates new messages",
10574 "title": "Example usage:",
10575 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10579 "name": "addMessage",
10580 "group": "Fax_Interactions",
10606 "field": "direction",
10613 "field": "failMessage",
10626 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10627 "version": "0.0.0",
10628 "filename": "server/api/faxInteraction/index.js",
10629 "groupTitle": "Fax_Interactions"
10633 "url": "/api/fax/interactions/{id}/download",
10634 "title": "Get interactions",
10637 "title": "Example usage:",
10638 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10642 "name": "download",
10643 "group": "Fax_Interactions",
10644 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10645 "version": "0.0.0",
10646 "filename": "server/api/faxInteraction/index.js",
10647 "groupTitle": "Fax_Interactions"
10651 "url": "/api/fax/interactions/{id}/messages",
10652 "title": "Gets interaction messages",
10655 "title": "Example usage:",
10656 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10660 "name": "getMessages",
10661 "group": "Fax_Interactions",
10662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10663 "version": "0.0.0",
10664 "filename": "server/api/faxInteraction/index.js",
10665 "groupTitle": "Fax_Interactions"
10669 "url": "/api/fax/interactions/{id}",
10670 "title": "Update an existing Interaction",
10673 "title": "Example usage:",
10674 "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",
10678 "name": "updateInteractions",
10679 "group": "Fax_Interactions",
10680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10681 "version": "0.0.0",
10682 "filename": "server/api/faxInteraction/index.js",
10683 "groupTitle": "Fax_Interactions"
10687 "url": "/api/fax/messages/{id}/download",
10688 "title": "Get message",
10691 "title": "Example usage:",
10692 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10696 "name": "download",
10697 "group": "Fax_Message",
10698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10699 "version": "0.0.0",
10700 "filename": "server/api/faxMessage/index.js",
10701 "groupTitle": "Fax_Message"
10705 "url": "/api/fax/messages/{id}",
10706 "title": "Deletes a Message",
10709 "title": "Example usage:",
10710 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10714 "name": "DeleteMessages",
10715 "group": "Fax_Messages",
10716 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10717 "version": "0.0.0",
10718 "filename": "server/api/faxMessage/index.js",
10719 "groupTitle": "Fax_Messages"
10723 "url": "/api/fax/messages/describe",
10724 "title": "Gets table info about Messages",
10727 "title": "Example usage:",
10728 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10732 "name": "DescribeMessages",
10733 "group": "Fax_Messages",
10734 "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>",
10735 "version": "0.0.0",
10736 "filename": "server/api/faxMessage/index.js",
10737 "groupTitle": "Fax_Messages"
10741 "url": "/api/fax/messages",
10742 "title": "Gets a list of Messages",
10745 "title": "Example usage:",
10746 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10750 "name": "GetMessages",
10751 "group": "Fax_Messages",
10752 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10753 "version": "0.0.0",
10754 "filename": "server/api/faxMessage/index.js",
10755 "groupTitle": "Fax_Messages"
10759 "url": "/api/fax/messages/{id}",
10760 "title": "Gets a single Message",
10763 "title": "Example usage:",
10764 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10768 "name": "ShowMessages",
10769 "group": "Fax_Messages",
10770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10771 "version": "0.0.0",
10772 "filename": "server/api/faxMessage/index.js",
10773 "groupTitle": "Fax_Messages"
10777 "url": "/api/fax/messages/{id}/accept",
10778 "title": "Accepts message",
10781 "title": "Example usage:",
10782 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10786 "name": "acceptMessage",
10787 "group": "Fax_Messages",
10788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10789 "version": "0.0.0",
10790 "filename": "server/api/faxMessage/index.js",
10791 "groupTitle": "Fax_Messages"
10795 "url": "/api/fax/messages/{id}/reject",
10796 "title": "Rejects message",
10799 "title": "Example usage:",
10800 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10804 "name": "rejectMessage",
10805 "group": "Fax_Messages",
10806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10807 "version": "0.0.0",
10808 "filename": "server/api/faxMessage/index.js",
10809 "groupTitle": "Fax_Messages"
10813 "url": "/api/fax/messages",
10814 "title": "Create message and send Fax",
10817 "title": "Example usage:",
10818 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10822 "name": "rejectMessage",
10823 "group": "Fax_Messages",
10824 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10825 "version": "0.0.0",
10826 "filename": "server/api/faxMessage/index.js",
10827 "groupTitle": "Fax_Messages"
10831 "url": "/api/fax/messages/{id}",
10832 "title": "Update an existing Message",
10835 "title": "Example usage:",
10836 "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",
10840 "name": "updateMessages",
10841 "group": "Fax_Messages",
10842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10843 "version": "0.0.0",
10844 "filename": "server/api/faxMessage/index.js",
10845 "groupTitle": "Fax_Messages"
10849 "url": "/api/fax/reports/queue",
10850 "title": "Creates a new Fax Queue Report",
10853 "title": "Example usage:",
10854 "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",
10858 "name": "CreateFax_Queue_Reports",
10859 "group": "Fax_Queue_Reports",
10867 "field": "uniqueid",
10888 "field": "leaveAt",
10895 "field": "acceptAt",
10915 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10916 "version": "0.0.0",
10917 "filename": "server/api/faxQueueReport/index.js",
10918 "groupTitle": "Fax_Queue_Reports"
10922 "url": "/api/fax/reports/queue/{id}",
10923 "title": "Deletes a Fax Queue Report",
10926 "title": "Example usage:",
10927 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10931 "name": "DeleteFax_Queue_Reports",
10932 "group": "Fax_Queue_Reports",
10933 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10934 "version": "0.0.0",
10935 "filename": "server/api/faxQueueReport/index.js",
10936 "groupTitle": "Fax_Queue_Reports"
10940 "url": "/api/fax/reports/queue/describe",
10941 "title": "Gets table info about Fax Queue Reports",
10944 "title": "Example usage:",
10945 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10949 "name": "DescribeFax_Queue_Reports",
10950 "group": "Fax_Queue_Reports",
10951 "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>",
10952 "version": "0.0.0",
10953 "filename": "server/api/faxQueueReport/index.js",
10954 "groupTitle": "Fax_Queue_Reports"
10958 "url": "/api/fax/reports/queue",
10959 "title": "Gets a list of Fax Queue Reports",
10962 "title": "Example usage:",
10963 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10967 "name": "GetFax_Queue_Reports",
10968 "group": "Fax_Queue_Reports",
10969 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10970 "version": "0.0.0",
10971 "filename": "server/api/faxQueueReport/index.js",
10972 "groupTitle": "Fax_Queue_Reports"
10976 "url": "/api/fax/reports/queue/{id}",
10977 "title": "Gets a single Fax Queue Report",
10980 "title": "Example usage:",
10981 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
10985 "name": "ShowFax_Queue_Reports",
10986 "group": "Fax_Queue_Reports",
10987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10988 "version": "0.0.0",
10989 "filename": "server/api/faxQueueReport/index.js",
10990 "groupTitle": "Fax_Queue_Reports"
10994 "url": "/api/fax/reports/queue/{id}",
10995 "title": "Update an existing Fax Queue Report",
10998 "title": "Example usage:",
10999 "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",
11003 "name": "updateFax_Queue_Reports",
11004 "group": "Fax_Queue_Reports",
11005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11006 "version": "0.0.0",
11007 "filename": "server/api/faxQueueReport/index.js",
11008 "groupTitle": "Fax_Queue_Reports"
11012 "url": "/api/fax/queues/{id}/users",
11013 "title": "Add agents to a queue",
11016 "title": "Example usage:",
11017 "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",
11021 "name": "AddAgents",
11022 "group": "Fax_Queues",
11023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11024 "version": "0.0.0",
11025 "filename": "server/api/faxQueue/index.js",
11026 "groupTitle": "Fax_Queues"
11030 "url": "/api/fax/queues/{id}/teams",
11031 "title": "Add teams to a queue",
11034 "title": "Example usage:",
11035 "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",
11039 "name": "AddTeams",
11040 "group": "Fax_Queues",
11041 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11042 "version": "0.0.0",
11043 "filename": "server/api/faxQueue/index.js",
11044 "groupTitle": "Fax_Queues"
11048 "url": "/api/fax/queues",
11049 "title": "Creates a new Queue",
11052 "title": "Example usage:",
11053 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11057 "name": "CreateQueues",
11058 "group": "Fax_Queues",
11073 "field": "description",
11080 "field": "timeout",
11092 "field": "strategy",
11099 "field": "lastAgent",
11105 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11106 "version": "0.0.0",
11107 "filename": "server/api/faxQueue/index.js",
11108 "groupTitle": "Fax_Queues"
11112 "url": "/api/fax/queues/{id}",
11113 "title": "Deletes a Queue",
11116 "title": "Example usage:",
11117 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11121 "name": "DeleteQueues",
11122 "group": "Fax_Queues",
11123 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11124 "version": "0.0.0",
11125 "filename": "server/api/faxQueue/index.js",
11126 "groupTitle": "Fax_Queues"
11130 "url": "/api/fax/queues/describe",
11131 "title": "Gets table info about Queues",
11134 "title": "Example usage:",
11135 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11139 "name": "DescribeQueues",
11140 "group": "Fax_Queues",
11141 "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>",
11142 "version": "0.0.0",
11143 "filename": "server/api/faxQueue/index.js",
11144 "groupTitle": "Fax_Queues"
11148 "url": "/api/fax/queues/{id}/users",
11149 "title": "Gets queue agents",
11152 "title": "Example usage:",
11153 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11157 "name": "GetAgents",
11158 "group": "Fax_Queues",
11159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11160 "version": "0.0.0",
11161 "filename": "server/api/faxQueue/index.js",
11162 "groupTitle": "Fax_Queues"
11166 "url": "/api/fax/queues/{id}/members",
11167 "title": "GetMembers",
11170 "title": "Example usage:",
11171 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11175 "name": "GetMembers",
11176 "group": "Fax_Queues",
11177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11178 "version": "0.0.0",
11179 "filename": "server/api/faxQueue/index.js",
11180 "groupTitle": "Fax_Queues"
11184 "url": "/api/fax/queues",
11185 "title": "Gets a list of Queues",
11188 "title": "Example usage:",
11189 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11193 "name": "GetQueues",
11194 "group": "Fax_Queues",
11195 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11196 "version": "0.0.0",
11197 "filename": "server/api/faxQueue/index.js",
11198 "groupTitle": "Fax_Queues"
11202 "url": "/api/fax/queues/{id}/teams",
11203 "title": "Gets queues list",
11206 "title": "Example usage:",
11207 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11211 "name": "GetTeams",
11212 "group": "Fax_Queues",
11213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11214 "version": "0.0.0",
11215 "filename": "server/api/faxQueue/index.js",
11216 "groupTitle": "Fax_Queues"
11220 "url": "/api/fax/queues/{id}/users",
11221 "title": "Removes agents from a queue",
11224 "title": "Example usage:",
11225 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11229 "name": "RemoveAgents",
11230 "group": "Fax_Queues",
11231 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11232 "version": "0.0.0",
11233 "filename": "server/api/faxQueue/index.js",
11234 "groupTitle": "Fax_Queues"
11238 "url": "/api/fax/queues/{id}",
11239 "title": "Gets a single Queue",
11242 "title": "Example usage:",
11243 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11247 "name": "ShowQueues",
11248 "group": "Fax_Queues",
11249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11250 "version": "0.0.0",
11251 "filename": "server/api/faxQueue/index.js",
11252 "groupTitle": "Fax_Queues"
11256 "url": "/api/fax/queues/{id}",
11257 "title": "Update an existing Queue",
11260 "title": "Example usage:",
11261 "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",
11265 "name": "updateQueues",
11266 "group": "Fax_Queues",
11267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11268 "version": "0.0.0",
11269 "filename": "server/api/faxQueue/index.js",
11270 "groupTitle": "Fax_Queues"
11274 "url": "/api/fax/reports/transfer",
11275 "title": "Creates a new Fax Transfer Report",
11278 "title": "Example usage:",
11279 "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",
11283 "name": "CreateFax_Transfer_Reports",
11284 "group": "Fax_Transfer_Reports",
11292 "field": "uniqueid",
11311 "field": "transferredAt",
11317 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11318 "version": "0.0.0",
11319 "filename": "server/api/faxTransferReport/index.js",
11320 "groupTitle": "Fax_Transfer_Reports"
11324 "url": "/api/fax/reports/transfer/{id}",
11325 "title": "Deletes a Fax Transfer Report",
11328 "title": "Example usage:",
11329 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11333 "name": "DeleteFax_Transfer_Reports",
11334 "group": "Fax_Transfer_Reports",
11335 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11336 "version": "0.0.0",
11337 "filename": "server/api/faxTransferReport/index.js",
11338 "groupTitle": "Fax_Transfer_Reports"
11342 "url": "/api/fax/reports/transfer/describe",
11343 "title": "Gets table info about Fax Transfer Reports",
11346 "title": "Example usage:",
11347 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11351 "name": "DescribeFax_Transfer_Reports",
11352 "group": "Fax_Transfer_Reports",
11353 "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>",
11354 "version": "0.0.0",
11355 "filename": "server/api/faxTransferReport/index.js",
11356 "groupTitle": "Fax_Transfer_Reports"
11360 "url": "/api/fax/reports/transfer",
11361 "title": "Gets a list of Fax Transfer Reports",
11364 "title": "Example usage:",
11365 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11369 "name": "GetFax_Transfer_Reports",
11370 "group": "Fax_Transfer_Reports",
11371 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11372 "version": "0.0.0",
11373 "filename": "server/api/faxTransferReport/index.js",
11374 "groupTitle": "Fax_Transfer_Reports"
11378 "url": "/api/fax/reports/transfer/{id}",
11379 "title": "Gets a single Fax Transfer Report",
11382 "title": "Example usage:",
11383 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11387 "name": "ShowFax_Transfer_Reports",
11388 "group": "Fax_Transfer_Reports",
11389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11390 "version": "0.0.0",
11391 "filename": "server/api/faxTransferReport/index.js",
11392 "groupTitle": "Fax_Transfer_Reports"
11396 "url": "/api/fax/reports/transfer/{id}",
11397 "title": "Update an existing Fax Transfer Report",
11400 "title": "Example usage:",
11401 "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",
11405 "name": "updateFax_Transfer_Reports",
11406 "group": "Fax_Transfer_Reports",
11407 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11408 "version": "0.0.0",
11409 "filename": "server/api/faxTransferReport/index.js",
11410 "groupTitle": "Fax_Transfer_Reports"
11414 "url": "/api/integrations/freshdesk/accounts",
11415 "title": "Creates a new Freshdesk Account",
11418 "title": "Example usage:",
11419 "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",
11423 "name": "CreateFreshdesk_Accounts",
11424 "group": "Freshdesk_Accounts",
11439 "field": "description",
11446 "field": "username",
11460 "field": "remoteUri",
11467 "field": "serverUrl",
11473 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11474 "version": "0.0.0",
11475 "filename": "server/api/intFreshdeskAccount/index.js",
11476 "groupTitle": "Freshdesk_Accounts"
11480 "url": "/api/integrations/freshdesk/accounts/{id}",
11481 "title": "Deletes a Freshdesk Account",
11484 "title": "Example usage:",
11485 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11489 "name": "DeleteFreshdesk_Accounts",
11490 "group": "Freshdesk_Accounts",
11491 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11492 "version": "0.0.0",
11493 "filename": "server/api/intFreshdeskAccount/index.js",
11494 "groupTitle": "Freshdesk_Accounts"
11498 "url": "/api/integrations/freshdesk/accounts",
11499 "title": "Gets a list of Freshdesk Accounts",
11502 "title": "Example usage:",
11503 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11507 "name": "GetFreshdesk_Accounts",
11508 "group": "Freshdesk_Accounts",
11509 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11510 "version": "0.0.0",
11511 "filename": "server/api/intFreshdeskAccount/index.js",
11512 "groupTitle": "Freshdesk_Accounts"
11516 "url": "/api/integrations/freshdesk/accounts/{id}",
11517 "title": "Gets a single Freshdesk Account",
11520 "title": "Example usage:",
11521 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11525 "name": "ShowFreshdesk_Accounts",
11526 "group": "Freshdesk_Accounts",
11527 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11528 "version": "0.0.0",
11529 "filename": "server/api/intFreshdeskAccount/index.js",
11530 "groupTitle": "Freshdesk_Accounts"
11534 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11535 "title": "Creates new configuration",
11538 "title": "Example usage:",
11539 "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",
11543 "name": "addConfiguration",
11544 "group": "Freshdesk_Accounts",
11545 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11546 "version": "0.0.0",
11547 "filename": "server/api/intFreshdeskAccount/index.js",
11548 "groupTitle": "Freshdesk_Accounts"
11552 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11553 "title": "Gets account configurations",
11556 "title": "Example usage:",
11557 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11561 "name": "getConfigurations",
11562 "group": "Freshdesk_Accounts",
11563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11564 "version": "0.0.0",
11565 "filename": "server/api/intFreshdeskAccount/index.js",
11566 "groupTitle": "Freshdesk_Accounts"
11570 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11571 "title": "Gets account fields",
11574 "title": "Example usage:",
11575 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11579 "name": "getFields",
11580 "group": "Freshdesk_Accounts",
11581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11582 "version": "0.0.0",
11583 "filename": "server/api/intFreshdeskAccount/index.js",
11584 "groupTitle": "Freshdesk_Accounts"
11588 "url": "/api/integrations/freshdesk/accounts/{id}",
11589 "title": "Update an existing Freshdesk Account",
11592 "title": "Example usage:",
11593 "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",
11597 "name": "updateFreshdesk_Accounts",
11598 "group": "Freshdesk_Accounts",
11599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11600 "version": "0.0.0",
11601 "filename": "server/api/intFreshdeskAccount/index.js",
11602 "groupTitle": "Freshdesk_Accounts"
11606 "url": "/api/integrations/freshdesk/configurations",
11607 "title": "Creates a new Freshdesk Configuration",
11610 "title": "Example usage:",
11611 "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",
11615 "name": "CreateFreshdesk_Configurations",
11616 "group": "Freshdesk_Configurations",
11631 "field": "description",
11637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11638 "version": "0.0.0",
11639 "filename": "server/api/intFreshdeskConfiguration/index.js",
11640 "groupTitle": "Freshdesk_Configurations"
11644 "url": "/api/integrations/freshdesk/configurations/{id}",
11645 "title": "Deletes a Freshdesk Configuration",
11648 "title": "Example usage:",
11649 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11653 "name": "DeleteFreshdesk_Configurations",
11654 "group": "Freshdesk_Configurations",
11655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11656 "version": "0.0.0",
11657 "filename": "server/api/intFreshdeskConfiguration/index.js",
11658 "groupTitle": "Freshdesk_Configurations"
11662 "url": "/api/integrations/freshdesk/configurations",
11663 "title": "Gets a list of Freshdesk Configurations",
11666 "title": "Example usage:",
11667 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11671 "name": "GetFreshdesk_Configurations",
11672 "group": "Freshdesk_Configurations",
11673 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11674 "version": "0.0.0",
11675 "filename": "server/api/intFreshdeskConfiguration/index.js",
11676 "groupTitle": "Freshdesk_Configurations"
11680 "url": "/api/integrations/freshdesk/configurations/{id}",
11681 "title": "Gets a single Freshdesk Configuration",
11684 "title": "Example usage:",
11685 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11689 "name": "ShowFreshdesk_Configurations",
11690 "group": "Freshdesk_Configurations",
11691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11692 "version": "0.0.0",
11693 "filename": "server/api/intFreshdeskConfiguration/index.js",
11694 "groupTitle": "Freshdesk_Configurations"
11698 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11699 "title": "Gets configurations descriptions",
11702 "title": "Example usage:",
11703 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11707 "name": "getDescriptions",
11708 "group": "Freshdesk_Configurations",
11709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11710 "version": "0.0.0",
11711 "filename": "server/api/intFreshdeskConfiguration/index.js",
11712 "groupTitle": "Freshdesk_Configurations"
11716 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11717 "title": "Gets configurations fields",
11720 "title": "Example usage:",
11721 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11725 "name": "getFields",
11726 "group": "Freshdesk_Configurations",
11727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11728 "version": "0.0.0",
11729 "filename": "server/api/intFreshdeskConfiguration/index.js",
11730 "groupTitle": "Freshdesk_Configurations"
11734 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11735 "title": "Gets configurations subjects",
11738 "title": "Example usage:",
11739 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11743 "name": "getSubjects",
11744 "group": "Freshdesk_Configurations",
11745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11746 "version": "0.0.0",
11747 "filename": "server/api/intFreshdeskConfiguration/index.js",
11748 "groupTitle": "Freshdesk_Configurations"
11752 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11753 "title": "Gets configurations tags",
11756 "title": "Example usage:",
11757 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11762 "group": "Freshdesk_Configurations",
11763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11764 "version": "0.0.0",
11765 "filename": "server/api/intFreshdeskConfiguration/index.js",
11766 "groupTitle": "Freshdesk_Configurations"
11770 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11771 "title": "Sets new tags",
11774 "title": "Example usage:",
11775 "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",
11780 "group": "Freshdesk_Configurations",
11781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11782 "version": "0.0.0",
11783 "filename": "server/api/intFreshdeskConfiguration/index.js",
11784 "groupTitle": "Freshdesk_Configurations"
11788 "url": "/api/integrations/freshdesk/configurations/{id}",
11789 "title": "Update an existing Freshdesk Configuration",
11792 "title": "Example usage:",
11793 "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",
11797 "name": "updateFreshdesk_Configurations",
11798 "group": "Freshdesk_Configurations",
11799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11800 "version": "0.0.0",
11801 "filename": "server/api/intFreshdeskConfiguration/index.js",
11802 "groupTitle": "Freshdesk_Configurations"
11806 "url": "/api/integrations/freshdesk/fields",
11807 "title": "Creates a new Freshdesk Field",
11810 "title": "Example usage:",
11811 "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",
11815 "name": "CreateFreshdesk_Fields",
11816 "group": "Freshdesk_Fields",
11826 "\"customVariable\"",
11837 "field": "content",
11853 "\"customVariable\""
11856 "field": "keyType",
11863 "field": "keyContent",
11870 "field": "idField",
11877 "field": "nameField",
11884 "field": "customField",
11891 "field": "variableName",
11897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11898 "version": "0.0.0",
11899 "filename": "server/api/intFreshdeskField/index.js",
11900 "groupTitle": "Freshdesk_Fields"
11904 "url": "/api/integrations/freshdesk/fields/{id}",
11905 "title": "Deletes a Freshdesk Field",
11908 "title": "Example usage:",
11909 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11913 "name": "DeleteFreshdesk_Fields",
11914 "group": "Freshdesk_Fields",
11915 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11916 "version": "0.0.0",
11917 "filename": "server/api/intFreshdeskField/index.js",
11918 "groupTitle": "Freshdesk_Fields"
11922 "url": "/api/integrations/freshdesk/fields",
11923 "title": "Gets a list of Freshdesk Fields",
11926 "title": "Example usage:",
11927 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11931 "name": "GetFreshdesk_Fields",
11932 "group": "Freshdesk_Fields",
11933 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11934 "version": "0.0.0",
11935 "filename": "server/api/intFreshdeskField/index.js",
11936 "groupTitle": "Freshdesk_Fields"
11940 "url": "/api/integrations/freshdesk/fields/{id}",
11941 "title": "Gets a single Freshdesk Field",
11944 "title": "Example usage:",
11945 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11949 "name": "ShowFreshdesk_Fields",
11950 "group": "Freshdesk_Fields",
11951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11952 "version": "0.0.0",
11953 "filename": "server/api/intFreshdeskField/index.js",
11954 "groupTitle": "Freshdesk_Fields"
11958 "url": "/api/integrations/freshdesk/fields/{id}",
11959 "title": "Update an existing Freshdesk Field",
11962 "title": "Example usage:",
11963 "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",
11967 "name": "updateFreshdesk_Fields",
11968 "group": "Freshdesk_Fields",
11969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11970 "version": "0.0.0",
11971 "filename": "server/api/intFreshdeskField/index.js",
11972 "groupTitle": "Freshdesk_Fields"
11976 "url": "/api/integrations/freshsales/accounts",
11977 "title": "Creates a new Freshsales Account",
11980 "title": "Example usage:",
11981 "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",
11985 "name": "CreateFreshsales_Accounts",
11986 "group": "Freshsales_Accounts",
12001 "field": "description",
12008 "field": "username",
12022 "field": "remoteUri",
12029 "field": "serverUrl",
12035 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12036 "version": "0.0.0",
12037 "filename": "server/api/intFreshsalesAccount/index.js",
12038 "groupTitle": "Freshsales_Accounts"
12042 "url": "/api/integrations/freshsales/accounts/{id}",
12043 "title": "Deletes a Freshsales Account",
12046 "title": "Example usage:",
12047 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12051 "name": "DeleteFreshsales_Accounts",
12052 "group": "Freshsales_Accounts",
12053 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12054 "version": "0.0.0",
12055 "filename": "server/api/intFreshsalesAccount/index.js",
12056 "groupTitle": "Freshsales_Accounts"
12060 "url": "/api/integrations/freshsales/accounts",
12061 "title": "Gets a list of Freshsales Accounts",
12064 "title": "Example usage:",
12065 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12069 "name": "GetFreshsales_Accounts",
12070 "group": "Freshsales_Accounts",
12071 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12072 "version": "0.0.0",
12073 "filename": "server/api/intFreshsalesAccount/index.js",
12074 "groupTitle": "Freshsales_Accounts"
12078 "url": "/api/integrations/freshsales/accounts/{id}",
12079 "title": "Gets a single Freshsales Account",
12082 "title": "Example usage:",
12083 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12087 "name": "ShowFreshsales_Accounts",
12088 "group": "Freshsales_Accounts",
12089 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12090 "version": "0.0.0",
12091 "filename": "server/api/intFreshsalesAccount/index.js",
12092 "groupTitle": "Freshsales_Accounts"
12096 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12097 "title": "Creates new configuration",
12100 "title": "Example usage:",
12101 "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",
12105 "name": "addConfiguration",
12106 "group": "Freshsales_Accounts",
12107 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12108 "version": "0.0.0",
12109 "filename": "server/api/intFreshsalesAccount/index.js",
12110 "groupTitle": "Freshsales_Accounts"
12114 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12115 "title": "Gets account configurations",
12118 "title": "Example usage:",
12119 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12123 "name": "getConfigurations",
12124 "group": "Freshsales_Accounts",
12125 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12126 "version": "0.0.0",
12127 "filename": "server/api/intFreshsalesAccount/index.js",
12128 "groupTitle": "Freshsales_Accounts"
12132 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12133 "title": "Gets account fields",
12136 "title": "Example usage:",
12137 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12141 "name": "getFields",
12142 "group": "Freshsales_Accounts",
12143 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12144 "version": "0.0.0",
12145 "filename": "server/api/intFreshsalesAccount/index.js",
12146 "groupTitle": "Freshsales_Accounts"
12150 "url": "/api/integrations/freshsales/accounts/{id}",
12151 "title": "Update an existing Freshsales Account",
12154 "title": "Example usage:",
12155 "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",
12159 "name": "updateFreshsales_Accounts",
12160 "group": "Freshsales_Accounts",
12161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12162 "version": "0.0.0",
12163 "filename": "server/api/intFreshsalesAccount/index.js",
12164 "groupTitle": "Freshsales_Accounts"
12168 "url": "/api/integrations/freshsales/configurations",
12169 "title": "Creates a new Freshsales Configuration",
12172 "title": "Example usage:",
12173 "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",
12177 "name": "CreateFreshsales_Configurations",
12178 "group": "Freshsales_Configurations",
12193 "field": "description",
12199 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12200 "version": "0.0.0",
12201 "filename": "server/api/intFreshsalesConfiguration/index.js",
12202 "groupTitle": "Freshsales_Configurations"
12206 "url": "/api/integrations/freshsales/configurations/{id}",
12207 "title": "Deletes a Freshsales Configuration",
12210 "title": "Example usage:",
12211 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12215 "name": "DeleteFreshsales_Configurations",
12216 "group": "Freshsales_Configurations",
12217 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12218 "version": "0.0.0",
12219 "filename": "server/api/intFreshsalesConfiguration/index.js",
12220 "groupTitle": "Freshsales_Configurations"
12224 "url": "/api/integrations/freshsales/configurations",
12225 "title": "Gets a list of Freshsales Configurations",
12228 "title": "Example usage:",
12229 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12233 "name": "GetFreshsales_Configurations",
12234 "group": "Freshsales_Configurations",
12235 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12236 "version": "0.0.0",
12237 "filename": "server/api/intFreshsalesConfiguration/index.js",
12238 "groupTitle": "Freshsales_Configurations"
12242 "url": "/api/integrations/freshsales/configurations/{id}",
12243 "title": "Gets a single Freshsales Configuration",
12246 "title": "Example usage:",
12247 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12251 "name": "ShowFreshsales_Configurations",
12252 "group": "Freshsales_Configurations",
12253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12254 "version": "0.0.0",
12255 "filename": "server/api/intFreshsalesConfiguration/index.js",
12256 "groupTitle": "Freshsales_Configurations"
12260 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12261 "title": "Gets configurations descriptions",
12264 "title": "Example usage:",
12265 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12269 "name": "getDescriptions",
12270 "group": "Freshsales_Configurations",
12271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12272 "version": "0.0.0",
12273 "filename": "server/api/intFreshsalesConfiguration/index.js",
12274 "groupTitle": "Freshsales_Configurations"
12278 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12279 "title": "Gets configurations fields",
12282 "title": "Example usage:",
12283 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12287 "name": "getFields",
12288 "group": "Freshsales_Configurations",
12289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12290 "version": "0.0.0",
12291 "filename": "server/api/intFreshsalesConfiguration/index.js",
12292 "groupTitle": "Freshsales_Configurations"
12296 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12297 "title": "Gets configurations subjects",
12300 "title": "Example usage:",
12301 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12305 "name": "getSubjects",
12306 "group": "Freshsales_Configurations",
12307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12308 "version": "0.0.0",
12309 "filename": "server/api/intFreshsalesConfiguration/index.js",
12310 "groupTitle": "Freshsales_Configurations"
12314 "url": "/api/integrations/freshsales/configurations/{id}",
12315 "title": "Update an existing Freshsales Configuration",
12318 "title": "Example usage:",
12319 "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",
12323 "name": "updateFreshsales_Configurations",
12324 "group": "Freshsales_Configurations",
12325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12326 "version": "0.0.0",
12327 "filename": "server/api/intFreshsalesConfiguration/index.js",
12328 "groupTitle": "Freshsales_Configurations"
12332 "url": "/api/integrations/freshsales/fields",
12333 "title": "Creates a new Freshsales Field",
12336 "title": "Example usage:",
12337 "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",
12341 "name": "CreateFreshsales_Fields",
12342 "group": "Freshsales_Fields",
12352 "\"customVariable\"",
12363 "field": "content",
12379 "\"customVariable\""
12382 "field": "keyType",
12389 "field": "keyContent",
12396 "field": "idField",
12403 "field": "nameField",
12410 "field": "customField",
12417 "field": "variableName",
12423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12424 "version": "0.0.0",
12425 "filename": "server/api/intFreshsalesField/index.js",
12426 "groupTitle": "Freshsales_Fields"
12430 "url": "/api/integrations/freshsales/fields/{id}",
12431 "title": "Deletes a Freshsales Field",
12434 "title": "Example usage:",
12435 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12439 "name": "DeleteFreshsales_Fields",
12440 "group": "Freshsales_Fields",
12441 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12442 "version": "0.0.0",
12443 "filename": "server/api/intFreshsalesField/index.js",
12444 "groupTitle": "Freshsales_Fields"
12448 "url": "/api/integrations/freshsales/fields",
12449 "title": "Gets a list of Freshsales Fields",
12452 "title": "Example usage:",
12453 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12457 "name": "GetFreshsales_Fields",
12458 "group": "Freshsales_Fields",
12459 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12460 "version": "0.0.0",
12461 "filename": "server/api/intFreshsalesField/index.js",
12462 "groupTitle": "Freshsales_Fields"
12466 "url": "/api/integrations/freshsales/fields/{id}",
12467 "title": "Gets a single Freshsales Field",
12470 "title": "Example usage:",
12471 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12475 "name": "ShowFreshsales_Fields",
12476 "group": "Freshsales_Fields",
12477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12478 "version": "0.0.0",
12479 "filename": "server/api/intFreshsalesField/index.js",
12480 "groupTitle": "Freshsales_Fields"
12484 "url": "/api/integrations/freshsales/fields/{id}",
12485 "title": "Update an existing Freshsales Field",
12488 "title": "Example usage:",
12489 "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",
12493 "name": "updateFreshsales_Fields",
12494 "group": "Freshsales_Fields",
12495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12496 "version": "0.0.0",
12497 "filename": "server/api/intFreshsalesField/index.js",
12498 "groupTitle": "Freshsales_Fields"
12502 "url": "/api/campaigns/{id}/blacklists",
12503 "title": "Add blacklists to an IVR campaign",
12506 "title": "Example usage:",
12507 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12511 "name": "AddBlackLists",
12512 "group": "IVR_Campaigns",
12513 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12514 "version": "0.0.0",
12515 "filename": "server/api/campaign/index.js",
12516 "groupTitle": "IVR_Campaigns"
12520 "url": "/api/campaigns/{id}/lists",
12521 "title": "Add lists to an IVR campaign",
12524 "title": "Example usage:",
12525 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12529 "name": "AddLists",
12530 "group": "IVR_Campaigns",
12531 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12532 "version": "0.0.0",
12533 "filename": "server/api/campaign/index.js",
12534 "groupTitle": "IVR_Campaigns"
12538 "url": "/api/campaigns/clone",
12539 "title": "Clone an existing IVR Campaign",
12542 "title": "Example usage:",
12543 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12547 "name": "CloneIVR_Campaigns",
12548 "group": "IVR_Campaigns",
12549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12550 "version": "0.0.0",
12551 "filename": "server/api/campaign/index.js",
12552 "groupTitle": "IVR_Campaigns"
12556 "url": "/api/campaigns",
12557 "title": "Creates a new IVR Campaign",
12560 "title": "Example usage:",
12561 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12565 "name": "CreateIVR_Campaigns",
12566 "group": "IVR_Campaigns",
12591 "field": "description",
12599 "description": "<p>Active/Disactive Campaign</p>"
12605 "field": "limitCalls",
12606 "description": "<p>Max 200 calls.</p>"
12612 "field": "dialOriginateCallerIdName",
12619 "field": "dialOriginateCallerIdNumber",
12626 "field": "dialOriginateTimeout",
12627 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12633 "field": "dialCongestionMaxRetry",
12634 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12640 "field": "dialCongestionRetryFrequency",
12641 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12647 "field": "dialBusyMaxRetry",
12648 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12654 "field": "dialBusyRetryFrequency",
12655 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12661 "field": "dialNoAnswerMaxRetry",
12662 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12668 "field": "dialNoAnswerRetryFrequency",
12669 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12675 "field": "dialGlobalMaxRetry",
12676 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12682 "field": "dialTimezone",
12689 "field": "dialGlobalInterval",
12701 "field": "dialCheckDuplicateType",
12708 "field": "dialAMDActive",
12709 "description": "<p>Active/Disactive AMD</p>"
12715 "field": "dialAMDInitialSilence",
12716 "description": "<p>#AMD Initial Silence</p>"
12722 "field": "dialAMDGreeting",
12723 "description": "<p>#AMD Greeting</p>"
12729 "field": "dialAMDAfterGreetingSilence",
12730 "description": "<p>#AMD After Greeting Silence</p>"
12736 "field": "dialAMDTotalAnalysisTime",
12737 "description": "<p>#AMD Total Analysis Time</p>"
12743 "field": "dialAMDMinWordLength",
12744 "description": "<p>#AMD Min Word Length</p>"
12750 "field": "dialAMDBetweenWordsSilence",
12751 "description": "<p>#AMD Between Words Silence</p>"
12757 "field": "dialAMDMaximumNumberOfWords",
12758 "description": "<p>#AMD Maximum Number Of Words</p>"
12764 "field": "dialAMDSilenceThreshold",
12765 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12771 "field": "dialAMDMaximumWordLength",
12772 "description": "<p>#AMD Maximum Word Length</p>"
12782 "field": "dialOrderByScheduledAt",
12789 "field": "dialPrefix",
12796 "field": "dialRandomLastDigitCallerIdNumber",
12797 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12803 "field": "dialCutDigit",
12804 "description": "<p>Cut Digit (min:1, max:15)</p>"
12810 "field": "dialNoSuchNumberMaxRetry",
12811 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12817 "field": "dialNoSuchNumberRetryFrequency",
12818 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12824 "field": "dialDropMaxRetry",
12825 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12831 "field": "dialDropRetryFrequency",
12832 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12838 "field": "dialAbandonedMaxRetry",
12839 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12845 "field": "dialAbandonedRetryFrequency",
12846 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12852 "field": "dialMachineMaxRetry",
12853 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12859 "field": "dialMachineRetryFrequency",
12860 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12866 "field": "dialAgentRejectMaxRetry",
12867 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12873 "field": "dialAgentRejectRetryFrequency",
12874 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12879 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12880 "version": "0.0.0",
12881 "filename": "server/api/campaign/index.js",
12882 "groupTitle": "IVR_Campaigns"
12886 "url": "/api/campaigns/{id}",
12887 "title": "Deletes a IVR Campaign",
12890 "title": "Example usage:",
12891 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12895 "name": "DeleteIVR_Campaigns",
12896 "group": "IVR_Campaigns",
12897 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12898 "version": "0.0.0",
12899 "filename": "server/api/campaign/index.js",
12900 "groupTitle": "IVR_Campaigns"
12904 "url": "/api/campaigns/{id}/blacklists",
12905 "title": "Get IVR campaign blacklists",
12908 "title": "Example usage:",
12909 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12913 "name": "GetBlackLists",
12914 "group": "IVR_Campaigns",
12915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12916 "version": "0.0.0",
12917 "filename": "server/api/campaign/index.js",
12918 "groupTitle": "IVR_Campaigns"
12922 "url": "/api/campaigns/{id}/finals",
12923 "title": "Gets IVR campaign hopper finals",
12926 "title": "Example usage:",
12927 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12931 "name": "GetHopperFinals",
12932 "group": "IVR_Campaigns",
12933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12934 "version": "0.0.0",
12935 "filename": "server/api/campaign/index.js",
12936 "groupTitle": "IVR_Campaigns"
12940 "url": "/api/campaigns/{id}/hopper_histories",
12941 "title": "Gets IVR campaign hopper histories",
12944 "title": "Example usage:",
12945 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12949 "name": "GetHopperHistories",
12950 "group": "IVR_Campaigns",
12951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12952 "version": "0.0.0",
12953 "filename": "server/api/campaign/index.js",
12954 "groupTitle": "IVR_Campaigns"
12958 "url": "/api/campaigns/{id}/hoppers",
12959 "title": "Gets IVR campaign hoppers",
12962 "title": "Example usage:",
12963 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12967 "name": "GetHoppers",
12968 "group": "IVR_Campaigns",
12969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12970 "version": "0.0.0",
12971 "filename": "server/api/campaign/index.js",
12972 "groupTitle": "IVR_Campaigns"
12976 "url": "/api/campaigns",
12977 "title": "Gets a list of IVR Campaigns",
12980 "title": "Example usage:",
12981 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
12985 "name": "GetIVR_Campaigns",
12986 "group": "IVR_Campaigns",
12987 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12988 "version": "0.0.0",
12989 "filename": "server/api/campaign/index.js",
12990 "groupTitle": "IVR_Campaigns"
12994 "url": "/api/campaigns/{id}/lists",
12995 "title": "Get IVR campaign lists",
12998 "title": "Example usage:",
12999 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13003 "name": "GetLists",
13004 "group": "IVR_Campaigns",
13005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13006 "version": "0.0.0",
13007 "filename": "server/api/campaign/index.js",
13008 "groupTitle": "IVR_Campaigns"
13012 "url": "/api/campaigns/{id}/blacklists",
13013 "title": "Remove blacklists from an IVR Campaign",
13016 "title": "Example usage:",
13017 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13021 "name": "RemoveBlackLists",
13022 "group": "IVR_Campaigns",
13023 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13024 "version": "0.0.0",
13025 "filename": "server/api/campaign/index.js",
13026 "groupTitle": "IVR_Campaigns"
13030 "url": "/api/campaigns/{id}/lists",
13031 "title": "Remove lists from an IVR Campaign",
13034 "title": "Example usage:",
13035 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13039 "name": "RemoveLists",
13040 "group": "IVR_Campaigns",
13041 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13042 "version": "0.0.0",
13043 "filename": "server/api/campaign/index.js",
13044 "groupTitle": "IVR_Campaigns"
13048 "url": "/api/campaigns/{id}",
13049 "title": "Gets a single IVR Campaign",
13052 "title": "Example usage:",
13053 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13057 "name": "ShowIVR_Campaigns",
13058 "group": "IVR_Campaigns",
13059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13060 "version": "0.0.0",
13061 "filename": "server/api/campaign/index.js",
13062 "groupTitle": "IVR_Campaigns"
13066 "url": "/api/campaigns/{id}/blacks",
13067 "title": "Gets IVR campaign hopper blacks",
13070 "title": "Example usage:",
13071 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13075 "name": "getHopperBlacks",
13076 "group": "IVR_Campaigns",
13077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13078 "version": "0.0.0",
13079 "filename": "server/api/campaign/index.js",
13080 "groupTitle": "IVR_Campaigns"
13084 "url": "/api/campaigns/{id}",
13085 "title": "Update an existing IVR Campaign",
13088 "title": "Example usage:",
13089 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13093 "name": "updateIVR_Campaigns",
13094 "group": "IVR_Campaigns",
13095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13096 "version": "0.0.0",
13097 "filename": "server/api/campaign/index.js",
13098 "groupTitle": "IVR_Campaigns"
13102 "url": "/api/integrations/reports",
13103 "title": "Creates a new Integration Report",
13106 "title": "Example usage:",
13107 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13111 "name": "CreateIntegration_Reports",
13112 "group": "Integration_Reports",
13120 "field": "integration",
13127 "field": "eventChannel",
13134 "field": "exitStatus",
13141 "field": "ticketId",
13148 "field": "integrationId",
13155 "field": "contacts",
13162 "field": "uniqueid",
13169 "field": "calleridnum",
13176 "field": "calleridname",
13190 "field": "interface",
13197 "field": "membername",
13204 "field": "agentcalledAt",
13211 "field": "agentconnectAt",
13218 "field": "holdtime",
13225 "field": "agentcomplete",
13232 "field": "agentcompleteAt",
13239 "field": "talktime",
13246 "field": "agentacw",
13253 "field": "acwtime",
13267 "field": "agentringnoanswer",
13274 "field": "agentringnoanswerAt",
13281 "field": "agentdump",
13288 "field": "agentdumpAt",
13295 "field": "lastevent",
13302 "field": "channel",
13309 "field": "channelstate",
13316 "field": "channelstatedesc",
13323 "field": "connectedlinenum",
13330 "field": "connectedlinename",
13337 "field": "language",
13344 "field": "accountcode",
13351 "field": "context",
13365 "field": "priority",
13372 "field": "destchannel",
13379 "field": "destchannelstate",
13386 "field": "destchannelstatedesc",
13393 "field": "destcalleridnum",
13400 "field": "destcalleridname",
13407 "field": "destconnectedlinenum",
13414 "field": "destconnectedlinename",
13421 "field": "destlanguage",
13428 "field": "destaccountcode",
13435 "field": "destcontext",
13442 "field": "destexten",
13449 "field": "destpriority",
13456 "field": "destuniqueid",
13463 "field": "messageId",
13470 "field": "inReplyTo",
13477 "field": "subject",
13505 "field": "attachment",
13553 "field": "appdata",
13560 "field": "projectId",
13566 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13567 "version": "0.0.0",
13568 "filename": "server/api/integrationReport/index.js",
13569 "groupTitle": "Integration_Reports"
13573 "url": "/api/integrations/reports/{id}",
13574 "title": "Deletes a Integration Report",
13577 "title": "Example usage:",
13578 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13582 "name": "DeleteIntegration_Reports",
13583 "group": "Integration_Reports",
13584 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13585 "version": "0.0.0",
13586 "filename": "server/api/integrationReport/index.js",
13587 "groupTitle": "Integration_Reports"
13591 "url": "/api/integrations/reports/describe",
13592 "title": "Gets table info about Integration Reports",
13595 "title": "Example usage:",
13596 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13600 "name": "DescribeIntegration_Reports",
13601 "group": "Integration_Reports",
13602 "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>",
13603 "version": "0.0.0",
13604 "filename": "server/api/integrationReport/index.js",
13605 "groupTitle": "Integration_Reports"
13609 "url": "/api/integrations/reports",
13610 "title": "Gets a list of Integration Reports",
13613 "title": "Example usage:",
13614 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13618 "name": "GetIntegration_Reports",
13619 "group": "Integration_Reports",
13620 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13621 "version": "0.0.0",
13622 "filename": "server/api/integrationReport/index.js",
13623 "groupTitle": "Integration_Reports"
13627 "url": "/api/integrations/reports/{id}",
13628 "title": "Gets a single Integration Report",
13631 "title": "Example usage:",
13632 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13636 "name": "ShowIntegration_Reports",
13637 "group": "Integration_Reports",
13638 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13639 "version": "0.0.0",
13640 "filename": "server/api/integrationReport/index.js",
13641 "groupTitle": "Integration_Reports"
13645 "url": "/api/integrations/reports/{id}",
13646 "title": "Update an existing Integration Report",
13649 "title": "Example usage:",
13650 "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",
13654 "name": "updateIntegration_Reports",
13655 "group": "Integration_Reports",
13656 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13657 "version": "0.0.0",
13658 "filename": "server/api/integrationReport/index.js",
13659 "groupTitle": "Integration_Reports"
13663 "url": "/api/intervals",
13664 "title": "Creates a new Interval",
13667 "title": "Example usage:",
13668 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13672 "name": "CreateIntervals",
13673 "group": "Intervals",
13688 "field": "description",
13695 "field": "interval",
13701 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13702 "version": "0.0.0",
13703 "filename": "server/api/interval/index.js",
13704 "groupTitle": "Intervals"
13708 "url": "/api/intervals/{id}",
13709 "title": "Deletes a Interval",
13712 "title": "Example usage:",
13713 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13717 "name": "DeleteIntervals",
13718 "group": "Intervals",
13719 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13720 "version": "0.0.0",
13721 "filename": "server/api/interval/index.js",
13722 "groupTitle": "Intervals"
13726 "url": "/api/intervals",
13727 "title": "Gets a list of Intervals",
13730 "title": "Example usage:",
13731 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13735 "name": "GetIntervals",
13736 "group": "Intervals",
13737 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13738 "version": "0.0.0",
13739 "filename": "server/api/interval/index.js",
13740 "groupTitle": "Intervals"
13744 "url": "/api/intervals/{id}",
13745 "title": "Gets a single Interval",
13748 "title": "Example usage:",
13749 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13753 "name": "ShowIntervals",
13754 "group": "Intervals",
13755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13756 "version": "0.0.0",
13757 "filename": "server/api/interval/index.js",
13758 "groupTitle": "Intervals"
13762 "url": "/api/intervals/{id}/sub_intervals",
13763 "title": "Creates a new sub interval",
13766 "title": "Example usage:",
13767 "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",
13771 "name": "addInterval",
13772 "group": "Intervals",
13773 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13774 "version": "0.0.0",
13775 "filename": "server/api/interval/index.js",
13776 "groupTitle": "Intervals"
13780 "url": "/api/intervals/{id}/sub_intervals/create_many",
13781 "title": "Create new sub intervals set",
13784 "title": "Example usage:",
13785 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13789 "name": "addIntervals",
13790 "group": "Intervals",
13791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13792 "version": "0.0.0",
13793 "filename": "server/api/interval/index.js",
13794 "groupTitle": "Intervals"
13798 "url": "/api/intervals/{id}/sub_intervals",
13799 "title": "Get sub intervals set",
13802 "title": "Example usage:",
13803 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13807 "name": "getIntervals",
13808 "group": "Intervals",
13809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13810 "version": "0.0.0",
13811 "filename": "server/api/interval/index.js",
13812 "groupTitle": "Intervals"
13816 "url": "/api/intervals/{id}",
13817 "title": "Update an existing Interval",
13820 "title": "Example usage:",
13821 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13825 "name": "updateIntervals",
13826 "group": "Intervals",
13827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13828 "version": "0.0.0",
13829 "filename": "server/api/interval/index.js",
13830 "groupTitle": "Intervals"
13834 "url": "/api/jira",
13835 "title": "Creates a new issue",
13838 "title": "Example usage:",
13839 "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}",
13843 "name": "Creates_Issue",
13855 "field": "issuetype",
13862 "field": "summary",
13869 "field": "description",
13875 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13876 "version": "0.0.0",
13877 "filename": "server/api/jira/index.js",
13878 "groupTitle": "Issue"
13882 "url": "/api/jscripty/answers/reports",
13883 "title": "Creates a new Report",
13886 "title": "Example usage:",
13887 "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",
13891 "name": "CreateReports",
13892 "group": "JscriptyAnswerReport",
13900 "field": "question",
13914 "field": "membername",
13921 "field": "projectname",
13935 "field": "uniqueid",
13942 "field": "calleridname",
13949 "field": "calleridnum",
13956 "field": "questionId",
13962 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13963 "version": "0.0.0",
13964 "filename": "server/api/jscriptyAnswerReport/index.js",
13965 "groupTitle": "JscriptyAnswerReport"
13969 "url": "/api/jscripty/answers/reports/{id}",
13970 "title": "Deletes a Report",
13973 "title": "Example usage:",
13974 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
13978 "name": "DeleteReports",
13979 "group": "JscriptyAnswerReport",
13980 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13981 "version": "0.0.0",
13982 "filename": "server/api/jscriptyAnswerReport/index.js",
13983 "groupTitle": "JscriptyAnswerReport"
13987 "url": "/api/jscripty/answers/reports/describe",
13988 "title": "Gets table info about Reports",
13991 "title": "Example usage:",
13992 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
13996 "name": "DescribeReports",
13997 "group": "JscriptyAnswerReport",
13998 "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>",
13999 "version": "0.0.0",
14000 "filename": "server/api/jscriptyAnswerReport/index.js",
14001 "groupTitle": "JscriptyAnswerReport"
14005 "url": "/api/jscripty/answers/reports",
14006 "title": "Gets a list of Reports",
14009 "title": "Example usage:",
14010 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14014 "name": "GetReports",
14015 "group": "JscriptyAnswerReport",
14016 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14017 "version": "0.0.0",
14018 "filename": "server/api/jscriptyAnswerReport/index.js",
14019 "groupTitle": "JscriptyAnswerReport"
14023 "url": "/api/jscripty/answers/reports/{id}",
14024 "title": "Gets a single Report",
14027 "title": "Example usage:",
14028 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14032 "name": "ShowReports",
14033 "group": "JscriptyAnswerReport",
14034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14035 "version": "0.0.0",
14036 "filename": "server/api/jscriptyAnswerReport/index.js",
14037 "groupTitle": "JscriptyAnswerReport"
14041 "url": "/api/jscripty/answers/reports/{id}",
14042 "title": "Update an existing Report",
14045 "title": "Example usage:",
14046 "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",
14050 "name": "updateReports",
14051 "group": "JscriptyAnswerReport",
14052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14053 "version": "0.0.0",
14054 "filename": "server/api/jscriptyAnswerReport/index.js",
14055 "groupTitle": "JscriptyAnswerReport"
14059 "url": "/api/jscripty/questions/reports",
14060 "title": "Creates a new Report",
14063 "title": "Example usage:",
14064 "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",
14068 "name": "CreateReports",
14069 "group": "JscriptyQuestionReport",
14077 "field": "question",
14091 "field": "membername",
14098 "field": "projectname",
14112 "field": "uniqueid",
14119 "field": "calleridname",
14126 "field": "calleridnum",
14133 "field": "questionId",
14139 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14140 "version": "0.0.0",
14141 "filename": "server/api/jscriptyQuestionReport/index.js",
14142 "groupTitle": "JscriptyQuestionReport"
14146 "url": "/api/jscripty/questions/reports/{id}",
14147 "title": "Deletes a Report",
14150 "title": "Example usage:",
14151 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14155 "name": "DeleteReports",
14156 "group": "JscriptyQuestionReport",
14157 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14158 "version": "0.0.0",
14159 "filename": "server/api/jscriptyQuestionReport/index.js",
14160 "groupTitle": "JscriptyQuestionReport"
14164 "url": "/api/jscripty/questions/reports/describe",
14165 "title": "Gets table info about Reports",
14168 "title": "Example usage:",
14169 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14173 "name": "DescribeReports",
14174 "group": "JscriptyQuestionReport",
14175 "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>",
14176 "version": "0.0.0",
14177 "filename": "server/api/jscriptyQuestionReport/index.js",
14178 "groupTitle": "JscriptyQuestionReport"
14182 "url": "/api/jscripty/questions/reports",
14183 "title": "Gets a list of Reports",
14186 "title": "Example usage:",
14187 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14191 "name": "GetReports",
14192 "group": "JscriptyQuestionReport",
14193 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14194 "version": "0.0.0",
14195 "filename": "server/api/jscriptyQuestionReport/index.js",
14196 "groupTitle": "JscriptyQuestionReport"
14200 "url": "/api/jscripty/questions/reports/{id}",
14201 "title": "Gets a single Report",
14204 "title": "Example usage:",
14205 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14209 "name": "ShowReports",
14210 "group": "JscriptyQuestionReport",
14211 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14212 "version": "0.0.0",
14213 "filename": "server/api/jscriptyQuestionReport/index.js",
14214 "groupTitle": "JscriptyQuestionReport"
14218 "url": "/api/jscripty/questions/reports/{id}",
14219 "title": "Update an existing Report",
14222 "title": "Example usage:",
14223 "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",
14227 "name": "updateReports",
14228 "group": "JscriptyQuestionReport",
14229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14230 "version": "0.0.0",
14231 "filename": "server/api/jscriptyQuestionReport/index.js",
14232 "groupTitle": "JscriptyQuestionReport"
14236 "url": "/api/jscripty/sessions/reports",
14237 "title": "Creates a new Report",
14240 "title": "Example usage:",
14241 "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",
14245 "name": "CreateReports",
14246 "group": "JscriptySessionReport",
14254 "field": "starttime",
14261 "field": "endtime",
14268 "field": "membername",
14275 "field": "projectname",
14289 "field": "uniqueid",
14296 "field": "calleridname",
14303 "field": "calleridnum",
14310 "field": "completed",
14316 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14317 "version": "0.0.0",
14318 "filename": "server/api/jscriptySessionReport/index.js",
14319 "groupTitle": "JscriptySessionReport"
14323 "url": "/api/jscripty/sessions/reports/{id}",
14324 "title": "Deletes a Report",
14327 "title": "Example usage:",
14328 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14332 "name": "DeleteReports",
14333 "group": "JscriptySessionReport",
14334 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14335 "version": "0.0.0",
14336 "filename": "server/api/jscriptySessionReport/index.js",
14337 "groupTitle": "JscriptySessionReport"
14341 "url": "/api/jscripty/sessions/reports/describe",
14342 "title": "Gets table info about Reports",
14345 "title": "Example usage:",
14346 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14350 "name": "DescribeReports",
14351 "group": "JscriptySessionReport",
14352 "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>",
14353 "version": "0.0.0",
14354 "filename": "server/api/jscriptySessionReport/index.js",
14355 "groupTitle": "JscriptySessionReport"
14359 "url": "/api/jscripty/sessions/reports",
14360 "title": "Gets a list of Reports",
14363 "title": "Example usage:",
14364 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14368 "name": "GetReports",
14369 "group": "JscriptySessionReport",
14370 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14371 "version": "0.0.0",
14372 "filename": "server/api/jscriptySessionReport/index.js",
14373 "groupTitle": "JscriptySessionReport"
14377 "url": "/api/jscripty/sessions/reports/{id}",
14378 "title": "Gets a single Report",
14381 "title": "Example usage:",
14382 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14386 "name": "ShowReports",
14387 "group": "JscriptySessionReport",
14388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14389 "version": "0.0.0",
14390 "filename": "server/api/jscriptySessionReport/index.js",
14391 "groupTitle": "JscriptySessionReport"
14395 "url": "/api/jscripty/sessions/reports/{id}/questions",
14396 "title": "Gets Jscripty Session questions",
14399 "title": "Example usage:",
14400 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14404 "name": "getQuestions",
14405 "group": "JscriptySessionReport",
14406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14407 "version": "0.0.0",
14408 "filename": "server/api/jscriptySessionReport/index.js",
14409 "groupTitle": "JscriptySessionReport"
14413 "url": "/api/jscripty/sessions/reports/{id}",
14414 "title": "Update an existing Report",
14417 "title": "Example usage:",
14418 "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",
14422 "name": "updateReports",
14423 "group": "JscriptySessionReport",
14424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14425 "version": "0.0.0",
14426 "filename": "server/api/jscriptySessionReport/index.js",
14427 "groupTitle": "JscriptySessionReport"
14431 "url": "/api/jscripty/projects/clone",
14432 "title": "Clone an existing Project",
14435 "title": "Example usage:",
14436 "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",
14440 "name": "CloneProjects",
14441 "group": "Jscripty_Projects",
14442 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14443 "version": "0.0.0",
14444 "filename": "server/api/jscriptyProject/index.js",
14445 "groupTitle": "Jscripty_Projects"
14449 "url": "/api/jscripty/projects",
14450 "title": "Creates a new Project",
14453 "title": "Example usage:",
14454 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14458 "name": "CreateProjects",
14459 "group": "Jscripty_Projects",
14474 "field": "description",
14481 "field": "formData",
14488 "field": "enableUncompleteSave",
14495 "field": "sendUnpauseOnSubmit",
14501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14502 "version": "0.0.0",
14503 "filename": "server/api/jscriptyProject/index.js",
14504 "groupTitle": "Jscripty_Projects"
14508 "url": "/api/jscripty/projects/{id}",
14509 "title": "Deletes a Project",
14512 "title": "Example usage:",
14513 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14517 "name": "DeleteProjects",
14518 "group": "Jscripty_Projects",
14519 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14520 "version": "0.0.0",
14521 "filename": "server/api/jscriptyProject/index.js",
14522 "groupTitle": "Jscripty_Projects"
14526 "url": "/api/jscripty/projects",
14527 "title": "Gets a list of Projects",
14530 "title": "Example usage:",
14531 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14535 "name": "GetProjects",
14536 "group": "Jscripty_Projects",
14537 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14538 "version": "0.0.0",
14539 "filename": "server/api/jscriptyProject/index.js",
14540 "groupTitle": "Jscripty_Projects"
14544 "url": "/api/jscripty/projects/{id}",
14545 "title": "Gets a single Project",
14548 "title": "Example usage:",
14549 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14553 "name": "ShowProjects",
14554 "group": "Jscripty_Projects",
14555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14556 "version": "0.0.0",
14557 "filename": "server/api/jscriptyProject/index.js",
14558 "groupTitle": "Jscripty_Projects"
14562 "url": "/api/jscripty/projects/{id}/answers",
14563 "title": "Gets jscripty project answers",
14566 "title": "Example usage:",
14567 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14571 "name": "getAnswers",
14572 "group": "Jscripty_Projects",
14573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14574 "version": "0.0.0",
14575 "filename": "server/api/jscriptyProject/index.js",
14576 "groupTitle": "Jscripty_Projects"
14580 "url": "/api/jscripty/projects/{id}/sessions",
14581 "title": "Gets jscripty project sessions",
14584 "title": "Example usage:",
14585 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14589 "name": "getSessions",
14590 "group": "Jscripty_Projects",
14591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14592 "version": "0.0.0",
14593 "filename": "server/api/jscriptyProject/index.js",
14594 "groupTitle": "Jscripty_Projects"
14598 "url": "/api/jscripty/projects/{id}/summary",
14599 "title": "Gets jscripty project summary",
14602 "title": "Example usage:",
14603 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14607 "name": "getSummary",
14608 "group": "Jscripty_Projects",
14609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14610 "version": "0.0.0",
14611 "filename": "server/api/jscriptyProject/index.js",
14612 "groupTitle": "Jscripty_Projects"
14616 "url": "/api/jscripty/projects/{id}",
14617 "title": "Update an existing Project",
14620 "title": "Example usage:",
14621 "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",
14625 "name": "updateProjects",
14626 "group": "Jscripty_Projects",
14627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14628 "version": "0.0.0",
14629 "filename": "server/api/jscriptyProject/index.js",
14630 "groupTitle": "Jscripty_Projects"
14634 "url": "/api/license",
14635 "title": "Gets License Info",
14638 "title": "Example usage:",
14639 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14644 "group": "License",
14645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14646 "version": "0.0.0",
14647 "filename": "server/api/license/index.js",
14648 "groupTitle": "License"
14652 "url": "/api/license/{id}",
14653 "title": "Update License Info",
14656 "title": "Example usage:",
14657 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14662 "group": "License",
14663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14664 "version": "0.0.0",
14665 "filename": "server/api/license/index.js",
14666 "groupTitle": "License"
14670 "url": "/api/mail/accounts/{id}/users",
14671 "title": "Add agents to a mail account",
14674 "title": "Example usage:",
14675 "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",
14679 "name": "AddAgents",
14680 "group": "Mail_Accounts",
14681 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14682 "version": "0.0.0",
14683 "filename": "server/api/mailAccount/index.js",
14684 "groupTitle": "Mail_Accounts"
14688 "url": "/api/mail/accounts/{id}/in_servers",
14689 "title": "Creates a new IMAP server",
14692 "title": "Example usage:",
14693 "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",
14698 "group": "Mail_Accounts",
14706 "field": "description",
14720 "field": "authentication",
14734 "field": "password",
14755 "field": "mailbox",
14762 "field": "connTimeout",
14769 "field": "authTimeout",
14776 "field": "service",
14782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14783 "version": "0.0.0",
14784 "filename": "server/api/mailAccount/index.js",
14785 "groupTitle": "Mail_Accounts"
14789 "url": "/api/mail/accounts/{id}/out_servers",
14790 "title": "Creates a new SMTP server",
14793 "title": "Example usage:",
14794 "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",
14799 "group": "Mail_Accounts",
14807 "field": "description",
14849 "field": "service",
14856 "field": "authentication",
14862 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14863 "version": "0.0.0",
14864 "filename": "server/api/mailAccount/index.js",
14865 "groupTitle": "Mail_Accounts"
14869 "url": "/api/mail/accounts/{id}",
14870 "title": "Deletes a mail account",
14873 "title": "Example usage:",
14874 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14878 "name": "DeleteMailAccounts",
14879 "group": "Mail_Accounts",
14880 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14881 "version": "0.0.0",
14882 "filename": "server/api/mailAccount/index.js",
14883 "groupTitle": "Mail_Accounts"
14887 "url": "/api/mail/accounts/describe",
14888 "title": "Gets table info about Accounts",
14891 "title": "Example usage:",
14892 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14896 "name": "DescribeAccounts",
14897 "group": "Mail_Accounts",
14898 "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>",
14899 "version": "0.0.0",
14900 "filename": "server/api/mailAccount/index.js",
14901 "groupTitle": "Mail_Accounts"
14905 "url": "/api/mail/accounts",
14906 "title": "Gets a list of Accounts",
14909 "title": "Example usage:",
14910 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14914 "name": "GetAccounts",
14915 "group": "Mail_Accounts",
14916 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14917 "version": "0.0.0",
14918 "filename": "server/api/mailAccount/index.js",
14919 "groupTitle": "Mail_Accounts"
14923 "url": "/api/mail/accounts/{id}/users",
14924 "title": "Gets agents from mail account",
14927 "title": "Example usage:",
14928 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14932 "name": "GetAgents",
14933 "group": "Mail_Accounts",
14934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14935 "version": "0.0.0",
14936 "filename": "server/api/mailAccount/index.js",
14937 "groupTitle": "Mail_Accounts"
14941 "url": "/api/mail/accounts/{id}/in_servers",
14942 "title": "Gets account IMAP server",
14945 "title": "Example usage:",
14946 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14951 "group": "Mail_Accounts",
14952 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14953 "version": "0.0.0",
14954 "filename": "server/api/mailAccount/index.js",
14955 "groupTitle": "Mail_Accounts"
14959 "url": "/api/mail/accounts/{id}/out_servers",
14960 "title": "Gets account SMTP server",
14963 "title": "Example usage:",
14964 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14969 "group": "Mail_Accounts",
14970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14971 "version": "0.0.0",
14972 "filename": "server/api/mailAccount/index.js",
14973 "groupTitle": "Mail_Accounts"
14977 "url": "/api/mail/accounts/{id}/users",
14978 "title": "Removes agents from a mail account",
14981 "title": "Example usage:",
14982 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14986 "name": "RemoveAgents",
14987 "group": "Mail_Accounts",
14988 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14989 "version": "0.0.0",
14990 "filename": "server/api/mailAccount/index.js",
14991 "groupTitle": "Mail_Accounts"
14995 "url": "/api/mail/accounts/{id}/canned_answers",
14996 "title": "Removes canned answers from account",
14999 "title": "Example usage:",
15000 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15004 "name": "RemoveAnswers",
15005 "group": "Mail_Accounts",
15006 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15007 "version": "0.0.0",
15008 "filename": "server/api/mailAccount/index.js",
15009 "groupTitle": "Mail_Accounts"
15013 "url": "/api/mail/accounts/{id}/dispositions",
15014 "title": "Removes dispositions from account",
15017 "title": "Example usage:",
15018 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15022 "name": "RemoveDispositions",
15023 "group": "Mail_Accounts",
15024 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15025 "version": "0.0.0",
15026 "filename": "server/api/mailAccount/index.js",
15027 "groupTitle": "Mail_Accounts"
15031 "url": "/api/mail/accounts/{id}/in_servers",
15032 "title": "Removes IMAP server from an account",
15035 "title": "Example usage:",
15036 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15040 "name": "RemoveImmap",
15041 "group": "Mail_Accounts",
15042 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15043 "version": "0.0.0",
15044 "filename": "server/api/mailAccount/index.js",
15045 "groupTitle": "Mail_Accounts"
15049 "url": "/api/mail/accounts/{id}/out_servers",
15050 "title": "Removes SMTP server from an account",
15053 "title": "Example usage:",
15054 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15058 "name": "RemoveSmtp",
15059 "group": "Mail_Accounts",
15060 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15061 "version": "0.0.0",
15062 "filename": "server/api/mailAccount/index.js",
15063 "groupTitle": "Mail_Accounts"
15067 "url": "/api/mail/accounts/{id}",
15068 "title": "Gets a single Account",
15071 "title": "Example usage:",
15072 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15076 "name": "ShowAccounts",
15077 "group": "Mail_Accounts",
15078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15079 "version": "0.0.0",
15080 "filename": "server/api/mailAccount/index.js",
15081 "groupTitle": "Mail_Accounts"
15085 "url": "/api/mail/accounts/{id}/canned_answers",
15086 "title": "Creates new canned answer",
15089 "title": "Example usage:",
15090 "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",
15094 "name": "addAnswer",
15095 "group": "Mail_Accounts",
15117 "field": "description",
15130 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15131 "version": "0.0.0",
15132 "filename": "server/api/mailAccount/index.js",
15133 "groupTitle": "Mail_Accounts"
15137 "url": "/api/mail/accounts/{id}/applications",
15138 "title": "Creates new applications",
15141 "title": "Example usage:",
15142 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15146 "name": "addApplications",
15147 "group": "Mail_Accounts",
15155 "field": "priority",
15169 "field": "appdata",
15176 "field": "description",
15183 "field": "interval",
15189 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/dispositions",
15197 "title": "Creates new disposition",
15200 "title": "Example usage:",
15201 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15205 "name": "addDisposition",
15206 "group": "Mail_Accounts",
15233 "field": "description",
15239 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15240 "version": "0.0.0",
15241 "filename": "server/api/mailAccount/index.js",
15242 "groupTitle": "Mail_Accounts"
15246 "url": "/api/mail/accounts/{id}/interactions",
15247 "title": "Creates new interactions",
15250 "title": "Example usage:",
15251 "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",
15255 "name": "addInteraction",
15256 "group": "Mail_Accounts",
15271 "field": "closedAt",
15278 "field": "disposition",
15285 "field": "secondDisposition",
15292 "field": "thirdDisposition",
15306 "field": "inReplyTo",
15327 "field": "subject",
15341 "field": "read1stAt",
15348 "field": "substatus",
15355 "field": "substatusAt",
15366 "field": "firstMsgDirection",
15373 "field": "lastMsgAt",
15384 "field": "lastMsgDirection",
15391 "field": "lastMsgBody",
15398 "field": "lastMsgText",
15404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15405 "version": "0.0.0",
15406 "filename": "server/api/mailAccount/index.js",
15407 "groupTitle": "Mail_Accounts"
15411 "url": "/api/mail/accounts",
15412 "title": "Create a mail account",
15415 "title": "Example usage:",
15416 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15421 "group": "Mail_Accounts",
15422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15423 "version": "0.0.0",
15424 "filename": "server/api/mailAccount/index.js",
15425 "groupTitle": "Mail_Accounts"
15429 "url": "/api/mail/accounts/{id}/canned_answers",
15430 "title": "Gets account canned answers",
15433 "title": "Example usage:",
15434 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15438 "name": "getAnswers",
15439 "group": "Mail_Accounts",
15440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15441 "version": "0.0.0",
15442 "filename": "server/api/mailAccount/index.js",
15443 "groupTitle": "Mail_Accounts"
15447 "url": "/api/mail/accounts/{id}/applications",
15448 "title": "Gets account applications",
15451 "title": "Example usage:",
15452 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15456 "name": "getApplications",
15457 "group": "Mail_Accounts",
15458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15459 "version": "0.0.0",
15460 "filename": "server/api/mailAccount/index.js",
15461 "groupTitle": "Mail_Accounts"
15465 "url": "/api/mail/accounts/{id}/dispositions",
15466 "title": "Gets account dispositions",
15469 "title": "Example usage:",
15470 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15474 "name": "getDispositions",
15475 "group": "Mail_Accounts",
15476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15477 "version": "0.0.0",
15478 "filename": "server/api/mailAccount/index.js",
15479 "groupTitle": "Mail_Accounts"
15483 "url": "/api/mail/accounts/{id}/interactions",
15484 "title": "Gets account interactions",
15487 "title": "Example usage:",
15488 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15492 "name": "getInteraction",
15493 "group": "Mail_Accounts",
15494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15495 "version": "0.0.0",
15496 "filename": "server/api/mailAccount/index.js",
15497 "groupTitle": "Mail_Accounts"
15501 "url": "/api/mail/accounts/{id}/messages",
15502 "title": "Gets account messages",
15505 "title": "Example usage:",
15506 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15510 "name": "getMessages",
15511 "group": "Mail_Accounts",
15512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15513 "version": "0.0.0",
15514 "filename": "server/api/mailAccount/index.js",
15515 "groupTitle": "Mail_Accounts"
15519 "url": "/api/mail/accounts/{id}/send",
15520 "title": "Send new mail",
15523 "title": "Example usage:",
15524 "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",
15528 "name": "sendMail",
15529 "group": "Mail_Accounts",
15530 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15531 "version": "0.0.0",
15532 "filename": "server/api/mailAccount/index.js",
15533 "groupTitle": "Mail_Accounts"
15537 "url": "/api/mail/accounts/{id}",
15538 "title": "Update an existing Account",
15541 "title": "Example usage:",
15542 "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",
15546 "name": "updateAccounts",
15547 "group": "Mail_Accounts",
15548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15549 "version": "0.0.0",
15550 "filename": "server/api/mailAccount/index.js",
15551 "groupTitle": "Mail_Accounts"
15555 "url": "/api/mail/accounts/{id}/verify",
15556 "title": "Verify mail account",
15559 "title": "Example usage:",
15560 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15564 "name": "verifySmtp",
15565 "group": "Mail_Accounts",
15566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15567 "version": "0.0.0",
15568 "filename": "server/api/mailAccount/index.js",
15569 "groupTitle": "Mail_Accounts"
15573 "url": "/api/mail/applications/{id}",
15574 "title": "Deletes a Application",
15577 "title": "Example usage:",
15578 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15582 "name": "DeleteApplications",
15583 "group": "Mail_Applications",
15584 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15585 "version": "0.0.0",
15586 "filename": "server/api/mailApplication/index.js",
15587 "groupTitle": "Mail_Applications"
15591 "url": "/api/mail/applications/{id}",
15592 "title": "Gets a single Application",
15595 "title": "Example usage:",
15596 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15600 "name": "ShowApplications",
15601 "group": "Mail_Applications",
15602 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15603 "version": "0.0.0",
15604 "filename": "server/api/mailApplication/index.js",
15605 "groupTitle": "Mail_Applications"
15609 "url": "/api/mail/applications/{id}",
15610 "title": "Update an existing Application",
15613 "title": "Example usage:",
15614 "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",
15618 "name": "updateApplications",
15619 "group": "Mail_Applications",
15620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15621 "version": "0.0.0",
15622 "filename": "server/api/mailApplication/index.js",
15623 "groupTitle": "Mail_Applications"
15627 "url": "/api/mail/interactions/{id}/tags",
15628 "title": "Add tags to the interaction",
15631 "title": "Example usage:",
15632 "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",
15637 "group": "Mail_Interactions",
15638 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15639 "version": "0.0.0",
15640 "filename": "server/api/mailInteraction/index.js",
15641 "groupTitle": "Mail_Interactions"
15645 "url": "/api/mail/interactions",
15646 "title": "Creates a new Interaction",
15649 "title": "Example usage:",
15650 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15654 "name": "CreateInteractions",
15655 "group": "Mail_Interactions",
15670 "field": "closedAt",
15677 "field": "disposition",
15684 "field": "secondDisposition",
15691 "field": "thirdDisposition",
15705 "field": "inReplyTo",
15726 "field": "subject",
15740 "field": "read1stAt",
15747 "field": "substatus",
15754 "field": "substatusAt",
15765 "field": "firstMsgDirection",
15772 "field": "lastMsgAt",
15783 "field": "lastMsgDirection",
15790 "field": "lastMsgBody",
15797 "field": "lastMsgText",
15803 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15804 "version": "0.0.0",
15805 "filename": "server/api/mailInteraction/index.js",
15806 "groupTitle": "Mail_Interactions"
15810 "url": "/api/mail/interactions/{id}",
15811 "title": "Deletes a Interaction",
15814 "title": "Example usage:",
15815 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15819 "name": "DeleteInteractions",
15820 "group": "Mail_Interactions",
15821 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15822 "version": "0.0.0",
15823 "filename": "server/api/mailInteraction/index.js",
15824 "groupTitle": "Mail_Interactions"
15828 "url": "/api/mail/interactions/describe",
15829 "title": "Gets table info about Interactions",
15832 "title": "Example usage:",
15833 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15837 "name": "DescribeInteractions",
15838 "group": "Mail_Interactions",
15839 "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>",
15840 "version": "0.0.0",
15841 "filename": "server/api/mailInteraction/index.js",
15842 "groupTitle": "Mail_Interactions"
15846 "url": "/api/mail/interactions",
15847 "title": "Gets a list of Interactions",
15850 "title": "Example usage:",
15851 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15855 "name": "GetInteractions",
15856 "group": "Mail_Interactions",
15857 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15858 "version": "0.0.0",
15859 "filename": "server/api/mailInteraction/index.js",
15860 "groupTitle": "Mail_Interactions"
15864 "url": "/api/mail/interactions/{id}/tags",
15865 "title": "Removes tags from interaction",
15868 "title": "Example usage:",
15869 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15873 "name": "RemoveTags",
15874 "group": "Mail_Interactions",
15875 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15876 "version": "0.0.0",
15877 "filename": "server/api/mailInteraction/index.js",
15878 "groupTitle": "Mail_Interactions"
15882 "url": "/api/mail/interactions/{id}",
15883 "title": "Gets a single Interaction",
15886 "title": "Example usage:",
15887 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15891 "name": "ShowInteractions",
15892 "group": "Mail_Interactions",
15893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15894 "version": "0.0.0",
15895 "filename": "server/api/mailInteraction/index.js",
15896 "groupTitle": "Mail_Interactions"
15900 "url": "/api/mail/interactions/{id}/messages",
15901 "title": "Creates new message",
15904 "title": "Example usage:",
15905 "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",
15909 "name": "addMessage",
15910 "group": "Mail_Interactions",
15925 "field": "plainBody",
15943 "field": "direction",
15950 "field": "messageId",
15985 "field": "subject",
16020 "field": "originTo",
16027 "field": "originCc",
16033 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16034 "version": "0.0.0",
16035 "filename": "server/api/mailInteraction/index.js",
16036 "groupTitle": "Mail_Interactions"
16040 "url": "/api/mail/interactions/{id}/download",
16041 "title": "Gets interaction",
16044 "title": "Example usage:",
16045 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16049 "name": "download",
16050 "group": "Mail_Interactions",
16051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16052 "version": "0.0.0",
16053 "filename": "server/api/mailInteraction/index.js",
16054 "groupTitle": "Mail_Interactions"
16058 "url": "/api/mail/interactions/{id}/messages",
16059 "title": "Gets interaction messages",
16062 "title": "Example usage:",
16063 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16067 "name": "getMessages",
16068 "group": "Mail_Interactions",
16069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16070 "version": "0.0.0",
16071 "filename": "server/api/mailInteraction/index.js",
16072 "groupTitle": "Mail_Interactions"
16076 "url": "/api/mail/interactions/{id}",
16077 "title": "Update an existing Interaction",
16080 "title": "Example usage:",
16081 "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",
16085 "name": "updateInteractions",
16086 "group": "Mail_Interactions",
16087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16088 "version": "0.0.0",
16089 "filename": "server/api/mailInteraction/index.js",
16090 "groupTitle": "Mail_Interactions"
16094 "url": "/api/mail/messages/{id}",
16095 "title": "Deletes a Message",
16098 "title": "Example usage:",
16099 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16103 "name": "DeleteMessages",
16104 "group": "Mail_Messages",
16105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16106 "version": "0.0.0",
16107 "filename": "server/api/mailMessage/index.js",
16108 "groupTitle": "Mail_Messages"
16112 "url": "/api/mail/messages/describe",
16113 "title": "Gets table info about Messages",
16116 "title": "Example usage:",
16117 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16121 "name": "DescribeMessages",
16122 "group": "Mail_Messages",
16123 "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>",
16124 "version": "0.0.0",
16125 "filename": "server/api/mailMessage/index.js",
16126 "groupTitle": "Mail_Messages"
16130 "url": "/api/mail/messages",
16131 "title": "Gets a list of Messages",
16134 "title": "Example usage:",
16135 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16139 "name": "GetMessages",
16140 "group": "Mail_Messages",
16141 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16142 "version": "0.0.0",
16143 "filename": "server/api/mailMessage/index.js",
16144 "groupTitle": "Mail_Messages"
16148 "url": "/api/mail/messages/{id}",
16149 "title": "Gets a single Message",
16152 "title": "Example usage:",
16153 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16157 "name": "ShowMessages",
16158 "group": "Mail_Messages",
16159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16160 "version": "0.0.0",
16161 "filename": "server/api/mailMessage/index.js",
16162 "groupTitle": "Mail_Messages"
16166 "url": "/api/mail/messages/{id}/accept",
16167 "title": "Accepts message",
16170 "title": "Example usage:",
16171 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16175 "name": "acceptMessage",
16176 "group": "Mail_Messages",
16177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16178 "version": "0.0.0",
16179 "filename": "server/api/mailMessage/index.js",
16180 "groupTitle": "Mail_Messages"
16184 "url": "/api/mail/messages",
16185 "title": "Create a message",
16188 "title": "Example usage:",
16189 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16193 "name": "createMessage",
16194 "group": "Mail_Messages",
16195 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16196 "version": "0.0.0",
16197 "filename": "server/api/mailMessage/index.js",
16198 "groupTitle": "Mail_Messages"
16202 "url": "/api/mail/messages/{id}/download",
16203 "title": "Gets message",
16206 "title": "Example usage:",
16207 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16211 "name": "download",
16212 "group": "Mail_Messages",
16213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16214 "version": "0.0.0",
16215 "filename": "server/api/mailMessage/index.js",
16216 "groupTitle": "Mail_Messages"
16220 "url": "/api/mail/messages/{id}/reject",
16221 "title": "Rejects message",
16224 "title": "Example usage:",
16225 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16229 "name": "rejectMessage",
16230 "group": "Mail_Messages",
16231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16232 "version": "0.0.0",
16233 "filename": "server/api/mailMessage/index.js",
16234 "groupTitle": "Mail_Messages"
16238 "url": "/api/mail/messages/{id}",
16239 "title": "Update an existing Message",
16242 "title": "Example usage:",
16243 "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",
16247 "name": "updateMessages",
16248 "group": "Mail_Messages",
16249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16250 "version": "0.0.0",
16251 "filename": "server/api/mailMessage/index.js",
16252 "groupTitle": "Mail_Messages"
16256 "url": "/api/mail/reports/queue",
16257 "title": "Creates a new Mail Queue Report",
16260 "title": "Example usage:",
16261 "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",
16265 "name": "CreateMail_Queue_Reports",
16266 "group": "Mail_Queue_Reports",
16274 "field": "uniqueid",
16295 "field": "leaveAt",
16302 "field": "acceptAt",
16322 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16323 "version": "0.0.0",
16324 "filename": "server/api/mailQueueReport/index.js",
16325 "groupTitle": "Mail_Queue_Reports"
16329 "url": "/api/mail/reports/queue/{id}",
16330 "title": "Deletes a Mail Queue Report",
16333 "title": "Example usage:",
16334 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16338 "name": "DeleteMail_Queue_Reports",
16339 "group": "Mail_Queue_Reports",
16340 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16341 "version": "0.0.0",
16342 "filename": "server/api/mailQueueReport/index.js",
16343 "groupTitle": "Mail_Queue_Reports"
16347 "url": "/api/mail/reports/queue/describe",
16348 "title": "Gets table info about Mail Queue Reports",
16351 "title": "Example usage:",
16352 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16356 "name": "DescribeMail_Queue_Reports",
16357 "group": "Mail_Queue_Reports",
16358 "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>",
16359 "version": "0.0.0",
16360 "filename": "server/api/mailQueueReport/index.js",
16361 "groupTitle": "Mail_Queue_Reports"
16365 "url": "/api/mail/reports/queue",
16366 "title": "Gets a list of Mail Queue Reports",
16369 "title": "Example usage:",
16370 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16374 "name": "GetMail_Queue_Reports",
16375 "group": "Mail_Queue_Reports",
16376 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16377 "version": "0.0.0",
16378 "filename": "server/api/mailQueueReport/index.js",
16379 "groupTitle": "Mail_Queue_Reports"
16383 "url": "/api/mail/reports/queue/{id}",
16384 "title": "Gets a single Mail Queue Report",
16387 "title": "Example usage:",
16388 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16392 "name": "ShowMail_Queue_Reports",
16393 "group": "Mail_Queue_Reports",
16394 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16395 "version": "0.0.0",
16396 "filename": "server/api/mailQueueReport/index.js",
16397 "groupTitle": "Mail_Queue_Reports"
16401 "url": "/api/mail/reports/queue/{id}",
16402 "title": "Update an existing Mail Queue Report",
16405 "title": "Example usage:",
16406 "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",
16410 "name": "updateMail_Queue_Reports",
16411 "group": "Mail_Queue_Reports",
16412 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16413 "version": "0.0.0",
16414 "filename": "server/api/mailQueueReport/index.js",
16415 "groupTitle": "Mail_Queue_Reports"
16419 "url": "/api/mail/queues/{id}/users",
16420 "title": "Add agents to a queue",
16423 "title": "Example usage:",
16424 "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",
16428 "name": "AddAgents",
16429 "group": "Mail_Queues",
16430 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16431 "version": "0.0.0",
16432 "filename": "server/api/mailQueue/index.js",
16433 "groupTitle": "Mail_Queues"
16437 "url": "/api/mail/queues/{id}/teams",
16438 "title": "Add teams to a queue",
16441 "title": "Example usage:",
16442 "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",
16446 "name": "AddTeams",
16447 "group": "Mail_Queues",
16448 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16449 "version": "0.0.0",
16450 "filename": "server/api/mailQueue/index.js",
16451 "groupTitle": "Mail_Queues"
16455 "url": "/api/mail/queues",
16456 "title": "Creates a new Queue",
16459 "title": "Example usage:",
16460 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16464 "name": "CreateQueues",
16465 "group": "Mail_Queues",
16480 "field": "description",
16487 "field": "timeout",
16499 "field": "strategy",
16505 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16506 "version": "0.0.0",
16507 "filename": "server/api/mailQueue/index.js",
16508 "groupTitle": "Mail_Queues"
16512 "url": "/api/mail/queues/{id}",
16513 "title": "Deletes a Queue",
16516 "title": "Example usage:",
16517 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16521 "name": "DeleteQueues",
16522 "group": "Mail_Queues",
16523 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16524 "version": "0.0.0",
16525 "filename": "server/api/mailQueue/index.js",
16526 "groupTitle": "Mail_Queues"
16530 "url": "/api/mail/queues/describe",
16531 "title": "Gets table info about Queues",
16534 "title": "Example usage:",
16535 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16539 "name": "DescribeQueues",
16540 "group": "Mail_Queues",
16541 "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>",
16542 "version": "0.0.0",
16543 "filename": "server/api/mailQueue/index.js",
16544 "groupTitle": "Mail_Queues"
16548 "url": "/api/mail/queues/{id}/users",
16549 "title": "Gets queue agents",
16552 "title": "Example usage:",
16553 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16557 "name": "GetAgents",
16558 "group": "Mail_Queues",
16559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16560 "version": "0.0.0",
16561 "filename": "server/api/mailQueue/index.js",
16562 "groupTitle": "Mail_Queues"
16566 "url": "/api/mail/queues/{id}/members",
16567 "title": "GetMembers",
16570 "title": "Example usage:",
16571 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16575 "name": "GetMembers",
16576 "group": "Mail_Queues",
16577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16578 "version": "0.0.0",
16579 "filename": "server/api/mailQueue/index.js",
16580 "groupTitle": "Mail_Queues"
16584 "url": "/api/mail/queues",
16585 "title": "Gets a list of Queues",
16588 "title": "Example usage:",
16589 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16593 "name": "GetQueues",
16594 "group": "Mail_Queues",
16595 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16596 "version": "0.0.0",
16597 "filename": "server/api/mailQueue/index.js",
16598 "groupTitle": "Mail_Queues"
16602 "url": "/api/mail/queues/{id}/teams",
16603 "title": "Gets queues list",
16606 "title": "Example usage:",
16607 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16611 "name": "GetTeams",
16612 "group": "Mail_Queues",
16613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16614 "version": "0.0.0",
16615 "filename": "server/api/mailQueue/index.js",
16616 "groupTitle": "Mail_Queues"
16620 "url": "/api/mail/queues/{id}/users",
16621 "title": "Removes agents from a queue",
16624 "title": "Example usage:",
16625 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16629 "name": "RemoveAgents",
16630 "group": "Mail_Queues",
16631 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16632 "version": "0.0.0",
16633 "filename": "server/api/mailQueue/index.js",
16634 "groupTitle": "Mail_Queues"
16638 "url": "/api/mail/queues/{id}",
16639 "title": "Gets a single Queue",
16642 "title": "Example usage:",
16643 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16647 "name": "ShowQueues",
16648 "group": "Mail_Queues",
16649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16650 "version": "0.0.0",
16651 "filename": "server/api/mailQueue/index.js",
16652 "groupTitle": "Mail_Queues"
16656 "url": "/api/mail/queues/{id}",
16657 "title": "Update an existing Queue",
16660 "title": "Example usage:",
16661 "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",
16665 "name": "updateQueues",
16666 "group": "Mail_Queues",
16667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16668 "version": "0.0.0",
16669 "filename": "server/api/mailQueue/index.js",
16670 "groupTitle": "Mail_Queues"
16674 "url": "/api/mail/out_servers",
16675 "title": "Creates a new SMTP",
16678 "title": "Example usage:",
16679 "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",
16683 "name": "CreateSMTPs",
16684 "group": "Mail_SMTP",
16692 "field": "description",
16734 "field": "service",
16741 "field": "authentication",
16747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16748 "version": "0.0.0",
16749 "filename": "server/api/mailServerOut/index.js",
16750 "groupTitle": "Mail_SMTP"
16754 "url": "/api/mail/out_servers/{id}",
16755 "title": "Deletes a SMTP",
16758 "title": "Example usage:",
16759 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16763 "name": "DeleteSMTPs",
16764 "group": "Mail_SMTP",
16765 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16766 "version": "0.0.0",
16767 "filename": "server/api/mailServerOut/index.js",
16768 "groupTitle": "Mail_SMTP"
16772 "url": "/api/mail/out_servers",
16773 "title": "Gets a list of SMTPs",
16776 "title": "Example usage:",
16777 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16781 "name": "GetSMTPs",
16782 "group": "Mail_SMTP",
16783 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16784 "version": "0.0.0",
16785 "filename": "server/api/mailServerOut/index.js",
16786 "groupTitle": "Mail_SMTP"
16790 "url": "/api/mail/out_servers/{id}",
16791 "title": "Gets a single SMTP",
16794 "title": "Example usage:",
16795 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16799 "name": "ShowSMTPs",
16800 "group": "Mail_SMTP",
16801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16802 "version": "0.0.0",
16803 "filename": "server/api/mailServerOut/index.js",
16804 "groupTitle": "Mail_SMTP"
16808 "url": "/api/mail/out_servers/{id}",
16809 "title": "Update an existing SMTP",
16812 "title": "Example usage:",
16813 "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",
16817 "name": "updateSMTPs",
16818 "group": "Mail_SMTP",
16819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16820 "version": "0.0.0",
16821 "filename": "server/api/mailServerOut/index.js",
16822 "groupTitle": "Mail_SMTP"
16826 "url": "/api/mail/substatuses",
16827 "title": "Creates a new Queue",
16830 "title": "Example usage:",
16831 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16835 "name": "CreateSubstatuses",
16836 "group": "Mail_Substatuses",
16851 "field": "description",
16857 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16858 "version": "0.0.0",
16859 "filename": "server/api/mailSubstatus/index.js",
16860 "groupTitle": "Mail_Substatuses"
16864 "url": "/api/mail/substatuses/{id}",
16865 "title": "Deletes a Queue",
16868 "title": "Example usage:",
16869 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16873 "name": "DeleteSubstatuses",
16874 "group": "Mail_Substatuses",
16875 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16876 "version": "0.0.0",
16877 "filename": "server/api/mailSubstatus/index.js",
16878 "groupTitle": "Mail_Substatuses"
16882 "url": "/api/mail/substatuses/describe",
16883 "title": "Gets table info about Substatuses",
16886 "title": "Example usage:",
16887 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16891 "name": "DescribeSubstatuses",
16892 "group": "Mail_Substatuses",
16893 "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>",
16894 "version": "0.0.0",
16895 "filename": "server/api/mailSubstatus/index.js",
16896 "groupTitle": "Mail_Substatuses"
16900 "url": "/api/mail/substatuses",
16901 "title": "Gets a list of Substatuses",
16904 "title": "Example usage:",
16905 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16909 "name": "GetSubstatuses",
16910 "group": "Mail_Substatuses",
16911 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16912 "version": "0.0.0",
16913 "filename": "server/api/mailSubstatus/index.js",
16914 "groupTitle": "Mail_Substatuses"
16918 "url": "/api/mail/substatuses/{id}",
16919 "title": "Gets a single Queue",
16922 "title": "Example usage:",
16923 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16927 "name": "ShowSubstatuses",
16928 "group": "Mail_Substatuses",
16929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16930 "version": "0.0.0",
16931 "filename": "server/api/mailSubstatus/index.js",
16932 "groupTitle": "Mail_Substatuses"
16936 "url": "/api/mail/substatuses/{id}",
16937 "title": "Update an existing Queue",
16940 "title": "Example usage:",
16941 "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",
16945 "name": "updateSubstatuses",
16946 "group": "Mail_Substatuses",
16947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16948 "version": "0.0.0",
16949 "filename": "server/api/mailSubstatus/index.js",
16950 "groupTitle": "Mail_Substatuses"
16954 "url": "/api/mail/reports/transfer",
16955 "title": "Creates a new Mail Transfer Report",
16958 "title": "Example usage:",
16959 "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",
16963 "name": "CreateMail_Transfer_Reports",
16964 "group": "Mail_Transfer_Reports",
16972 "field": "uniqueid",
16991 "field": "transferredAt",
16997 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16998 "version": "0.0.0",
16999 "filename": "server/api/mailTransferReport/index.js",
17000 "groupTitle": "Mail_Transfer_Reports"
17004 "url": "/api/mail/reports/transfer/{id}",
17005 "title": "Deletes a Mail Transfer Report",
17008 "title": "Example usage:",
17009 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17013 "name": "DeleteMail_Transfer_Reports",
17014 "group": "Mail_Transfer_Reports",
17015 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17016 "version": "0.0.0",
17017 "filename": "server/api/mailTransferReport/index.js",
17018 "groupTitle": "Mail_Transfer_Reports"
17022 "url": "/api/mail/reports/transfer/describe",
17023 "title": "Gets table info about Mail Transfer Reports",
17026 "title": "Example usage:",
17027 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17031 "name": "DescribeMail_Transfer_Reports",
17032 "group": "Mail_Transfer_Reports",
17033 "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>",
17034 "version": "0.0.0",
17035 "filename": "server/api/mailTransferReport/index.js",
17036 "groupTitle": "Mail_Transfer_Reports"
17040 "url": "/api/mail/reports/transfer",
17041 "title": "Gets a list of Mail Transfer Reports",
17044 "title": "Example usage:",
17045 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17049 "name": "GetMail_Transfer_Reports",
17050 "group": "Mail_Transfer_Reports",
17051 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17052 "version": "0.0.0",
17053 "filename": "server/api/mailTransferReport/index.js",
17054 "groupTitle": "Mail_Transfer_Reports"
17058 "url": "/api/mail/reports/transfer/{id}",
17059 "title": "Gets a single Mail Transfer Report",
17062 "title": "Example usage:",
17063 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17067 "name": "ShowMail_Transfer_Reports",
17068 "group": "Mail_Transfer_Reports",
17069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17070 "version": "0.0.0",
17071 "filename": "server/api/mailTransferReport/index.js",
17072 "groupTitle": "Mail_Transfer_Reports"
17076 "url": "/api/mail/reports/transfer/{id}",
17077 "title": "Update an existing Mail Transfer Report",
17080 "title": "Example usage:",
17081 "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",
17085 "name": "updateMail_Transfer_Reports",
17086 "group": "Mail_Transfer_Reports",
17087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17088 "version": "0.0.0",
17089 "filename": "server/api/mailTransferReport/index.js",
17090 "groupTitle": "Mail_Transfer_Reports"
17094 "url": "/api/members/reports/describe",
17095 "title": "Gets table info about Member Reports",
17098 "title": "Example usage:",
17099 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17103 "name": "DescribeMember_Reports",
17104 "group": "Member_Reports",
17105 "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>",
17106 "version": "0.0.0",
17107 "filename": "server/api/memberReport/index.js",
17108 "groupTitle": "Member_Reports"
17112 "url": "/api/members/reports",
17113 "title": "Gets a list of Member Reports",
17116 "title": "Example usage:",
17117 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17121 "name": "GetMember_Reports",
17122 "group": "Member_Reports",
17123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17124 "version": "0.0.0",
17125 "filename": "server/api/memberReport/index.js",
17126 "groupTitle": "Member_Reports"
17130 "url": "/api/members/reports/{id}",
17131 "title": "Gets a single Member Report",
17134 "title": "Example usage:",
17135 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17139 "name": "ShowMember_Reports",
17140 "group": "Member_Reports",
17141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17142 "version": "0.0.0",
17143 "filename": "server/api/memberReport/index.js",
17144 "groupTitle": "Member_Reports"
17148 "url": "/api/migrations",
17149 "title": "Gets a list of Migrations",
17152 "title": "Example usage:",
17153 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17157 "name": "GetMigrations",
17158 "group": "Migrations",
17159 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17160 "version": "0.0.0",
17161 "filename": "server/api/migration/index.js",
17162 "groupTitle": "Migrations"
17166 "url": "/api/voice/networks",
17167 "title": "Create a new network",
17170 "title": "Example usage:",
17171 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17176 "group": "Networks",
17177 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17178 "version": "0.0.0",
17179 "filename": "server/api/network/index.js",
17180 "groupTitle": "Networks"
17184 "url": "/api/voice/networks/{id}",
17185 "title": "Deletes a network",
17188 "title": "Example usage:",
17189 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17194 "group": "Networks",
17195 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17196 "version": "0.0.0",
17197 "filename": "server/api/network/index.js",
17198 "groupTitle": "Networks"
17202 "url": "/api/networks",
17203 "title": "Gets a list of Networks",
17206 "title": "Example usage:",
17207 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17211 "name": "GetNetworks",
17212 "group": "Networks",
17213 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17214 "version": "0.0.0",
17215 "filename": "server/api/network/index.js",
17216 "groupTitle": "Networks"
17220 "url": "/api/networks/{id}",
17221 "title": "Gets a single Network",
17224 "title": "Example usage:",
17225 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17229 "name": "ShowNetworks",
17230 "group": "Networks",
17231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17232 "version": "0.0.0",
17233 "filename": "server/api/network/index.js",
17234 "groupTitle": "Networks"
17238 "url": "/api/voice/networks/{id}",
17239 "title": "Update an existing network",
17242 "title": "Example usage:",
17243 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17248 "group": "Networks",
17249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17250 "version": "0.0.0",
17251 "filename": "server/api/network/index.js",
17252 "groupTitle": "Networks"
17256 "url": "/api/notifications",
17257 "title": "Send notification to user",
17260 "title": "Example usage:",
17261 "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17266 "group": "Notifications",
17267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17268 "version": "0.0.0",
17269 "filename": "server/api/notification/index.js",
17270 "groupTitle": "Notifications"
17274 "url": "/api/openchannel/accounts/{id}/users",
17275 "title": "Add agents to a openchannel account",
17278 "title": "Example usage:",
17279 "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",
17283 "name": "AddAgents",
17284 "group": "Openchannel_Accounts",
17285 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17286 "version": "0.0.0",
17287 "filename": "server/api/openchannelAccount/index.js",
17288 "groupTitle": "Openchannel_Accounts"
17292 "url": "/api/openchannel/accounts",
17293 "title": "Creates a new Account",
17296 "title": "Example usage:",
17297 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17301 "name": "CreateAccounts",
17302 "group": "Openchannel_Accounts",
17317 "field": "description",
17331 "field": "replyUri",
17345 "field": "notificationTemplate",
17352 "field": "notificationSound",
17359 "field": "notificationShake",
17366 "field": "waitForTheAssignedAgent",
17380 "field": "queueTransfer",
17387 "field": "queueTransferTimeout",
17394 "field": "agentTransfer",
17401 "field": "agentTransferTimeout",
17408 "field": "mandatoryDispositionPauseId",
17409 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17415 "field": "mandatoryDisposition",
17416 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17421 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17422 "version": "0.0.0",
17423 "filename": "server/api/openchannelAccount/index.js",
17424 "groupTitle": "Openchannel_Accounts"
17428 "url": "/api/openchannel/accounts/{id}",
17429 "title": "Deletes a Account",
17432 "title": "Example usage:",
17433 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17437 "name": "DeleteAccounts",
17438 "group": "Openchannel_Accounts",
17439 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17440 "version": "0.0.0",
17441 "filename": "server/api/openchannelAccount/index.js",
17442 "groupTitle": "Openchannel_Accounts"
17446 "url": "/api/openchannel/accounts/describe",
17447 "title": "Gets table info about Accounts",
17450 "title": "Example usage:",
17451 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17455 "name": "DescribeAccounts",
17456 "group": "Openchannel_Accounts",
17457 "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>",
17458 "version": "0.0.0",
17459 "filename": "server/api/openchannelAccount/index.js",
17460 "groupTitle": "Openchannel_Accounts"
17464 "url": "/api/openchannel/accounts",
17465 "title": "Gets a list of Accounts",
17468 "title": "Example usage:",
17469 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17473 "name": "GetAccounts",
17474 "group": "Openchannel_Accounts",
17475 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17476 "version": "0.0.0",
17477 "filename": "server/api/openchannelAccount/index.js",
17478 "groupTitle": "Openchannel_Accounts"
17482 "url": "/api/openchannel/accounts/{id}/users",
17483 "title": "Gets agents from openchannel account",
17486 "title": "Example usage:",
17487 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17491 "name": "GetAgents",
17492 "group": "Openchannel_Accounts",
17493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17494 "version": "0.0.0",
17495 "filename": "server/api/openchannelAccount/index.js",
17496 "groupTitle": "Openchannel_Accounts"
17500 "url": "/api/openchannel/accounts/{id}/users",
17501 "title": "Removes agents from a openchannel account",
17504 "title": "Example usage:",
17505 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17509 "name": "RemoveAgents",
17510 "group": "Openchannel_Accounts",
17511 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17512 "version": "0.0.0",
17513 "filename": "server/api/openchannelAccount/index.js",
17514 "groupTitle": "Openchannel_Accounts"
17518 "url": "/api/openchannel/accounts/{id}/canned_answers",
17519 "title": "Removes canned answers from account",
17522 "title": "Example usage:",
17523 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17527 "name": "RemoveAnswers",
17528 "group": "Openchannel_Accounts",
17529 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17530 "version": "0.0.0",
17531 "filename": "server/api/openchannelAccount/index.js",
17532 "groupTitle": "Openchannel_Accounts"
17536 "url": "/api/openchannel/accounts/{id}/dispositions",
17537 "title": "Removes dispositions from account",
17540 "title": "Example usage:",
17541 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17545 "name": "RemoveDispositions",
17546 "group": "Openchannel_Accounts",
17547 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17548 "version": "0.0.0",
17549 "filename": "server/api/openchannelAccount/index.js",
17550 "groupTitle": "Openchannel_Accounts"
17554 "url": "/api/openchannel/accounts/{id}",
17555 "title": "Gets a single Account",
17558 "title": "Example usage:",
17559 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17563 "name": "ShowAccounts",
17564 "group": "Openchannel_Accounts",
17565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17566 "version": "0.0.0",
17567 "filename": "server/api/openchannelAccount/index.js",
17568 "groupTitle": "Openchannel_Accounts"
17572 "url": "/api/openchannel/accounts/{id}/canned_answers",
17573 "title": "Creates new canned answer",
17576 "title": "Example usage:",
17577 "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",
17581 "name": "addAnswer",
17582 "group": "Openchannel_Accounts",
17604 "field": "description",
17617 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17618 "version": "0.0.0",
17619 "filename": "server/api/openchannelAccount/index.js",
17620 "groupTitle": "Openchannel_Accounts"
17624 "url": "/api/openchannel/accounts/{id}/applications",
17625 "title": "Creates new applications",
17628 "title": "Example usage:",
17629 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17633 "name": "addApplications",
17634 "group": "Openchannel_Accounts",
17642 "field": "priority",
17656 "field": "appdata",
17663 "field": "description",
17670 "field": "interval",
17676 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17677 "version": "0.0.0",
17678 "filename": "server/api/openchannelAccount/index.js",
17679 "groupTitle": "Openchannel_Accounts"
17683 "url": "/api/openchannel/accounts/{id}/dispositions",
17684 "title": "Creates new disposition",
17687 "title": "Example usage:",
17688 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17692 "name": "addDisposition",
17693 "group": "Openchannel_Accounts",
17720 "field": "description",
17726 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17727 "version": "0.0.0",
17728 "filename": "server/api/openchannelAccount/index.js",
17729 "groupTitle": "Openchannel_Accounts"
17733 "url": "/api/openchannel/accounts/{id}/canned_answers",
17734 "title": "Gets account canned answers",
17737 "title": "Example usage:",
17738 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17742 "name": "getAnswers",
17743 "group": "Openchannel_Accounts",
17744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17745 "version": "0.0.0",
17746 "filename": "server/api/openchannelAccount/index.js",
17747 "groupTitle": "Openchannel_Accounts"
17751 "url": "/api/openchannel/accounts/{id}/applications",
17752 "title": "Gets account applications",
17755 "title": "Example usage:",
17756 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17760 "name": "getApplications",
17761 "group": "Openchannel_Accounts",
17762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17763 "version": "0.0.0",
17764 "filename": "server/api/openchannelAccount/index.js",
17765 "groupTitle": "Openchannel_Accounts"
17769 "url": "/api/openchannel/accounts/{id}/dispositions",
17770 "title": "Gets account dispositions",
17773 "title": "Example usage:",
17774 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17778 "name": "getDispositions",
17779 "group": "Openchannel_Accounts",
17780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17781 "version": "0.0.0",
17782 "filename": "server/api/openchannelAccount/index.js",
17783 "groupTitle": "Openchannel_Accounts"
17787 "url": "/api/openchannel/accounts/{id}/interactions",
17788 "title": "Gets Openchannel Account Interactions",
17791 "title": "Example usage:",
17792 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17796 "name": "getInteractions",
17797 "group": "Openchannel_Accounts",
17798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17799 "version": "0.0.0",
17800 "filename": "server/api/openchannelAccount/index.js",
17801 "groupTitle": "Openchannel_Accounts"
17805 "url": "/api/openchannel/accounts/{id}/notify",
17806 "title": "Notify new message",
17809 "title": "Example usage:",
17810 "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",
17815 "group": "Openchannel_Accounts",
17816 "description": "<p>Motion 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>",
17817 "version": "0.0.0",
17818 "filename": "server/api/openchannelAccount/index.js",
17819 "groupTitle": "Openchannel_Accounts"
17823 "url": "/api/openchannel/accounts/{id}/send",
17824 "title": "Send new openchannel message",
17827 "title": "Example usage:",
17828 "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",
17832 "name": "sendOpenchannel",
17833 "group": "Openchannel_Accounts",
17834 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17835 "version": "0.0.0",
17836 "filename": "server/api/openchannelAccount/index.js",
17837 "groupTitle": "Openchannel_Accounts"
17841 "url": "/api/openchannel/accounts/{id}",
17842 "title": "Update an existing Account",
17845 "title": "Example usage:",
17846 "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",
17850 "name": "updateAccounts",
17851 "group": "Openchannel_Accounts",
17852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17853 "version": "0.0.0",
17854 "filename": "server/api/openchannelAccount/index.js",
17855 "groupTitle": "Openchannel_Accounts"
17859 "url": "/api/openchannel/applications",
17860 "title": "Creates a new Application",
17863 "title": "Example usage:",
17864 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17868 "name": "CreateApplications",
17869 "group": "Openchannel_Applications",
17877 "field": "priority",
17891 "field": "appdata",
17898 "field": "description",
17905 "field": "interval",
17911 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17912 "version": "0.0.0",
17913 "filename": "server/api/openchannelApplication/index.js",
17914 "groupTitle": "Openchannel_Applications"
17918 "url": "/api/openchannel/applications/{id}",
17919 "title": "Deletes a Application",
17922 "title": "Example usage:",
17923 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17927 "name": "DeleteApplications",
17928 "group": "Openchannel_Applications",
17929 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17930 "version": "0.0.0",
17931 "filename": "server/api/openchannelApplication/index.js",
17932 "groupTitle": "Openchannel_Applications"
17936 "url": "/api/openchannel/applications",
17937 "title": "Gets a list of Applications",
17940 "title": "Example usage:",
17941 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17945 "name": "GetApplications",
17946 "group": "Openchannel_Applications",
17947 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17948 "version": "0.0.0",
17949 "filename": "server/api/openchannelApplication/index.js",
17950 "groupTitle": "Openchannel_Applications"
17954 "url": "/api/openchannel/applications/{id}",
17955 "title": "Gets a single Application",
17958 "title": "Example usage:",
17959 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17963 "name": "ShowApplications",
17964 "group": "Openchannel_Applications",
17965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17966 "version": "0.0.0",
17967 "filename": "server/api/openchannelApplication/index.js",
17968 "groupTitle": "Openchannel_Applications"
17972 "url": "/api/openchannel/applications/{id}",
17973 "title": "Update an existing Application",
17976 "title": "Example usage:",
17977 "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",
17981 "name": "updateApplications",
17982 "group": "Openchannel_Applications",
17983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17984 "version": "0.0.0",
17985 "filename": "server/api/openchannelApplication/index.js",
17986 "groupTitle": "Openchannel_Applications"
17990 "url": "/api/openchannel/interactions/{id}/tags",
17991 "title": "Add tags to the interaction",
17994 "title": "Example usage:",
17995 "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",
18000 "group": "Openchannel_Interactions",
18001 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18002 "version": "0.0.0",
18003 "filename": "server/api/openchannelInteraction/index.js",
18004 "groupTitle": "Openchannel_Interactions"
18008 "url": "/api/openchannel/interactions",
18009 "title": "Creates a new Interaction",
18012 "title": "Example usage:",
18013 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18017 "name": "CreateInteractions",
18018 "group": "Openchannel_Interactions",
18033 "field": "closedAt",
18040 "field": "disposition",
18047 "field": "secondDisposition",
18054 "field": "thirdDisposition",
18068 "field": "read1stAt",
18075 "field": "threadId",
18082 "field": "externalUrl",
18089 "field": "lastMsgAt",
18100 "field": "lastMsgDirection",
18113 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18114 "version": "0.0.0",
18115 "filename": "server/api/openchannelInteraction/index.js",
18116 "groupTitle": "Openchannel_Interactions"
18120 "url": "/api/openchannel/interactions/{id}",
18121 "title": "Deletes a Interaction",
18124 "title": "Example usage:",
18125 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18129 "name": "DeleteInteractions",
18130 "group": "Openchannel_Interactions",
18131 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18132 "version": "0.0.0",
18133 "filename": "server/api/openchannelInteraction/index.js",
18134 "groupTitle": "Openchannel_Interactions"
18138 "url": "/api/openchannel/interactions/describe",
18139 "title": "Gets table info about Interactions",
18142 "title": "Example usage:",
18143 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18147 "name": "DescribeInteractions",
18148 "group": "Openchannel_Interactions",
18149 "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>",
18150 "version": "0.0.0",
18151 "filename": "server/api/openchannelInteraction/index.js",
18152 "groupTitle": "Openchannel_Interactions"
18156 "url": "/api/openchannel/interactions",
18157 "title": "Gets a list of Interactions",
18160 "title": "Example usage:",
18161 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18165 "name": "GetInteractions",
18166 "group": "Openchannel_Interactions",
18167 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18168 "version": "0.0.0",
18169 "filename": "server/api/openchannelInteraction/index.js",
18170 "groupTitle": "Openchannel_Interactions"
18174 "url": "/api/openchannel/interactions/{id}/tags",
18175 "title": "Removes tags from interaction",
18178 "title": "Example usage:",
18179 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18183 "name": "RemoveTags",
18184 "group": "Openchannel_Interactions",
18185 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18186 "version": "0.0.0",
18187 "filename": "server/api/openchannelInteraction/index.js",
18188 "groupTitle": "Openchannel_Interactions"
18192 "url": "/api/openchannel/interactions/{id}",
18193 "title": "Gets a single Interaction",
18196 "title": "Example usage:",
18197 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18201 "name": "ShowInteractions",
18202 "group": "Openchannel_Interactions",
18203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18204 "version": "0.0.0",
18205 "filename": "server/api/openchannelInteraction/index.js",
18206 "groupTitle": "Openchannel_Interactions"
18210 "url": "/api/openchannel/interactions/{id}/messages",
18211 "title": "Creates new messages",
18214 "title": "Example usage:",
18215 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18219 "name": "addMessage",
18220 "group": "Openchannel_Interactions",
18253 "field": "direction",
18266 "description": "<p>Motion will return a HTTP status code <code>201</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/openchannelInteraction/index.js",
18269 "groupTitle": "Openchannel_Interactions"
18273 "url": "/api/openchannel/interactions/{id}/download",
18274 "title": "Gets interaction",
18277 "title": "Example usage:",
18278 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18282 "name": "download",
18283 "group": "Openchannel_Interactions",
18284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18285 "version": "0.0.0",
18286 "filename": "server/api/openchannelInteraction/index.js",
18287 "groupTitle": "Openchannel_Interactions"
18291 "url": "/api/openchannel/interactions/{id}/messages",
18292 "title": "Gets interaction messages",
18295 "title": "Example usage:",
18296 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18300 "name": "getMessages",
18301 "group": "Openchannel_Interactions",
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/openchannelInteraction/index.js",
18305 "groupTitle": "Openchannel_Interactions"
18309 "url": "/api/openchannel/interactions/{id}",
18310 "title": "Update an existing Interaction",
18313 "title": "Example usage:",
18314 "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",
18318 "name": "updateInteractions",
18319 "group": "Openchannel_Interactions",
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/openchannelInteraction/index.js",
18323 "groupTitle": "Openchannel_Interactions"
18327 "url": "/api/openchannel/messages",
18328 "title": "Creates a new Message",
18331 "title": "Example usage:",
18332 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18336 "name": "CreateMessages",
18337 "group": "Openchannel_Messages",
18370 "field": "direction",
18383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18384 "version": "0.0.0",
18385 "filename": "server/api/openchannelMessage/index.js",
18386 "groupTitle": "Openchannel_Messages"
18390 "url": "/api/openchannel/messages/{id}",
18391 "title": "Deletes a Message",
18394 "title": "Example usage:",
18395 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18399 "name": "DeleteMessages",
18400 "group": "Openchannel_Messages",
18401 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18402 "version": "0.0.0",
18403 "filename": "server/api/openchannelMessage/index.js",
18404 "groupTitle": "Openchannel_Messages"
18408 "url": "/api/openchannel/messages/describe",
18409 "title": "Gets table info about Messages",
18412 "title": "Example usage:",
18413 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18417 "name": "DescribeMessages",
18418 "group": "Openchannel_Messages",
18419 "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>",
18420 "version": "0.0.0",
18421 "filename": "server/api/openchannelMessage/index.js",
18422 "groupTitle": "Openchannel_Messages"
18426 "url": "/api/openchannel/messages",
18427 "title": "Gets a list of Messages",
18430 "title": "Example usage:",
18431 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18435 "name": "GetMessages",
18436 "group": "Openchannel_Messages",
18437 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18438 "version": "0.0.0",
18439 "filename": "server/api/openchannelMessage/index.js",
18440 "groupTitle": "Openchannel_Messages"
18444 "url": "/api/openchannel/messages/{id}",
18445 "title": "Gets a single Message",
18448 "title": "Example usage:",
18449 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18453 "name": "ShowMessages",
18454 "group": "Openchannel_Messages",
18455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18456 "version": "0.0.0",
18457 "filename": "server/api/openchannelMessage/index.js",
18458 "groupTitle": "Openchannel_Messages"
18462 "url": "/api/openchannel/messages/{id}/accept",
18463 "title": "Accepts message",
18466 "title": "Example usage:",
18467 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18471 "name": "acceptMessage",
18472 "group": "Openchannel_Messages",
18473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18474 "version": "0.0.0",
18475 "filename": "server/api/openchannelMessage/index.js",
18476 "groupTitle": "Openchannel_Messages"
18480 "url": "/api/openchannel/messages/{id}/reject",
18481 "title": "Rejects message",
18484 "title": "Example usage:",
18485 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18489 "name": "rejectMessage",
18490 "group": "Openchannel_Messages",
18491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18492 "version": "0.0.0",
18493 "filename": "server/api/openchannelMessage/index.js",
18494 "groupTitle": "Openchannel_Messages"
18498 "url": "/api/openchannel/messages/{id}",
18499 "title": "Update an existing Message",
18502 "title": "Example usage:",
18503 "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",
18507 "name": "updateMessages",
18508 "group": "Openchannel_Messages",
18509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18510 "version": "0.0.0",
18511 "filename": "server/api/openchannelMessage/index.js",
18512 "groupTitle": "Openchannel_Messages"
18516 "url": "/api/openchannel/reports/queue",
18517 "title": "Creates a new Openchannel Queue Report",
18520 "title": "Example usage:",
18521 "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",
18525 "name": "CreateOpenchannel_Queue_Reports",
18526 "group": "Openchannel_Queue_Reports",
18534 "field": "uniqueid",
18555 "field": "leaveAt",
18562 "field": "acceptAt",
18582 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18583 "version": "0.0.0",
18584 "filename": "server/api/openchannelQueueReport/index.js",
18585 "groupTitle": "Openchannel_Queue_Reports"
18589 "url": "/api/openchannel/reports/queue/{id}",
18590 "title": "Deletes a Openchannel Queue Report",
18593 "title": "Example usage:",
18594 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18598 "name": "DeleteOpenchannel_Queue_Reports",
18599 "group": "Openchannel_Queue_Reports",
18600 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18601 "version": "0.0.0",
18602 "filename": "server/api/openchannelQueueReport/index.js",
18603 "groupTitle": "Openchannel_Queue_Reports"
18607 "url": "/api/openchannel/reports/queue/describe",
18608 "title": "Gets table info about Openchannel Queue Reports",
18611 "title": "Example usage:",
18612 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18616 "name": "DescribeOpenchannel_Queue_Reports",
18617 "group": "Openchannel_Queue_Reports",
18618 "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>",
18619 "version": "0.0.0",
18620 "filename": "server/api/openchannelQueueReport/index.js",
18621 "groupTitle": "Openchannel_Queue_Reports"
18625 "url": "/api/openchannel/reports/queue",
18626 "title": "Gets a list of Openchannel Queue Reports",
18629 "title": "Example usage:",
18630 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18634 "name": "GetOpenchannel_Queue_Reports",
18635 "group": "Openchannel_Queue_Reports",
18636 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18637 "version": "0.0.0",
18638 "filename": "server/api/openchannelQueueReport/index.js",
18639 "groupTitle": "Openchannel_Queue_Reports"
18643 "url": "/api/openchannel/reports/queue/{id}",
18644 "title": "Gets a single Openchannel Queue Report",
18647 "title": "Example usage:",
18648 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18652 "name": "ShowOpenchannel_Queue_Reports",
18653 "group": "Openchannel_Queue_Reports",
18654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18655 "version": "0.0.0",
18656 "filename": "server/api/openchannelQueueReport/index.js",
18657 "groupTitle": "Openchannel_Queue_Reports"
18661 "url": "/api/openchannel/reports/queue/{id}",
18662 "title": "Update an existing Openchannel Queue Report",
18665 "title": "Example usage:",
18666 "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",
18670 "name": "updateOpenchannel_Queue_Reports",
18671 "group": "Openchannel_Queue_Reports",
18672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18673 "version": "0.0.0",
18674 "filename": "server/api/openchannelQueueReport/index.js",
18675 "groupTitle": "Openchannel_Queue_Reports"
18679 "url": "/api/openchannel/queues/{id}/users",
18680 "title": "Add agents to a queue",
18683 "title": "Example usage:",
18684 "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",
18688 "name": "AddAgents",
18689 "group": "Openchannel_Queues",
18690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18691 "version": "0.0.0",
18692 "filename": "server/api/openchannelQueue/index.js",
18693 "groupTitle": "Openchannel_Queues"
18697 "url": "/api/openchannel/queues/{id}/teams",
18698 "title": "Add teams to a queue",
18701 "title": "Example usage:",
18702 "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",
18706 "name": "AddTeams",
18707 "group": "Openchannel_Queues",
18708 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18709 "version": "0.0.0",
18710 "filename": "server/api/openchannelQueue/index.js",
18711 "groupTitle": "Openchannel_Queues"
18715 "url": "/api/openchannel/queues",
18716 "title": "Creates a new Queue",
18719 "title": "Example usage:",
18720 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18724 "name": "CreateQueues",
18725 "group": "Openchannel_Queues",
18740 "field": "description",
18747 "field": "timeout",
18759 "field": "strategy",
18765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18766 "version": "0.0.0",
18767 "filename": "server/api/openchannelQueue/index.js",
18768 "groupTitle": "Openchannel_Queues"
18772 "url": "/api/openchannel/queues/{id}",
18773 "title": "Deletes a Queue",
18776 "title": "Example usage:",
18777 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18781 "name": "DeleteQueues",
18782 "group": "Openchannel_Queues",
18783 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18784 "version": "0.0.0",
18785 "filename": "server/api/openchannelQueue/index.js",
18786 "groupTitle": "Openchannel_Queues"
18790 "url": "/api/openchannel/queues/describe",
18791 "title": "Gets table info about Queues",
18794 "title": "Example usage:",
18795 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18799 "name": "DescribeQueues",
18800 "group": "Openchannel_Queues",
18801 "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>",
18802 "version": "0.0.0",
18803 "filename": "server/api/openchannelQueue/index.js",
18804 "groupTitle": "Openchannel_Queues"
18808 "url": "/api/openchannel/queues/{id}/users",
18809 "title": "Gets queue agents",
18812 "title": "Example usage:",
18813 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18817 "name": "GetAgents",
18818 "group": "Openchannel_Queues",
18819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18820 "version": "0.0.0",
18821 "filename": "server/api/openchannelQueue/index.js",
18822 "groupTitle": "Openchannel_Queues"
18826 "url": "/api/openchannel/queues/{id}/members",
18827 "title": "GetMembers",
18830 "title": "Example usage:",
18831 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18835 "name": "GetMembers",
18836 "group": "Openchannel_Queues",
18837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18838 "version": "0.0.0",
18839 "filename": "server/api/openchannelQueue/index.js",
18840 "groupTitle": "Openchannel_Queues"
18844 "url": "/api/openchannel/queues",
18845 "title": "Gets a list of Queues",
18848 "title": "Example usage:",
18849 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18853 "name": "GetQueues",
18854 "group": "Openchannel_Queues",
18855 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18856 "version": "0.0.0",
18857 "filename": "server/api/openchannelQueue/index.js",
18858 "groupTitle": "Openchannel_Queues"
18862 "url": "/api/openchannel/queues/{id}/teams",
18863 "title": "Gets queues list",
18866 "title": "Example usage:",
18867 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18871 "name": "GetTeams",
18872 "group": "Openchannel_Queues",
18873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18874 "version": "0.0.0",
18875 "filename": "server/api/openchannelQueue/index.js",
18876 "groupTitle": "Openchannel_Queues"
18880 "url": "/api/openchannel/queues/{id}/users",
18881 "title": "Removes agents from a queue",
18884 "title": "Example usage:",
18885 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18889 "name": "RemoveAgents",
18890 "group": "Openchannel_Queues",
18891 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18892 "version": "0.0.0",
18893 "filename": "server/api/openchannelQueue/index.js",
18894 "groupTitle": "Openchannel_Queues"
18898 "url": "/api/openchannel/queues/{id}",
18899 "title": "Gets a single Queue",
18902 "title": "Example usage:",
18903 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18907 "name": "ShowQueues",
18908 "group": "Openchannel_Queues",
18909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18910 "version": "0.0.0",
18911 "filename": "server/api/openchannelQueue/index.js",
18912 "groupTitle": "Openchannel_Queues"
18916 "url": "/api/openchannel/queues/{id}",
18917 "title": "Update an existing Queue",
18920 "title": "Example usage:",
18921 "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",
18925 "name": "updateQueues",
18926 "group": "Openchannel_Queues",
18927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18928 "version": "0.0.0",
18929 "filename": "server/api/openchannelQueue/index.js",
18930 "groupTitle": "Openchannel_Queues"
18934 "url": "/api/openchannel/reports/transfer",
18935 "title": "Creates a new Openchannel Transfer Report",
18938 "title": "Example usage:",
18939 "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",
18943 "name": "CreateOpenchannel_Transfer_Reports",
18944 "group": "Openchannel_Transfer_Reports",
18952 "field": "uniqueid",
18971 "field": "transferredAt",
18977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18978 "version": "0.0.0",
18979 "filename": "server/api/openchannelTransferReport/index.js",
18980 "groupTitle": "Openchannel_Transfer_Reports"
18984 "url": "/api/openchannel/reports/transfer/{id}",
18985 "title": "Deletes a Openchannel Transfer Report",
18988 "title": "Example usage:",
18989 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18993 "name": "DeleteOpenchannel_Transfer_Reports",
18994 "group": "Openchannel_Transfer_Reports",
18995 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18996 "version": "0.0.0",
18997 "filename": "server/api/openchannelTransferReport/index.js",
18998 "groupTitle": "Openchannel_Transfer_Reports"
19002 "url": "/api/openchannel/reports/transfer/describe",
19003 "title": "Gets table info about Openchannel Transfer Reports",
19006 "title": "Example usage:",
19007 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19011 "name": "DescribeOpenchannel_Transfer_Reports",
19012 "group": "Openchannel_Transfer_Reports",
19013 "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>",
19014 "version": "0.0.0",
19015 "filename": "server/api/openchannelTransferReport/index.js",
19016 "groupTitle": "Openchannel_Transfer_Reports"
19020 "url": "/api/openchannel/reports/transfer",
19021 "title": "Gets a list of Openchannel Transfer Reports",
19024 "title": "Example usage:",
19025 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19029 "name": "GetOpenchannel_Transfer_Reports",
19030 "group": "Openchannel_Transfer_Reports",
19031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19032 "version": "0.0.0",
19033 "filename": "server/api/openchannelTransferReport/index.js",
19034 "groupTitle": "Openchannel_Transfer_Reports"
19038 "url": "/api/openchannel/reports/transfer/{id}",
19039 "title": "Gets a single Openchannel Transfer Report",
19042 "title": "Example usage:",
19043 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19047 "name": "ShowOpenchannel_Transfer_Reports",
19048 "group": "Openchannel_Transfer_Reports",
19049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19050 "version": "0.0.0",
19051 "filename": "server/api/openchannelTransferReport/index.js",
19052 "groupTitle": "Openchannel_Transfer_Reports"
19056 "url": "/api/openchannel/reports/transfer/{id}",
19057 "title": "Update an existing Openchannel Transfer Report",
19060 "title": "Example usage:",
19061 "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",
19065 "name": "updateOpenchannel_Transfer_Reports",
19066 "group": "Openchannel_Transfer_Reports",
19067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19068 "version": "0.0.0",
19069 "filename": "server/api/openchannelTransferReport/index.js",
19070 "groupTitle": "Openchannel_Transfer_Reports"
19074 "url": "/api/pauses",
19075 "title": "Creates a new Pause",
19078 "title": "Example usage:",
19079 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19083 "name": "CreatePauses",
19099 "field": "description",
19105 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19106 "version": "0.0.0",
19107 "filename": "server/api/pause/index.js",
19108 "groupTitle": "Pauses"
19112 "url": "/api/pauses/{id}",
19113 "title": "Deletes a Pause",
19116 "title": "Example usage:",
19117 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19121 "name": "DeletePauses",
19123 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19124 "version": "0.0.0",
19125 "filename": "server/api/pause/index.js",
19126 "groupTitle": "Pauses"
19130 "url": "/api/pauses",
19131 "title": "Gets a list of Pauses",
19134 "title": "Example usage:",
19135 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19139 "name": "GetPauses",
19141 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19142 "version": "0.0.0",
19143 "filename": "server/api/pause/index.js",
19144 "groupTitle": "Pauses"
19148 "url": "/api/pauses/{id}",
19149 "title": "Gets a single Pause",
19152 "title": "Example usage:",
19153 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19157 "name": "ShowPauses",
19159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19160 "version": "0.0.0",
19161 "filename": "server/api/pause/index.js",
19162 "groupTitle": "Pauses"
19166 "url": "/api/pauses/{id}",
19167 "title": "Update an existing Pause",
19170 "title": "Example usage:",
19171 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19175 "name": "updatePauses",
19177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19178 "version": "0.0.0",
19179 "filename": "server/api/pause/index.js",
19180 "groupTitle": "Pauses"
19184 "url": "/api/plugins",
19185 "title": "Gets a list of Plugins",
19188 "title": "Example usage:",
19189 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19193 "name": "GetPlugins",
19194 "group": "Plugins",
19195 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19196 "version": "0.0.0",
19197 "filename": "server/api/plugin/index.js",
19198 "groupTitle": "Plugins"
19202 "url": "/api/plugins/{id}",
19203 "title": "Gets a single Plugin",
19206 "title": "Example usage:",
19207 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19211 "name": "ShowPlugins",
19212 "group": "Plugins",
19213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19214 "version": "0.0.0",
19215 "filename": "server/api/plugin/index.js",
19216 "groupTitle": "Plugins"
19220 "url": "/api/plugins/{id}",
19221 "title": "Delete a plugin",
19224 "title": "Example usage:",
19225 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19229 "name": "destroyPlugin",
19230 "group": "Plugins",
19231 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19232 "version": "0.0.0",
19233 "filename": "server/api/plugin/index.js",
19234 "groupTitle": "Plugins"
19238 "url": "/api/plugins/{id}/download",
19239 "title": "Download plugin source code",
19242 "title": "Example usage:",
19243 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19247 "name": "download",
19248 "group": "Plugins",
19249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19250 "version": "0.0.0",
19251 "filename": "server/api/plugin/index.js",
19252 "groupTitle": "Plugins"
19256 "url": "/api/plugins/{id}",
19257 "title": "Update an existing plugin",
19260 "title": "Example usage:",
19261 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19265 "name": "updatePlugin",
19266 "group": "Plugins",
19267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19268 "version": "0.0.0",
19269 "filename": "server/api/plugin/index.js",
19270 "groupTitle": "Plugins"
19274 "url": "/api/plugins",
19275 "title": "Upload new plugin",
19278 "title": "Example usage:",
19279 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19283 "name": "uploadPlugin",
19284 "group": "Plugins",
19285 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19286 "version": "0.0.0",
19287 "filename": "server/api/plugin/index.js",
19288 "groupTitle": "Plugins"
19292 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19293 "title": "Redirect a plugin request to the specified path",
19296 "title": "Example usage:",
19297 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19301 "name": "webhookPlugin",
19302 "group": "Plugins",
19303 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19304 "version": "0.0.0",
19305 "filename": "server/api/plugin/index.js",
19306 "groupTitle": "Plugins"
19310 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19311 "title": "Redirect a plugin request to the specified path",
19314 "title": "Example usage:",
19315 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19319 "name": "webhookPlugin",
19320 "group": "Plugins",
19321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19322 "version": "0.0.0",
19323 "filename": "server/api/plugin/index.js",
19324 "groupTitle": "Plugins"
19328 "url": "/api/pm2/{id}",
19329 "title": "Deletes an existing process",
19332 "title": "Example usage:",
19333 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19337 "name": "DeletePm2Process",
19339 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19340 "version": "0.0.0",
19341 "filename": "server/api/pm2/index.js",
19342 "groupTitle": "Pm2"
19346 "url": "/api/pm2/{id}",
19347 "title": "Gets a single pm2 process",
19350 "title": "Example usage:",
19351 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19355 "name": "GetPm2Process",
19357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19358 "version": "0.0.0",
19359 "filename": "server/api/pm2/index.js",
19360 "groupTitle": "Pm2"
19365 "title": "Gets pm2 processes",
19368 "title": "Example usage:",
19369 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19373 "name": "GetPm2Processes",
19375 "description": "<p>Motion returns the pm2 processes list.</p>",
19376 "version": "0.0.0",
19377 "filename": "server/api/pm2/index.js",
19378 "groupTitle": "Pm2"
19383 "title": "Start a single pm2 process",
19386 "title": "Example usage:",
19387 "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",
19391 "name": "StartPm2Process",
19413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19414 "version": "0.0.0",
19415 "filename": "server/api/pm2/index.js",
19416 "groupTitle": "Pm2"
19420 "url": "/api/pm2/{id}",
19421 "title": "Update an existing process",
19424 "title": "Example usage:",
19425 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19429 "name": "UpdatePm2Process",
19431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19432 "version": "0.0.0",
19433 "filename": "server/api/pm2/index.js",
19434 "groupTitle": "Pm2"
19438 "url": "/api/rpc/campaigns/",
19439 "title": "Gets a list of campaigns",
19442 "title": "Example usage:",
19443 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19447 "name": "Campaigns",
19448 "group": "RPC_Realtime",
19449 "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>",
19450 "version": "0.0.0",
19451 "filename": "server/api/rpc/index.js",
19452 "groupTitle": "RPC_Realtime"
19456 "url": "/api/rpc/fax/accounts",
19457 "title": "Gets a list of FaxAccounts",
19460 "title": "Example usage:",
19461 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19465 "name": "FaxAccounts",
19466 "group": "RPC_Realtime",
19467 "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>",
19468 "version": "0.0.0",
19469 "filename": "server/api/rpc/index.js",
19470 "groupTitle": "RPC_Realtime"
19474 "url": "/api/rpc/agents/:id/capacity",
19475 "title": "Sets agent capacity",
19478 "title": "Example usage:",
19479 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19483 "name": "RTAgentCapacity",
19484 "group": "RPC_Realtime",
19485 "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>",
19486 "version": "0.0.0",
19487 "filename": "server/api/rpc/index.js",
19488 "groupTitle": "RPC_Realtime"
19492 "url": "/api/rpc/agents",
19493 "title": "Gets a list of RTAgents",
19496 "title": "Example usage:",
19497 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19501 "name": "RTAgents",
19502 "group": "RPC_Realtime",
19503 "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>",
19504 "version": "0.0.0",
19505 "filename": "server/api/rpc/index.js",
19506 "groupTitle": "RPC_Realtime"
19510 "url": "/api/rpc/chat/queues",
19511 "title": "Gets a list of RTChatQueues",
19514 "title": "Example usage:",
19515 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19519 "name": "RTChatQueues",
19520 "group": "RPC_Realtime",
19521 "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>",
19522 "version": "0.0.0",
19523 "filename": "server/api/rpc/index.js",
19524 "groupTitle": "RPC_Realtime"
19528 "url": "/api/rpc/fax/queues",
19529 "title": "Gets a list of RTFaxQueues",
19532 "title": "Example usage:",
19533 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19537 "name": "RTFaxQueues",
19538 "group": "RPC_Realtime",
19539 "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>",
19540 "version": "0.0.0",
19541 "filename": "server/api/rpc/index.js",
19542 "groupTitle": "RPC_Realtime"
19546 "url": "/api/rpc/mail/accounts",
19547 "title": "Gets a list of RTMailAccounts",
19550 "title": "Example usage:",
19551 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19555 "name": "RTMailAccounts",
19556 "group": "RPC_Realtime",
19557 "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>",
19558 "version": "0.0.0",
19559 "filename": "server/api/rpc/index.js",
19560 "groupTitle": "RPC_Realtime"
19564 "url": "/api/rpc/mail/queues",
19565 "title": "Gets a list of RTMailQueues",
19568 "title": "Example usage:",
19569 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19573 "name": "RTMailQueues",
19574 "group": "RPC_Realtime",
19575 "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>",
19576 "version": "0.0.0",
19577 "filename": "server/api/rpc/index.js",
19578 "groupTitle": "RPC_Realtime"
19582 "url": "/api/rpc/openchannel/queues",
19583 "title": "Gets a list of RTOpenchannelQueues",
19586 "title": "Example usage:",
19587 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19591 "name": "RTOpenchannelQueues",
19592 "group": "RPC_Realtime",
19593 "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>",
19594 "version": "0.0.0",
19595 "filename": "server/api/rpc/index.js",
19596 "groupTitle": "RPC_Realtime"
19600 "url": "/api/rpc/outbound/channels",
19601 "title": "Gets a list of RTOutboundChannels",
19604 "title": "Example usage:",
19605 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19609 "name": "RTOutboundChannels",
19610 "group": "RPC_Realtime",
19611 "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>",
19612 "version": "0.0.0",
19613 "filename": "server/api/rpc/index.js",
19614 "groupTitle": "RPC_Realtime"
19618 "url": "/api/rpc/sms/queues",
19619 "title": "Gets a list of RTSmsQueues",
19622 "title": "Example usage:",
19623 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19627 "name": "RTSmsQueues",
19628 "group": "RPC_Realtime",
19629 "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>",
19630 "version": "0.0.0",
19631 "filename": "server/api/rpc/index.js",
19632 "groupTitle": "RPC_Realtime"
19636 "url": "/api/rpc/telephones",
19637 "title": "Gets a list of RTTelephones",
19640 "title": "Example usage:",
19641 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19645 "name": "RTTelephones",
19646 "group": "RPC_Realtime",
19647 "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>",
19648 "version": "0.0.0",
19649 "filename": "server/api/rpc/index.js",
19650 "groupTitle": "RPC_Realtime"
19654 "url": "/api/rpc/trunks",
19655 "title": "Gets a list of RTTrunks",
19658 "title": "Example usage:",
19659 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19663 "name": "RTTrunks",
19664 "group": "RPC_Realtime",
19665 "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>",
19666 "version": "0.0.0",
19667 "filename": "server/api/rpc/index.js",
19668 "groupTitle": "RPC_Realtime"
19672 "url": "/api/rpc/voice/channels",
19673 "title": "Gets a list of RTVoiceChannelMixMonitor",
19676 "title": "Example usage:",
19677 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19681 "name": "RTVoiceChannelMixMonitor",
19682 "group": "RPC_Realtime",
19683 "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>",
19684 "version": "0.0.0",
19685 "filename": "server/api/rpc/index.js",
19686 "groupTitle": "RPC_Realtime"
19690 "url": "/api/rpc/voice/channels",
19691 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19694 "title": "Example usage:",
19695 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19699 "name": "RTVoiceChannelStopMixMonitor",
19700 "group": "RPC_Realtime",
19701 "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>",
19702 "version": "0.0.0",
19703 "filename": "server/api/rpc/index.js",
19704 "groupTitle": "RPC_Realtime"
19708 "url": "/api/rpc/voice/channels",
19709 "title": "Gets a list of RTVoiceChannels",
19712 "title": "Example usage:",
19713 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19717 "name": "RTVoiceChannels",
19718 "group": "RPC_Realtime",
19719 "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>",
19720 "version": "0.0.0",
19721 "filename": "server/api/rpc/index.js",
19722 "groupTitle": "RPC_Realtime"
19726 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19727 "title": "Gets a single RTVoiceQueueChannel",
19730 "title": "Example usage:",
19731 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19735 "name": "RTVoiceQueueChannel",
19736 "group": "RPC_Realtime",
19737 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19738 "version": "0.0.0",
19739 "filename": "server/api/rpc/index.js",
19740 "groupTitle": "RPC_Realtime"
19744 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19745 "title": "Hangup a single RTVoiceQueueChannel",
19748 "title": "Example usage:",
19749 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19753 "name": "RTVoiceQueueChannelHangup",
19754 "group": "RPC_Realtime",
19755 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19756 "version": "0.0.0",
19757 "filename": "server/api/rpc/index.js",
19758 "groupTitle": "RPC_Realtime"
19762 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19763 "title": "Hangup a single RTVoiceQueueChannel",
19766 "title": "Example usage:",
19767 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19771 "name": "RTVoiceQueueChannelRedirect",
19772 "group": "RPC_Realtime",
19773 "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>",
19774 "version": "0.0.0",
19775 "filename": "server/api/rpc/index.js",
19776 "groupTitle": "RPC_Realtime"
19780 "url": "/api/rpc/voice/queues/preview/{id}",
19781 "title": "Gets a single preview contact",
19784 "title": "Example usage:",
19785 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19789 "name": "RTVoiceQueuePreview",
19790 "group": "RPC_Realtime",
19791 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19792 "version": "0.0.0",
19793 "filename": "server/api/rpc/index.js",
19794 "groupTitle": "RPC_Realtime"
19798 "url": "/api/rpc/outbound",
19799 "title": "Gets a list of RTOutbound",
19802 "title": "Example usage:",
19803 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19807 "name": "RTVoiceQueues",
19808 "group": "RPC_Realtime",
19809 "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>",
19810 "version": "0.0.0",
19811 "filename": "server/api/rpc/index.js",
19812 "groupTitle": "RPC_Realtime"
19816 "url": "/api/rpc/voice/queues",
19817 "title": "Gets a list of RTVoiceQueues",
19820 "title": "Example usage:",
19821 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19825 "name": "RTVoiceQueues",
19826 "group": "RPC_Realtime",
19827 "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>",
19828 "version": "0.0.0",
19829 "filename": "server/api/rpc/index.js",
19830 "groupTitle": "RPC_Realtime"
19834 "url": "/api/rpc/voice/queues/channels",
19835 "title": "Gets a list of RTVoiceQueuesChannels",
19838 "title": "Example usage:",
19839 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19843 "name": "RTVoiceQueuesChannels",
19844 "group": "RPC_Realtime",
19845 "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>",
19846 "version": "0.0.0",
19847 "filename": "server/api/rpc/index.js",
19848 "groupTitle": "RPC_Realtime"
19852 "url": "/api/rpc/chat/queues/{id}",
19853 "title": "Gets a single RTChatQueue",
19856 "title": "Example usage:",
19857 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19861 "name": "ShowRTChatQueues",
19862 "group": "RPC_Realtime",
19863 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19864 "version": "0.0.0",
19865 "filename": "server/api/rpc/index.js",
19866 "groupTitle": "RPC_Realtime"
19870 "url": "/api/rpc/fax/queues/{id}",
19871 "title": "Gets a single RTFaxQueue",
19874 "title": "Example usage:",
19875 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19879 "name": "ShowRTFaxQueues",
19880 "group": "RPC_Realtime",
19881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19882 "version": "0.0.0",
19883 "filename": "server/api/rpc/index.js",
19884 "groupTitle": "RPC_Realtime"
19888 "url": "/api/rpc/mail/queues/{id}",
19889 "title": "Gets a single RTMailQueue",
19892 "title": "Example usage:",
19893 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19897 "name": "ShowRTMailQueues",
19898 "group": "RPC_Realtime",
19899 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19900 "version": "0.0.0",
19901 "filename": "server/api/rpc/index.js",
19902 "groupTitle": "RPC_Realtime"
19906 "url": "/api/rpc/openchannel/queues/{id}",
19907 "title": "Gets a single RTOpenchannelQueue",
19910 "title": "Example usage:",
19911 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19915 "name": "ShowRTOpenchannelQueues",
19916 "group": "RPC_Realtime",
19917 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19918 "version": "0.0.0",
19919 "filename": "server/api/rpc/index.js",
19920 "groupTitle": "RPC_Realtime"
19924 "url": "/api/rpc/sms/queues/{id}",
19925 "title": "Gets a single RTSmsQueue",
19928 "title": "Example usage:",
19929 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19933 "name": "ShowRTSmsQueues",
19934 "group": "RPC_Realtime",
19935 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19936 "version": "0.0.0",
19937 "filename": "server/api/rpc/index.js",
19938 "groupTitle": "RPC_Realtime"
19942 "url": "/api/rpc/voice/queues/{id}",
19943 "title": "Gets a single RTVoiceQueue",
19946 "title": "Example usage:",
19947 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19951 "name": "ShowRTVoiceQueues",
19952 "group": "RPC_Realtime",
19953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19954 "version": "0.0.0",
19955 "filename": "server/api/rpc/index.js",
19956 "groupTitle": "RPC_Realtime"
19960 "url": "/api/rpc/agents/:id/notify",
19961 "title": "Notify message to a specific agent",
19964 "title": "Example usage:",
19965 "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",
19969 "name": "agentNotify",
19970 "group": "RPC_Realtime",
19971 "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>",
19972 "version": "0.0.0",
19973 "filename": "server/api/rpc/index.js",
19974 "groupTitle": "RPC_Realtime"
19978 "url": "/api/rpc/chat/queues/:id/notify",
19979 "title": "Notify message to a specific queue",
19982 "title": "Example usage:",
19983 "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",
19987 "name": "chatQueueNotify",
19988 "group": "RPC_Realtime",
19989 "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>",
19990 "version": "0.0.0",
19991 "filename": "server/api/rpc/index.js",
19992 "groupTitle": "RPC_Realtime"
19996 "url": "/api/rpc/chat/queues/waitinginteractions",
19997 "title": "Gets a list of chatQueuesWaitingInteractions",
20000 "title": "Example usage:",
20001 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20005 "name": "chatQueuesWaitingInteractions",
20006 "group": "RPC_Realtime",
20007 "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>",
20008 "version": "0.0.0",
20009 "filename": "server/api/rpc/index.js",
20010 "groupTitle": "RPC_Realtime"
20014 "url": "/api/rpc/fax/queues/:id/notify",
20015 "title": "Notify message to a specific queue",
20018 "title": "Example usage:",
20019 "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",
20023 "name": "faxQueueNotify",
20024 "group": "RPC_Realtime",
20025 "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>",
20026 "version": "0.0.0",
20027 "filename": "server/api/rpc/index.js",
20028 "groupTitle": "RPC_Realtime"
20032 "url": "/api/rpc/fax/queues/waitinginteractions",
20033 "title": "Gets a list of faxQueuesWaitingInteractions",
20036 "title": "Example usage:",
20037 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20041 "name": "faxQueuesWaitingInteractions",
20042 "group": "RPC_Realtime",
20043 "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>",
20044 "version": "0.0.0",
20045 "filename": "server/api/rpc/index.js",
20046 "groupTitle": "RPC_Realtime"
20050 "url": "/api/rpc/mail/queues/:id/notify",
20051 "title": "Notify message to a specific queue",
20054 "title": "Example usage:",
20055 "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",
20059 "name": "mailQueueNotify",
20060 "group": "RPC_Realtime",
20061 "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>",
20062 "version": "0.0.0",
20063 "filename": "server/api/rpc/index.js",
20064 "groupTitle": "RPC_Realtime"
20068 "url": "/api/rpc/mail/queues/waitinginteractions",
20069 "title": "Gets a list of mailQueuesWaitingInteractions",
20072 "title": "Example usage:",
20073 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20077 "name": "mailQueuesWaitingInteractions",
20078 "group": "RPC_Realtime",
20079 "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>",
20080 "version": "0.0.0",
20081 "filename": "server/api/rpc/index.js",
20082 "groupTitle": "RPC_Realtime"
20086 "url": "/api/rpc/openchannel/queues/:id/notify",
20087 "title": "Notify message to a specific queue",
20090 "title": "Example usage:",
20091 "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",
20095 "name": "openchannelQueueNotify",
20096 "group": "RPC_Realtime",
20097 "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>",
20098 "version": "0.0.0",
20099 "filename": "server/api/rpc/index.js",
20100 "groupTitle": "RPC_Realtime"
20104 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20105 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20108 "title": "Example usage:",
20109 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20113 "name": "openchannelQueuesIdWaitingInteractions",
20114 "group": "RPC_Realtime",
20115 "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>",
20116 "version": "0.0.0",
20117 "filename": "server/api/rpc/index.js",
20118 "groupTitle": "RPC_Realtime"
20122 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20123 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20126 "title": "Example usage:",
20127 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20131 "name": "openchannelQueuesWaitingInteractions",
20132 "group": "RPC_Realtime",
20133 "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>",
20134 "version": "0.0.0",
20135 "filename": "server/api/rpc/index.js",
20136 "groupTitle": "RPC_Realtime"
20140 "url": "/api/rpc/sms/queues/:id/notify",
20141 "title": "Notify message to a specific queue",
20144 "title": "Example usage:",
20145 "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",
20149 "name": "smsQueueNotify",
20150 "group": "RPC_Realtime",
20151 "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>",
20152 "version": "0.0.0",
20153 "filename": "server/api/rpc/index.js",
20154 "groupTitle": "RPC_Realtime"
20158 "url": "/api/rpc/sms/queues/waitinginteractions",
20159 "title": "Gets a list of smsQueuesWaitingInteractions",
20162 "title": "Example usage:",
20163 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20167 "name": "smsQueuesWaitingInteractions",
20168 "group": "RPC_Realtime",
20169 "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>",
20170 "version": "0.0.0",
20171 "filename": "server/api/rpc/index.js",
20172 "groupTitle": "RPC_Realtime"
20176 "url": "/api/integrations/salesforce/accounts",
20177 "title": "Creates a new Salesforce Account",
20180 "title": "Example usage:",
20181 "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",
20185 "name": "CreateSalesforce_Accounts",
20186 "group": "Salesforce_Accounts",
20201 "field": "description",
20208 "field": "username",
20215 "field": "remoteUri",
20222 "field": "password",
20229 "field": "clientId",
20236 "field": "clientSecret",
20243 "field": "securityToken",
20250 "field": "serverUrl",
20257 "\"integrationTab\"",
20267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20268 "version": "0.0.0",
20269 "filename": "server/api/intSalesforceAccount/index.js",
20270 "groupTitle": "Salesforce_Accounts"
20274 "url": "/api/integrations/salesforce/accounts/{id}",
20275 "title": "Deletes a Salesforce Account",
20278 "title": "Example usage:",
20279 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20283 "name": "DeleteSalesforce_Accounts",
20284 "group": "Salesforce_Accounts",
20285 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20286 "version": "0.0.0",
20287 "filename": "server/api/intSalesforceAccount/index.js",
20288 "groupTitle": "Salesforce_Accounts"
20292 "url": "/api/integrations/salesforce/accounts",
20293 "title": "Gets a list of Salesforce Accounts",
20296 "title": "Example usage:",
20297 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20301 "name": "GetSalesforce_Accounts",
20302 "group": "Salesforce_Accounts",
20303 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20304 "version": "0.0.0",
20305 "filename": "server/api/intSalesforceAccount/index.js",
20306 "groupTitle": "Salesforce_Accounts"
20310 "url": "/api/integrations/salesforce/accounts/{id}",
20311 "title": "Gets a single Salesforce Account",
20314 "title": "Example usage:",
20315 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20319 "name": "ShowSalesforce_Accounts",
20320 "group": "Salesforce_Accounts",
20321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20322 "version": "0.0.0",
20323 "filename": "server/api/intSalesforceAccount/index.js",
20324 "groupTitle": "Salesforce_Accounts"
20328 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20329 "title": "Creates new configuration",
20332 "title": "Example usage:",
20333 "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",
20337 "name": "addConfiguration",
20338 "group": "Salesforce_Accounts",
20339 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20340 "version": "0.0.0",
20341 "filename": "server/api/intSalesforceAccount/index.js",
20342 "groupTitle": "Salesforce_Accounts"
20346 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20347 "title": "Gets account configurations",
20350 "title": "Example usage:",
20351 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20355 "name": "getConfigurations",
20356 "group": "Salesforce_Accounts",
20357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20358 "version": "0.0.0",
20359 "filename": "server/api/intSalesforceAccount/index.js",
20360 "groupTitle": "Salesforce_Accounts"
20364 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20365 "title": "Gets account fields",
20368 "title": "Example usage:",
20369 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20373 "name": "getFields",
20374 "group": "Salesforce_Accounts",
20375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20376 "version": "0.0.0",
20377 "filename": "server/api/intSalesforceAccount/index.js",
20378 "groupTitle": "Salesforce_Accounts"
20382 "url": "/api/integrations/salesforce/accounts/{id}",
20383 "title": "Update an existing Salesforce Account",
20386 "title": "Example usage:",
20387 "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",
20391 "name": "updateSalesforce_Accounts",
20392 "group": "Salesforce_Accounts",
20393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20394 "version": "0.0.0",
20395 "filename": "server/api/intSalesforceAccount/index.js",
20396 "groupTitle": "Salesforce_Accounts"
20400 "url": "/api/integrations/salesforce/configurations",
20401 "title": "Creates a new Salesforce Configuration",
20404 "title": "Example usage:",
20405 "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",
20409 "name": "CreateSalesforce_Configurations",
20410 "group": "Salesforce_Configurations",
20425 "field": "description",
20436 "field": "ticketType",
20443 "\"contact_lead\"",
20448 "field": "moduleSearch",
20460 "field": "moduleCreate",
20466 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20467 "version": "0.0.0",
20468 "filename": "server/api/intSalesforceConfiguration/index.js",
20469 "groupTitle": "Salesforce_Configurations"
20473 "url": "/api/integrations/salesforce/configurations/{id}",
20474 "title": "Deletes a Salesforce Configuration",
20477 "title": "Example usage:",
20478 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20482 "name": "DeleteSalesforce_Configurations",
20483 "group": "Salesforce_Configurations",
20484 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20485 "version": "0.0.0",
20486 "filename": "server/api/intSalesforceConfiguration/index.js",
20487 "groupTitle": "Salesforce_Configurations"
20491 "url": "/api/integrations/salesforce/configurations",
20492 "title": "Gets a list of Salesforce Configurations",
20495 "title": "Example usage:",
20496 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20500 "name": "GetSalesforce_Configurations",
20501 "group": "Salesforce_Configurations",
20502 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20503 "version": "0.0.0",
20504 "filename": "server/api/intSalesforceConfiguration/index.js",
20505 "groupTitle": "Salesforce_Configurations"
20509 "url": "/api/integrations/salesforce/configurations/{id}",
20510 "title": "Gets a single Salesforce Configuration",
20513 "title": "Example usage:",
20514 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20518 "name": "ShowSalesforce_Configurations",
20519 "group": "Salesforce_Configurations",
20520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20521 "version": "0.0.0",
20522 "filename": "server/api/intSalesforceConfiguration/index.js",
20523 "groupTitle": "Salesforce_Configurations"
20527 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20528 "title": "Gets configurations descriptions",
20531 "title": "Example usage:",
20532 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20536 "name": "getDescriptions",
20537 "group": "Salesforce_Configurations",
20538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20539 "version": "0.0.0",
20540 "filename": "server/api/intSalesforceConfiguration/index.js",
20541 "groupTitle": "Salesforce_Configurations"
20545 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20546 "title": "Gets configurations fields",
20549 "title": "Example usage:",
20550 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20554 "name": "getFields",
20555 "group": "Salesforce_Configurations",
20556 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20557 "version": "0.0.0",
20558 "filename": "server/api/intSalesforceConfiguration/index.js",
20559 "groupTitle": "Salesforce_Configurations"
20563 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20564 "title": "Gets configurations subjects",
20567 "title": "Example usage:",
20568 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20572 "name": "getSubjects",
20573 "group": "Salesforce_Configurations",
20574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20575 "version": "0.0.0",
20576 "filename": "server/api/intSalesforceConfiguration/index.js",
20577 "groupTitle": "Salesforce_Configurations"
20581 "url": "/api/integrations/salesforce/configurations/{id}",
20582 "title": "Update an existing Salesforce Configuration",
20585 "title": "Example usage:",
20586 "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",
20590 "name": "updateSalesforce_Configurations",
20591 "group": "Salesforce_Configurations",
20592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20593 "version": "0.0.0",
20594 "filename": "server/api/intSalesforceConfiguration/index.js",
20595 "groupTitle": "Salesforce_Configurations"
20599 "url": "/api/integrations/salesforce/fields",
20600 "title": "Creates a new Salesforce Field",
20603 "title": "Example usage:",
20604 "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",
20608 "name": "CreateSalesforce_Fields",
20609 "group": "Salesforce_Fields",
20619 "\"customVariable\"",
20630 "field": "content",
20646 "\"customVariable\""
20649 "field": "keyType",
20656 "field": "keyContent",
20663 "field": "idField",
20670 "field": "variableName",
20676 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20677 "version": "0.0.0",
20678 "filename": "server/api/intSalesforceField/index.js",
20679 "groupTitle": "Salesforce_Fields"
20683 "url": "/api/integrations/salesforce/fields/{id}",
20684 "title": "Deletes a Salesforce Field",
20687 "title": "Example usage:",
20688 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20692 "name": "DeleteSalesforce_Fields",
20693 "group": "Salesforce_Fields",
20694 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20695 "version": "0.0.0",
20696 "filename": "server/api/intSalesforceField/index.js",
20697 "groupTitle": "Salesforce_Fields"
20701 "url": "/api/integrations/salesforce/fields",
20702 "title": "Gets a list of Salesforce Fields",
20705 "title": "Example usage:",
20706 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20710 "name": "GetSalesforce_Fields",
20711 "group": "Salesforce_Fields",
20712 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20713 "version": "0.0.0",
20714 "filename": "server/api/intSalesforceField/index.js",
20715 "groupTitle": "Salesforce_Fields"
20719 "url": "/api/integrations/salesforce/fields/{id}",
20720 "title": "Gets a single Salesforce Field",
20723 "title": "Example usage:",
20724 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20728 "name": "ShowSalesforce_Fields",
20729 "group": "Salesforce_Fields",
20730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20731 "version": "0.0.0",
20732 "filename": "server/api/intSalesforceField/index.js",
20733 "groupTitle": "Salesforce_Fields"
20737 "url": "/api/integrations/salesforce/fields/{id}",
20738 "title": "Update an existing Salesforce Field",
20741 "title": "Example usage:",
20742 "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",
20746 "name": "updateSalesforce_Fields",
20747 "group": "Salesforce_Fields",
20748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20749 "version": "0.0.0",
20750 "filename": "server/api/intSalesforceField/index.js",
20751 "groupTitle": "Salesforce_Fields"
20755 "url": "/api/schedules",
20756 "title": "Creates a new Schedule",
20759 "title": "Example usage:",
20760 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20764 "name": "CreateSchedules",
20765 "group": "Schedules",
20780 "field": "description",
20801 "field": "startAt",
20815 "field": "subtractNumber",
20831 "field": "subtractUnit",
20861 "field": "sendMail",
20889 "field": "sendIfEmpty",
20895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20896 "version": "0.0.0",
20897 "filename": "server/api/schedule/index.js",
20898 "groupTitle": "Schedules"
20902 "url": "/api/schedules/{id}",
20903 "title": "Deletes a Schedule",
20906 "title": "Example usage:",
20907 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20911 "name": "DeleteSchedules",
20912 "group": "Schedules",
20913 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20914 "version": "0.0.0",
20915 "filename": "server/api/schedule/index.js",
20916 "groupTitle": "Schedules"
20920 "url": "/api/schedules",
20921 "title": "Gets a list of Schedules",
20924 "title": "Example usage:",
20925 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20929 "name": "GetSchedules",
20930 "group": "Schedules",
20931 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20932 "version": "0.0.0",
20933 "filename": "server/api/schedule/index.js",
20934 "groupTitle": "Schedules"
20938 "url": "/api/schedules/{id}",
20939 "title": "Gets a single Schedule",
20942 "title": "Example usage:",
20943 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
20947 "name": "ShowSchedules",
20948 "group": "Schedules",
20949 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20950 "version": "0.0.0",
20951 "filename": "server/api/schedule/index.js",
20952 "groupTitle": "Schedules"
20956 "url": "/api/schedules/{id}/run",
20957 "title": "Run Scheduler",
20960 "title": "Example usage:",
20961 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
20966 "group": "Schedules",
20967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20968 "version": "0.0.0",
20969 "filename": "server/api/schedule/index.js",
20970 "groupTitle": "Schedules"
20974 "url": "/api/schedules/{id}",
20975 "title": "Update an existing Schedule",
20978 "title": "Example usage:",
20979 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20983 "name": "updateSchedules",
20984 "group": "Schedules",
20985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20986 "version": "0.0.0",
20987 "filename": "server/api/schedule/index.js",
20988 "groupTitle": "Schedules"
20992 "url": "/api/screen/recordings",
20993 "title": "Creates a new Recording",
20996 "title": "Example usage:",
20997 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21001 "name": "CreateRecordings",
21002 "group": "Screen_Recordings",
21017 "field": "interactionid",
21024 "field": "channel",
21045 "field": "duration",
21052 "field": "startedAt",
21059 "field": "closedAt",
21066 "field": "createdAt",
21073 "field": "updatedAt",
21079 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21080 "version": "0.0.0",
21081 "filename": "server/api/screenRecording/index.js",
21082 "groupTitle": "Screen_Recordings"
21086 "url": "/api/screen/recordings/describe",
21087 "title": "Gets table info about Recordings",
21090 "title": "Example usage:",
21091 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21095 "name": "DescribeRecordings",
21096 "group": "Screen_Recordings",
21097 "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>",
21098 "version": "0.0.0",
21099 "filename": "server/api/screenRecording/index.js",
21100 "groupTitle": "Screen_Recordings"
21104 "url": "/api/screen/recordings",
21105 "title": "Gets a list of Recordings",
21108 "title": "Example usage:",
21109 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21113 "name": "GetRecordings",
21114 "group": "Screen_Recordings",
21115 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21116 "version": "0.0.0",
21117 "filename": "server/api/screenRecording/index.js",
21118 "groupTitle": "Screen_Recordings"
21122 "url": "/api/screen/recordings/{id}",
21123 "title": "Gets a single Recording",
21126 "title": "Example usage:",
21127 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21131 "name": "ShowRecordings",
21132 "group": "Screen_Recordings",
21133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21134 "version": "0.0.0",
21135 "filename": "server/api/screenRecording/index.js",
21136 "groupTitle": "Screen_Recordings"
21140 "url": "/api/screen/recordings/{id}",
21141 "title": "Delete screen recording",
21144 "title": "Example usage:",
21145 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21150 "group": "Screen_Recordings",
21151 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21152 "version": "0.0.0",
21153 "filename": "server/api/screenRecording/index.js",
21154 "groupTitle": "Screen_Recordings"
21158 "url": "/api/screen/recordings/{id}/download",
21159 "title": "Download Recording",
21162 "title": "Example usage:",
21163 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21167 "name": "download",
21168 "group": "Screen_Recordings",
21169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21170 "version": "0.0.0",
21171 "filename": "server/api/screenRecording/index.js",
21172 "groupTitle": "Screen_Recordings"
21176 "url": "/api/screen/recordings/{id}",
21177 "title": "Update an existing Recording",
21180 "title": "Example usage:",
21181 "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",
21185 "name": "updateRecordings",
21186 "group": "Screen_Recordings",
21187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21188 "version": "0.0.0",
21189 "filename": "server/api/screenRecording/index.js",
21190 "groupTitle": "Screen_Recordings"
21194 "url": "/api/integrations/servicenow/accounts",
21195 "title": "Creates a new Servicenow Account",
21198 "title": "Example usage:",
21199 "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",
21203 "name": "CreateServicenow_Accounts",
21204 "group": "Servicenow_Accounts",
21219 "field": "description",
21226 "field": "username",
21233 "field": "password",
21247 "field": "remoteUri",
21254 "field": "serverUrl",
21260 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21261 "version": "0.0.0",
21262 "filename": "server/api/intServicenowAccount/index.js",
21263 "groupTitle": "Servicenow_Accounts"
21267 "url": "/api/integrations/servicenow/accounts/{id}",
21268 "title": "Deletes a Servicenow Account",
21271 "title": "Example usage:",
21272 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21276 "name": "DeleteServicenow_Accounts",
21277 "group": "Servicenow_Accounts",
21278 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21279 "version": "0.0.0",
21280 "filename": "server/api/intServicenowAccount/index.js",
21281 "groupTitle": "Servicenow_Accounts"
21285 "url": "/api/integrations/servicenow/accounts",
21286 "title": "Gets a list of Servicenow Accounts",
21289 "title": "Example usage:",
21290 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21294 "name": "GetServicenow_Accounts",
21295 "group": "Servicenow_Accounts",
21296 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21297 "version": "0.0.0",
21298 "filename": "server/api/intServicenowAccount/index.js",
21299 "groupTitle": "Servicenow_Accounts"
21303 "url": "/api/integrations/servicenow/accounts/{id}",
21304 "title": "Gets a single Servicenow Account",
21307 "title": "Example usage:",
21308 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21312 "name": "ShowServicenow_Accounts",
21313 "group": "Servicenow_Accounts",
21314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21315 "version": "0.0.0",
21316 "filename": "server/api/intServicenowAccount/index.js",
21317 "groupTitle": "Servicenow_Accounts"
21321 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21322 "title": "Creates new configuration",
21325 "title": "Example usage:",
21326 "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",
21330 "name": "addConfiguration",
21331 "group": "Servicenow_Accounts",
21332 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21333 "version": "0.0.0",
21334 "filename": "server/api/intServicenowAccount/index.js",
21335 "groupTitle": "Servicenow_Accounts"
21339 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21340 "title": "Gets account configurations",
21343 "title": "Example usage:",
21344 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21348 "name": "getConfigurations",
21349 "group": "Servicenow_Accounts",
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/intServicenowAccount/index.js",
21353 "groupTitle": "Servicenow_Accounts"
21357 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21358 "title": "Gets account fields",
21361 "title": "Example usage:",
21362 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21366 "name": "getFields",
21367 "group": "Servicenow_Accounts",
21368 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21369 "version": "0.0.0",
21370 "filename": "server/api/intServicenowAccount/index.js",
21371 "groupTitle": "Servicenow_Accounts"
21375 "url": "/api/integrations/servicenow/accounts/{id}",
21376 "title": "Update an existing Servicenow Account",
21379 "title": "Example usage:",
21380 "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",
21384 "name": "updateServicenow_Accounts",
21385 "group": "Servicenow_Accounts",
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/intServicenowAccount/index.js",
21389 "groupTitle": "Servicenow_Accounts"
21393 "url": "/api/integrations/servicenow/configurations",
21394 "title": "Creates a new Servicenow Configuration",
21397 "title": "Example usage:",
21398 "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",
21402 "name": "CreateServicenow_Configurations",
21403 "group": "Servicenow_Configurations",
21418 "field": "description",
21424 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425 "version": "0.0.0",
21426 "filename": "server/api/intServicenowConfiguration/index.js",
21427 "groupTitle": "Servicenow_Configurations"
21431 "url": "/api/integrations/servicenow/configurations/{id}",
21432 "title": "Deletes a Servicenow Configuration",
21435 "title": "Example usage:",
21436 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21440 "name": "DeleteServicenow_Configurations",
21441 "group": "Servicenow_Configurations",
21442 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443 "version": "0.0.0",
21444 "filename": "server/api/intServicenowConfiguration/index.js",
21445 "groupTitle": "Servicenow_Configurations"
21449 "url": "/api/integrations/servicenow/configurations",
21450 "title": "Gets a list of Servicenow Configurations",
21453 "title": "Example usage:",
21454 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21458 "name": "GetServicenow_Configurations",
21459 "group": "Servicenow_Configurations",
21460 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21461 "version": "0.0.0",
21462 "filename": "server/api/intServicenowConfiguration/index.js",
21463 "groupTitle": "Servicenow_Configurations"
21467 "url": "/api/integrations/servicenow/configurations/{id}",
21468 "title": "Gets a single Servicenow Configuration",
21471 "title": "Example usage:",
21472 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21476 "name": "ShowServicenow_Configurations",
21477 "group": "Servicenow_Configurations",
21478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21479 "version": "0.0.0",
21480 "filename": "server/api/intServicenowConfiguration/index.js",
21481 "groupTitle": "Servicenow_Configurations"
21485 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21486 "title": "Gets configurations descriptions",
21489 "title": "Example usage:",
21490 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21494 "name": "getDescriptions",
21495 "group": "Servicenow_Configurations",
21496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21497 "version": "0.0.0",
21498 "filename": "server/api/intServicenowConfiguration/index.js",
21499 "groupTitle": "Servicenow_Configurations"
21503 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21504 "title": "Gets configurations fields",
21507 "title": "Example usage:",
21508 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21512 "name": "getFields",
21513 "group": "Servicenow_Configurations",
21514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21515 "version": "0.0.0",
21516 "filename": "server/api/intServicenowConfiguration/index.js",
21517 "groupTitle": "Servicenow_Configurations"
21521 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21522 "title": "Gets configurations subjects",
21525 "title": "Example usage:",
21526 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21530 "name": "getSubjects",
21531 "group": "Servicenow_Configurations",
21532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21533 "version": "0.0.0",
21534 "filename": "server/api/intServicenowConfiguration/index.js",
21535 "groupTitle": "Servicenow_Configurations"
21539 "url": "/api/integrations/servicenow/configurations/{id}",
21540 "title": "Update an existing Servicenow Configuration",
21543 "title": "Example usage:",
21544 "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",
21548 "name": "updateServicenow_Configurations",
21549 "group": "Servicenow_Configurations",
21550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21551 "version": "0.0.0",
21552 "filename": "server/api/intServicenowConfiguration/index.js",
21553 "groupTitle": "Servicenow_Configurations"
21557 "url": "/api/integrations/servicenow/fields",
21558 "title": "Creates a new Servicenow Field",
21561 "title": "Example usage:",
21562 "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",
21566 "name": "CreateServicenow_Fields",
21567 "group": "Servicenow_Fields",
21577 "\"customVariable\"",
21588 "field": "content",
21604 "\"customVariable\""
21607 "field": "keyType",
21614 "field": "keyContent",
21621 "field": "idField",
21628 "field": "nameField",
21635 "field": "customField",
21642 "field": "variableName",
21648 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21649 "version": "0.0.0",
21650 "filename": "server/api/intServicenowField/index.js",
21651 "groupTitle": "Servicenow_Fields"
21655 "url": "/api/integrations/servicenow/fields/{id}",
21656 "title": "Deletes a Servicenow Field",
21659 "title": "Example usage:",
21660 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21664 "name": "DeleteServicenow_Fields",
21665 "group": "Servicenow_Fields",
21666 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21667 "version": "0.0.0",
21668 "filename": "server/api/intServicenowField/index.js",
21669 "groupTitle": "Servicenow_Fields"
21673 "url": "/api/integrations/servicenow/fields",
21674 "title": "Gets a list of Servicenow Fields",
21677 "title": "Example usage:",
21678 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21682 "name": "GetServicenow_Fields",
21683 "group": "Servicenow_Fields",
21684 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21685 "version": "0.0.0",
21686 "filename": "server/api/intServicenowField/index.js",
21687 "groupTitle": "Servicenow_Fields"
21691 "url": "/api/integrations/servicenow/fields/{id}",
21692 "title": "Gets a single Servicenow Field",
21695 "title": "Example usage:",
21696 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21700 "name": "ShowServicenow_Fields",
21701 "group": "Servicenow_Fields",
21702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21703 "version": "0.0.0",
21704 "filename": "server/api/intServicenowField/index.js",
21705 "groupTitle": "Servicenow_Fields"
21709 "url": "/api/integrations/servicenow/fields/{id}",
21710 "title": "Update an existing Servicenow Field",
21713 "title": "Example usage:",
21714 "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",
21718 "name": "updateServicenow_Fields",
21719 "group": "Servicenow_Fields",
21720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21721 "version": "0.0.0",
21722 "filename": "server/api/intServicenowField/index.js",
21723 "groupTitle": "Servicenow_Fields"
21727 "url": "/api/settings",
21728 "title": "Gets a list of Settings",
21731 "title": "Example usage:",
21732 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21736 "name": "GetSettings",
21737 "group": "Settings",
21738 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21739 "version": "0.0.0",
21740 "filename": "server/api/setting/index.js",
21741 "groupTitle": "Settings"
21745 "url": "/api/settings/{id}",
21746 "title": "Gets a single Setting",
21749 "title": "Example usage:",
21750 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21754 "name": "ShowSettings",
21755 "group": "Settings",
21756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21757 "version": "0.0.0",
21758 "filename": "server/api/setting/index.js",
21759 "groupTitle": "Settings"
21763 "url": "/api/settings/{id}/favicon",
21764 "title": "Add Favicon",
21767 "title": "Example usage:",
21768 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21772 "name": "addFavicon",
21773 "group": "Settings",
21774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21775 "version": "0.0.0",
21776 "filename": "server/api/setting/index.js",
21777 "groupTitle": "Settings"
21781 "url": "/api/settings/{id}/logo",
21782 "title": "Add logo",
21785 "title": "Example usage:",
21786 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21791 "group": "Settings",
21792 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21793 "version": "0.0.0",
21794 "filename": "server/api/setting/index.js",
21795 "groupTitle": "Settings"
21799 "url": "/api/settings/{id}/logo_login",
21800 "title": "Add logo login",
21803 "title": "Example usage:",
21804 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21808 "name": "addLogoLogin",
21809 "group": "Settings",
21810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21811 "version": "0.0.0",
21812 "filename": "server/api/setting/index.js",
21813 "groupTitle": "Settings"
21817 "url": "/api/settings/{id}/preferred",
21818 "title": "Add Preferred",
21821 "title": "Example usage:",
21822 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21826 "name": "addPreferred",
21827 "group": "Settings",
21828 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21829 "version": "0.0.0",
21830 "filename": "server/api/setting/index.js",
21831 "groupTitle": "Settings"
21835 "url": "/api/settings/{id}/favicon",
21836 "title": "Get Favicon",
21839 "title": "Example usage:",
21840 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21844 "name": "getFavicon",
21845 "group": "Settings",
21846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21847 "version": "0.0.0",
21848 "filename": "server/api/setting/index.js",
21849 "groupTitle": "Settings"
21853 "url": "/api/settings/{id}/gdpr",
21854 "title": "Get gdpr settings",
21857 "title": "Example usage:",
21858 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21863 "group": "Settings",
21864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21865 "version": "0.0.0",
21866 "filename": "server/api/setting/index.js",
21867 "groupTitle": "Settings"
21871 "url": "/api/settings/{id}/logo",
21872 "title": "Get logo",
21875 "title": "Example usage:",
21876 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21881 "group": "Settings",
21882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21883 "version": "0.0.0",
21884 "filename": "server/api/setting/index.js",
21885 "groupTitle": "Settings"
21889 "url": "/api/settings/{id}/logo_login",
21890 "title": "Get logo login",
21893 "title": "Example usage:",
21894 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21898 "name": "getLogoLogin",
21899 "group": "Settings",
21900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21901 "version": "0.0.0",
21902 "filename": "server/api/setting/index.js",
21903 "groupTitle": "Settings"
21907 "url": "/api/settings/{id}/preferred",
21908 "title": "Get Preferred",
21911 "title": "Example usage:",
21912 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21916 "name": "getPreferred",
21917 "group": "Settings",
21918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21919 "version": "0.0.0",
21920 "filename": "server/api/setting/index.js",
21921 "groupTitle": "Settings"
21925 "url": "/api/settings/{id}",
21926 "title": "Update an existing Setting",
21929 "title": "Example usage:",
21930 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21934 "name": "updateSettings",
21935 "group": "Settings",
21936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21937 "version": "0.0.0",
21938 "filename": "server/api/setting/index.js",
21939 "groupTitle": "Settings"
21943 "url": "/api/sms/accounts/{id}/users",
21944 "title": "Add agents to a sms account",
21947 "title": "Example usage:",
21948 "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",
21952 "name": "AddAgents",
21953 "group": "Sms_Accounts",
21954 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21955 "version": "0.0.0",
21956 "filename": "server/api/smsAccount/index.js",
21957 "groupTitle": "Sms_Accounts"
21961 "url": "/api/sms/accounts",
21962 "title": "Creates a new Account",
21965 "title": "Example usage:",
21966 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21970 "name": "CreateAccounts",
21971 "group": "Sms_Accounts",
22032 "field": "accountSid",
22046 "field": "authToken",
22058 "field": "smsMethod",
22065 "field": "username",
22072 "field": "password",
22086 "field": "senderString",
22093 "field": "deliveryReport",
22100 "field": "description",
22107 "field": "notificationTemplate",
22114 "field": "notificationSound",
22121 "field": "notificationShake",
22128 "field": "waitForTheAssignedAgent",
22135 "field": "queueTransfer",
22142 "field": "queueTransferTimeout",
22149 "field": "agentTransfer",
22156 "field": "agentTransferTimeout",
22163 "field": "baseUrl",
22170 "field": "mandatoryDispositionPauseId",
22171 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22177 "field": "mandatoryDisposition",
22178 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22183 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22184 "version": "0.0.0",
22185 "filename": "server/api/smsAccount/index.js",
22186 "groupTitle": "Sms_Accounts"
22190 "url": "/api/sms/accounts/{id}",
22191 "title": "Deletes a Account",
22194 "title": "Example usage:",
22195 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22199 "name": "DeleteAccounts",
22200 "group": "Sms_Accounts",
22201 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22202 "version": "0.0.0",
22203 "filename": "server/api/smsAccount/index.js",
22204 "groupTitle": "Sms_Accounts"
22208 "url": "/api/sms/accounts/describe",
22209 "title": "Gets table info about Accounts",
22212 "title": "Example usage:",
22213 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22217 "name": "DescribeAccounts",
22218 "group": "Sms_Accounts",
22219 "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>",
22220 "version": "0.0.0",
22221 "filename": "server/api/smsAccount/index.js",
22222 "groupTitle": "Sms_Accounts"
22226 "url": "/api/sms/accounts",
22227 "title": "Gets a list of Accounts",
22230 "title": "Example usage:",
22231 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22235 "name": "GetAccounts",
22236 "group": "Sms_Accounts",
22237 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22238 "version": "0.0.0",
22239 "filename": "server/api/smsAccount/index.js",
22240 "groupTitle": "Sms_Accounts"
22244 "url": "/api/sms/accounts/{id}/users",
22245 "title": "Gets agents from sms account",
22248 "title": "Example usage:",
22249 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22253 "name": "GetAgents",
22254 "group": "Sms_Accounts",
22255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22256 "version": "0.0.0",
22257 "filename": "server/api/smsAccount/index.js",
22258 "groupTitle": "Sms_Accounts"
22262 "url": "/api/sms/accounts/{id}/users",
22263 "title": "Removes agents from a sms account",
22266 "title": "Example usage:",
22267 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22271 "name": "RemoveAgents",
22272 "group": "Sms_Accounts",
22273 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22274 "version": "0.0.0",
22275 "filename": "server/api/smsAccount/index.js",
22276 "groupTitle": "Sms_Accounts"
22280 "url": "/api/sms/accounts/{id}/canned_answers",
22281 "title": "Removes canned answers from account",
22284 "title": "Example usage:",
22285 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22289 "name": "RemoveAnswers",
22290 "group": "Sms_Accounts",
22291 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22292 "version": "0.0.0",
22293 "filename": "server/api/smsAccount/index.js",
22294 "groupTitle": "Sms_Accounts"
22298 "url": "/api/sms/accounts/{id}/dispositions",
22299 "title": "Removes dispositions from account",
22302 "title": "Example usage:",
22303 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22307 "name": "RemoveDispositions",
22308 "group": "Sms_Accounts",
22309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22310 "version": "0.0.0",
22311 "filename": "server/api/smsAccount/index.js",
22312 "groupTitle": "Sms_Accounts"
22316 "url": "/api/sms/accounts/{id}",
22317 "title": "Gets a single Account",
22320 "title": "Example usage:",
22321 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22325 "name": "ShowAccounts",
22326 "group": "Sms_Accounts",
22327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22328 "version": "0.0.0",
22329 "filename": "server/api/smsAccount/index.js",
22330 "groupTitle": "Sms_Accounts"
22334 "url": "/api/sms/messages/{id}/accept",
22335 "title": "Accepts message",
22338 "title": "Example usage:",
22339 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22343 "name": "acceptMessage",
22344 "group": "Sms_Accounts",
22345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22346 "version": "0.0.0",
22347 "filename": "server/api/smsMessage/index.js",
22348 "groupTitle": "Sms_Accounts"
22352 "url": "/api/sms/accounts/{id}/canned_answers",
22353 "title": "Creates new canned answer",
22356 "title": "Example usage:",
22357 "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",
22361 "name": "addAnswer",
22362 "group": "Sms_Accounts",
22384 "field": "description",
22397 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22398 "version": "0.0.0",
22399 "filename": "server/api/smsAccount/index.js",
22400 "groupTitle": "Sms_Accounts"
22404 "url": "/api/sms/accounts/{id}/applications",
22405 "title": "Creates new applications",
22408 "title": "Example usage:",
22409 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22413 "name": "addApplications",
22414 "group": "Sms_Accounts",
22422 "field": "priority",
22436 "field": "appdata",
22443 "field": "description",
22450 "field": "interval",
22456 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22457 "version": "0.0.0",
22458 "filename": "server/api/smsAccount/index.js",
22459 "groupTitle": "Sms_Accounts"
22463 "url": "/api/sms/accounts/{id}/dispositions",
22464 "title": "Creates new disposition",
22467 "title": "Example usage:",
22468 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22472 "name": "addDisposition",
22473 "group": "Sms_Accounts",
22500 "field": "description",
22506 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22507 "version": "0.0.0",
22508 "filename": "server/api/smsAccount/index.js",
22509 "groupTitle": "Sms_Accounts"
22513 "url": "/api/sms/accounts/{id}/canned_answers",
22514 "title": "Gets account canned answers",
22517 "title": "Example usage:",
22518 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22522 "name": "getAnswers",
22523 "group": "Sms_Accounts",
22524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22525 "version": "0.0.0",
22526 "filename": "server/api/smsAccount/index.js",
22527 "groupTitle": "Sms_Accounts"
22531 "url": "/api/sms/accounts/{id}/applications",
22532 "title": "Gets account applications",
22535 "title": "Example usage:",
22536 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22540 "name": "getApplications",
22541 "group": "Sms_Accounts",
22542 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22543 "version": "0.0.0",
22544 "filename": "server/api/smsAccount/index.js",
22545 "groupTitle": "Sms_Accounts"
22549 "url": "/api/sms/accounts/{id}/dispositions",
22550 "title": "Gets account dispositions",
22553 "title": "Example usage:",
22554 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22558 "name": "getDispositions",
22559 "group": "Sms_Accounts",
22560 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22561 "version": "0.0.0",
22562 "filename": "server/api/smsAccount/index.js",
22563 "groupTitle": "Sms_Accounts"
22567 "url": "/api/sms/accounts/{id}/interactions",
22568 "title": "Gets Sms Account interactions",
22571 "title": "Example usage:",
22572 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22576 "name": "getInteractions",
22577 "group": "Sms_Accounts",
22578 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22579 "version": "0.0.0",
22580 "filename": "server/api/smsAccount/index.js",
22581 "groupTitle": "Sms_Accounts"
22585 "url": "/api/sms/accounts/{id}/notify",
22586 "title": "Notify new message",
22589 "title": "Example usage:",
22590 "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",
22595 "group": "Sms_Accounts",
22596 "description": "<p>Motion 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>",
22597 "version": "0.0.0",
22598 "filename": "server/api/smsAccount/index.js",
22599 "groupTitle": "Sms_Accounts"
22603 "url": "/api/sms/messages/{id}/reject",
22604 "title": "Rejects message",
22607 "title": "Example usage:",
22608 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22612 "name": "rejectMessage",
22613 "group": "Sms_Accounts",
22614 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22615 "version": "0.0.0",
22616 "filename": "server/api/smsMessage/index.js",
22617 "groupTitle": "Sms_Accounts"
22621 "url": "/api/sms/accounts/{id}/send",
22622 "title": "Send new sms message",
22625 "title": "Example usage:",
22626 "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",
22631 "group": "Sms_Accounts",
22632 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22633 "version": "0.0.0",
22634 "filename": "server/api/smsAccount/index.js",
22635 "groupTitle": "Sms_Accounts"
22639 "url": "/api/sms/messages/{id}/status",
22640 "title": "Receive message status",
22643 "title": "Example usage:",
22644 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22648 "name": "statusMessage",
22649 "group": "Sms_Accounts",
22650 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22651 "version": "0.0.0",
22652 "filename": "server/api/smsMessage/index.js",
22653 "groupTitle": "Sms_Accounts"
22657 "url": "/api/sms/accounts/{id}/status",
22658 "title": "Receive message status",
22661 "title": "Example usage:",
22662 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22666 "name": "statusMessage",
22667 "group": "Sms_Accounts",
22668 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22669 "version": "0.0.0",
22670 "filename": "server/api/smsAccount/index.js",
22671 "groupTitle": "Sms_Accounts"
22675 "url": "/api/sms/accounts/{id}/status",
22676 "title": "Receive message status as get request",
22679 "title": "Example usage:",
22680 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22684 "name": "statusMessage",
22685 "group": "Sms_Accounts",
22686 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22687 "version": "0.0.0",
22688 "filename": "server/api/smsAccount/index.js",
22689 "groupTitle": "Sms_Accounts"
22693 "url": "/api/sms/accounts/{id}",
22694 "title": "Update an existing Account",
22697 "title": "Example usage:",
22698 "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",
22702 "name": "updateAccounts",
22703 "group": "Sms_Accounts",
22704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22705 "version": "0.0.0",
22706 "filename": "server/api/smsAccount/index.js",
22707 "groupTitle": "Sms_Accounts"
22711 "url": "/api/sms/applications",
22712 "title": "Creates a new Application",
22715 "title": "Example usage:",
22716 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22720 "name": "CreateApplications",
22721 "group": "Sms_Applications",
22729 "field": "priority",
22743 "field": "appdata",
22750 "field": "description",
22757 "field": "interval",
22763 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22764 "version": "0.0.0",
22765 "filename": "server/api/smsApplication/index.js",
22766 "groupTitle": "Sms_Applications"
22770 "url": "/api/sms/applications/{id}",
22771 "title": "Deletes a Application",
22774 "title": "Example usage:",
22775 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22779 "name": "DeleteApplications",
22780 "group": "Sms_Applications",
22781 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22782 "version": "0.0.0",
22783 "filename": "server/api/smsApplication/index.js",
22784 "groupTitle": "Sms_Applications"
22788 "url": "/api/sms/applications",
22789 "title": "Gets a list of Applications",
22792 "title": "Example usage:",
22793 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22797 "name": "GetApplications",
22798 "group": "Sms_Applications",
22799 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22800 "version": "0.0.0",
22801 "filename": "server/api/smsApplication/index.js",
22802 "groupTitle": "Sms_Applications"
22806 "url": "/api/sms/applications/{id}",
22807 "title": "Gets a single Application",
22810 "title": "Example usage:",
22811 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22815 "name": "ShowApplications",
22816 "group": "Sms_Applications",
22817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22818 "version": "0.0.0",
22819 "filename": "server/api/smsApplication/index.js",
22820 "groupTitle": "Sms_Applications"
22824 "url": "/api/sms/applications/{id}",
22825 "title": "Update an existing Application",
22828 "title": "Example usage:",
22829 "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",
22833 "name": "updateApplications",
22834 "group": "Sms_Applications",
22835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22836 "version": "0.0.0",
22837 "filename": "server/api/smsApplication/index.js",
22838 "groupTitle": "Sms_Applications"
22842 "url": "/api/sms/interactions/{id}/tags",
22843 "title": "Add tags to the interaction",
22846 "title": "Example usage:",
22847 "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",
22852 "group": "Sms_Interactions",
22853 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22854 "version": "0.0.0",
22855 "filename": "server/api/smsInteraction/index.js",
22856 "groupTitle": "Sms_Interactions"
22860 "url": "/api/sms/interactions",
22861 "title": "Creates a new Interaction",
22864 "title": "Example usage:",
22865 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22869 "name": "CreateInteractions",
22870 "group": "Sms_Interactions",
22885 "field": "closedAt",
22892 "field": "disposition",
22899 "field": "secondDisposition",
22906 "field": "thirdDisposition",
22927 "field": "read1stAt",
22938 "field": "firstMsgDirection",
22945 "field": "lastMsgAt",
22956 "field": "lastMsgDirection",
22962 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22963 "version": "0.0.0",
22964 "filename": "server/api/smsInteraction/index.js",
22965 "groupTitle": "Sms_Interactions"
22969 "url": "/api/sms/interactions/{id}",
22970 "title": "Deletes a Interaction",
22973 "title": "Example usage:",
22974 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
22978 "name": "DeleteInteractions",
22979 "group": "Sms_Interactions",
22980 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22981 "version": "0.0.0",
22982 "filename": "server/api/smsInteraction/index.js",
22983 "groupTitle": "Sms_Interactions"
22987 "url": "/api/sms/interactions/describe",
22988 "title": "Gets table info about Interactions",
22991 "title": "Example usage:",
22992 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
22996 "name": "DescribeInteractions",
22997 "group": "Sms_Interactions",
22998 "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>",
22999 "version": "0.0.0",
23000 "filename": "server/api/smsInteraction/index.js",
23001 "groupTitle": "Sms_Interactions"
23005 "url": "/api/sms/interactions",
23006 "title": "Gets a list of Interactions",
23009 "title": "Example usage:",
23010 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23014 "name": "GetInteractions",
23015 "group": "Sms_Interactions",
23016 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23017 "version": "0.0.0",
23018 "filename": "server/api/smsInteraction/index.js",
23019 "groupTitle": "Sms_Interactions"
23023 "url": "/api/sms/interactions/{id}/tags",
23024 "title": "Removes tags from interaction",
23027 "title": "Example usage:",
23028 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23032 "name": "RemoveTags",
23033 "group": "Sms_Interactions",
23034 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23035 "version": "0.0.0",
23036 "filename": "server/api/smsInteraction/index.js",
23037 "groupTitle": "Sms_Interactions"
23041 "url": "/api/sms/interactions/{id}",
23042 "title": "Gets a single Interaction",
23045 "title": "Example usage:",
23046 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23050 "name": "ShowInteractions",
23051 "group": "Sms_Interactions",
23052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23053 "version": "0.0.0",
23054 "filename": "server/api/smsInteraction/index.js",
23055 "groupTitle": "Sms_Interactions"
23059 "url": "/api/sms/interactions/{id}/messages",
23060 "title": "Creates new messages",
23063 "title": "Example usage:",
23064 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23068 "name": "addMessage",
23069 "group": "Sms_Interactions",
23095 "field": "direction",
23102 "field": "messageId",
23129 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23130 "version": "0.0.0",
23131 "filename": "server/api/smsInteraction/index.js",
23132 "groupTitle": "Sms_Interactions"
23136 "url": "/api/sms/interactions/{id}/download",
23137 "title": "Gets interaction",
23140 "title": "Example usage:",
23141 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23145 "name": "download",
23146 "group": "Sms_Interactions",
23147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23148 "version": "0.0.0",
23149 "filename": "server/api/smsInteraction/index.js",
23150 "groupTitle": "Sms_Interactions"
23154 "url": "/api/sms/interactions/{id}/messages",
23155 "title": "Gets interaction messages",
23158 "title": "Example usage:",
23159 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23163 "name": "getMessages",
23164 "group": "Sms_Interactions",
23165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23166 "version": "0.0.0",
23167 "filename": "server/api/smsInteraction/index.js",
23168 "groupTitle": "Sms_Interactions"
23172 "url": "/api/sms/interactions/{id}",
23173 "title": "Update an existing Interaction",
23176 "title": "Example usage:",
23177 "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",
23181 "name": "updateInteractions",
23182 "group": "Sms_Interactions",
23183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23184 "version": "0.0.0",
23185 "filename": "server/api/smsInteraction/index.js",
23186 "groupTitle": "Sms_Interactions"
23190 "url": "/api/sms/messages",
23191 "title": "Creates a new Message",
23194 "title": "Example usage:",
23195 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23199 "name": "CreateMessages",
23200 "group": "Sms_Messages",
23226 "field": "direction",
23233 "field": "messageId",
23260 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23261 "version": "0.0.0",
23262 "filename": "server/api/smsMessage/index.js",
23263 "groupTitle": "Sms_Messages"
23267 "url": "/api/sms/messages/{id}",
23268 "title": "Deletes a Message",
23271 "title": "Example usage:",
23272 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23276 "name": "DeleteMessages",
23277 "group": "Sms_Messages",
23278 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23279 "version": "0.0.0",
23280 "filename": "server/api/smsMessage/index.js",
23281 "groupTitle": "Sms_Messages"
23285 "url": "/api/sms/messages/describe",
23286 "title": "Gets table info about Messages",
23289 "title": "Example usage:",
23290 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23294 "name": "DescribeMessages",
23295 "group": "Sms_Messages",
23296 "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>",
23297 "version": "0.0.0",
23298 "filename": "server/api/smsMessage/index.js",
23299 "groupTitle": "Sms_Messages"
23303 "url": "/api/sms/messages",
23304 "title": "Gets a list of Messages",
23307 "title": "Example usage:",
23308 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23312 "name": "GetMessages",
23313 "group": "Sms_Messages",
23314 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23315 "version": "0.0.0",
23316 "filename": "server/api/smsMessage/index.js",
23317 "groupTitle": "Sms_Messages"
23321 "url": "/api/sms/messages/{id}",
23322 "title": "Gets a single Message",
23325 "title": "Example usage:",
23326 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23330 "name": "ShowMessages",
23331 "group": "Sms_Messages",
23332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23333 "version": "0.0.0",
23334 "filename": "server/api/smsMessage/index.js",
23335 "groupTitle": "Sms_Messages"
23339 "url": "/api/sms/messages/{id}",
23340 "title": "Update an existing Message",
23343 "title": "Example usage:",
23344 "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",
23348 "name": "updateMessages",
23349 "group": "Sms_Messages",
23350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23351 "version": "0.0.0",
23352 "filename": "server/api/smsMessage/index.js",
23353 "groupTitle": "Sms_Messages"
23357 "url": "/api/sms/reports/queue",
23358 "title": "Creates a new Sms Queue Report",
23361 "title": "Example usage:",
23362 "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",
23366 "name": "CreateSms_Queue_Reports",
23367 "group": "Sms_Queue_Reports",
23375 "field": "uniqueid",
23396 "field": "leaveAt",
23403 "field": "acceptAt",
23423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23424 "version": "0.0.0",
23425 "filename": "server/api/smsQueueReport/index.js",
23426 "groupTitle": "Sms_Queue_Reports"
23430 "url": "/api/sms/reports/queue/{id}",
23431 "title": "Deletes a Sms Queue Report",
23434 "title": "Example usage:",
23435 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23439 "name": "DeleteSms_Queue_Reports",
23440 "group": "Sms_Queue_Reports",
23441 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23442 "version": "0.0.0",
23443 "filename": "server/api/smsQueueReport/index.js",
23444 "groupTitle": "Sms_Queue_Reports"
23448 "url": "/api/sms/reports/queue/describe",
23449 "title": "Gets table info about Sms Queue Reports",
23452 "title": "Example usage:",
23453 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23457 "name": "DescribeSms_Queue_Reports",
23458 "group": "Sms_Queue_Reports",
23459 "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>",
23460 "version": "0.0.0",
23461 "filename": "server/api/smsQueueReport/index.js",
23462 "groupTitle": "Sms_Queue_Reports"
23466 "url": "/api/sms/reports/queue",
23467 "title": "Gets a list of Sms Queue Reports",
23470 "title": "Example usage:",
23471 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23475 "name": "GetSms_Queue_Reports",
23476 "group": "Sms_Queue_Reports",
23477 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23478 "version": "0.0.0",
23479 "filename": "server/api/smsQueueReport/index.js",
23480 "groupTitle": "Sms_Queue_Reports"
23484 "url": "/api/sms/reports/queue/{id}",
23485 "title": "Gets a single Sms Queue Report",
23488 "title": "Example usage:",
23489 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23493 "name": "ShowSms_Queue_Reports",
23494 "group": "Sms_Queue_Reports",
23495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23496 "version": "0.0.0",
23497 "filename": "server/api/smsQueueReport/index.js",
23498 "groupTitle": "Sms_Queue_Reports"
23502 "url": "/api/sms/reports/queue/{id}",
23503 "title": "Update an existing Sms Queue Report",
23506 "title": "Example usage:",
23507 "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",
23511 "name": "updateSms_Queue_Reports",
23512 "group": "Sms_Queue_Reports",
23513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23514 "version": "0.0.0",
23515 "filename": "server/api/smsQueueReport/index.js",
23516 "groupTitle": "Sms_Queue_Reports"
23520 "url": "/api/sms/queues/{id}/users",
23521 "title": "Add agents to a queue",
23524 "title": "Example usage:",
23525 "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",
23529 "name": "AddAgents",
23530 "group": "Sms_Queues",
23531 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23532 "version": "0.0.0",
23533 "filename": "server/api/smsQueue/index.js",
23534 "groupTitle": "Sms_Queues"
23538 "url": "/api/sms/queues/{id}/teams",
23539 "title": "Add teams to a queue",
23542 "title": "Example usage:",
23543 "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",
23547 "name": "AddTeams",
23548 "group": "Sms_Queues",
23549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23550 "version": "0.0.0",
23551 "filename": "server/api/smsQueue/index.js",
23552 "groupTitle": "Sms_Queues"
23556 "url": "/api/sms/queues",
23557 "title": "Creates a new Queue",
23560 "title": "Example usage:",
23561 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23565 "name": "CreateQueues",
23566 "group": "Sms_Queues",
23581 "field": "description",
23588 "field": "timeout",
23600 "field": "strategy",
23606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23607 "version": "0.0.0",
23608 "filename": "server/api/smsQueue/index.js",
23609 "groupTitle": "Sms_Queues"
23613 "url": "/api/sms/queues/{id}",
23614 "title": "Deletes a Queue",
23617 "title": "Example usage:",
23618 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23622 "name": "DeleteQueues",
23623 "group": "Sms_Queues",
23624 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23625 "version": "0.0.0",
23626 "filename": "server/api/smsQueue/index.js",
23627 "groupTitle": "Sms_Queues"
23631 "url": "/api/sms/queues/describe",
23632 "title": "Gets table info about Queues",
23635 "title": "Example usage:",
23636 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23640 "name": "DescribeQueues",
23641 "group": "Sms_Queues",
23642 "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>",
23643 "version": "0.0.0",
23644 "filename": "server/api/smsQueue/index.js",
23645 "groupTitle": "Sms_Queues"
23649 "url": "/api/sms/queues/{id}/users",
23650 "title": "Gets queue agents",
23653 "title": "Example usage:",
23654 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23658 "name": "GetAgents",
23659 "group": "Sms_Queues",
23660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23661 "version": "0.0.0",
23662 "filename": "server/api/smsQueue/index.js",
23663 "groupTitle": "Sms_Queues"
23667 "url": "/api/sms/queues/{id}/members",
23668 "title": "GetMembers",
23671 "title": "Example usage:",
23672 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23676 "name": "GetMembers",
23677 "group": "Sms_Queues",
23678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23679 "version": "0.0.0",
23680 "filename": "server/api/smsQueue/index.js",
23681 "groupTitle": "Sms_Queues"
23685 "url": "/api/sms/queues",
23686 "title": "Gets a list of Queues",
23689 "title": "Example usage:",
23690 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23694 "name": "GetQueues",
23695 "group": "Sms_Queues",
23696 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23697 "version": "0.0.0",
23698 "filename": "server/api/smsQueue/index.js",
23699 "groupTitle": "Sms_Queues"
23703 "url": "/api/sms/queues/{id}/teams",
23704 "title": "Gets queues list",
23707 "title": "Example usage:",
23708 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23712 "name": "GetTeams",
23713 "group": "Sms_Queues",
23714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23715 "version": "0.0.0",
23716 "filename": "server/api/smsQueue/index.js",
23717 "groupTitle": "Sms_Queues"
23721 "url": "/api/sms/queues/{id}/users",
23722 "title": "Removes agents from a queue",
23725 "title": "Example usage:",
23726 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23730 "name": "RemoveAgents",
23731 "group": "Sms_Queues",
23732 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23733 "version": "0.0.0",
23734 "filename": "server/api/smsQueue/index.js",
23735 "groupTitle": "Sms_Queues"
23739 "url": "/api/sms/queues/{id}",
23740 "title": "Gets a single Queue",
23743 "title": "Example usage:",
23744 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23748 "name": "ShowQueues",
23749 "group": "Sms_Queues",
23750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23751 "version": "0.0.0",
23752 "filename": "server/api/smsQueue/index.js",
23753 "groupTitle": "Sms_Queues"
23757 "url": "/api/sms/queues/{id}",
23758 "title": "Update an existing Queue",
23761 "title": "Example usage:",
23762 "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",
23766 "name": "updateQueues",
23767 "group": "Sms_Queues",
23768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23769 "version": "0.0.0",
23770 "filename": "server/api/smsQueue/index.js",
23771 "groupTitle": "Sms_Queues"
23775 "url": "/api/sms/reports/transfer",
23776 "title": "Creates a new Sms Transfer Report",
23779 "title": "Example usage:",
23780 "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",
23784 "name": "CreateSms_Transfer_Reports",
23785 "group": "Sms_Transfer_Reports",
23793 "field": "uniqueid",
23812 "field": "transferredAt",
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/smsTransferReport/index.js",
23821 "groupTitle": "Sms_Transfer_Reports"
23825 "url": "/api/sms/reports/transfer/{id}",
23826 "title": "Deletes a Sms Transfer Report",
23829 "title": "Example usage:",
23830 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23834 "name": "DeleteSms_Transfer_Reports",
23835 "group": "Sms_Transfer_Reports",
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/smsTransferReport/index.js",
23839 "groupTitle": "Sms_Transfer_Reports"
23843 "url": "/api/sms/reports/transfer/describe",
23844 "title": "Gets table info about Sms Transfer Reports",
23847 "title": "Example usage:",
23848 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23852 "name": "DescribeSms_Transfer_Reports",
23853 "group": "Sms_Transfer_Reports",
23854 "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>",
23855 "version": "0.0.0",
23856 "filename": "server/api/smsTransferReport/index.js",
23857 "groupTitle": "Sms_Transfer_Reports"
23861 "url": "/api/sms/reports/transfer",
23862 "title": "Gets a list of Sms Transfer Reports",
23865 "title": "Example usage:",
23866 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23870 "name": "GetSms_Transfer_Reports",
23871 "group": "Sms_Transfer_Reports",
23872 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23873 "version": "0.0.0",
23874 "filename": "server/api/smsTransferReport/index.js",
23875 "groupTitle": "Sms_Transfer_Reports"
23879 "url": "/api/sms/reports/transfer/{id}",
23880 "title": "Gets a single Sms Transfer Report",
23883 "title": "Example usage:",
23884 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23888 "name": "ShowSms_Transfer_Reports",
23889 "group": "Sms_Transfer_Reports",
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/smsTransferReport/index.js",
23893 "groupTitle": "Sms_Transfer_Reports"
23897 "url": "/api/sms/reports/transfer/{id}",
23898 "title": "Update an existing Sms Transfer Report",
23901 "title": "Example usage:",
23902 "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",
23906 "name": "updateSms_Transfer_Reports",
23907 "group": "Sms_Transfer_Reports",
23908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23909 "version": "0.0.0",
23910 "filename": "server/api/smsTransferReport/index.js",
23911 "groupTitle": "Sms_Transfer_Reports"
23915 "url": "/api/sounds",
23916 "title": "Gets a list of Sounds",
23919 "title": "Example usage:",
23920 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
23924 "name": "GetSounds",
23926 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23927 "version": "0.0.0",
23928 "filename": "server/api/sound/index.js",
23929 "groupTitle": "Sounds"
23933 "url": "/api/sounds/{id}",
23934 "title": "Gets a single Sound",
23937 "title": "Example usage:",
23938 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
23942 "name": "ShowSounds",
23944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23945 "version": "0.0.0",
23946 "filename": "server/api/sound/index.js",
23947 "groupTitle": "Sounds"
23951 "url": "/api/sounds",
23952 "title": "Create a new sound",
23955 "title": "Example usage:",
23956 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23960 "name": "addSound",
23962 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23963 "version": "0.0.0",
23964 "filename": "server/api/sound/index.js",
23965 "groupTitle": "Sounds"
23969 "url": "/api/sounds/{id}",
23970 "title": "Deletes a sound",
23973 "title": "Example usage:",
23974 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
23978 "name": "destroySound",
23980 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23981 "version": "0.0.0",
23982 "filename": "server/api/sound/index.js",
23983 "groupTitle": "Sounds"
23987 "url": "/api/sounds/{id}/download",
23988 "title": "Download Sound",
23991 "title": "Example usage:",
23992 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
23996 "name": "download",
23998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23999 "version": "0.0.0",
24000 "filename": "server/api/sound/index.js",
24001 "groupTitle": "Sounds"
24005 "url": "/api/sounds",
24006 "title": "Update an existing new sound",
24009 "title": "Example usage:",
24010 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24014 "name": "updateSound",
24016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24017 "version": "0.0.0",
24018 "filename": "server/api/sound/index.js",
24019 "groupTitle": "Sounds"
24023 "url": "/api/square/details/reports",
24024 "title": "Creates a new Square Detail Report",
24027 "title": "Example usage:",
24028 "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",
24032 "name": "CreateSquare_Detail_Reports",
24033 "group": "Square_Details_Reports",
24041 "field": "uniqueid",
24055 "field": "application",
24069 "field": "project_name",
24076 "field": "callerid",
24082 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24083 "version": "0.0.0",
24084 "filename": "server/api/squareReportDetail/index.js",
24085 "groupTitle": "Square_Details_Reports"
24089 "url": "/api/square/details/reports/{id}",
24090 "title": "Deletes a Square Detail Report",
24093 "title": "Example usage:",
24094 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24098 "name": "DeleteSquare_Detail_Reports",
24099 "group": "Square_Details_Reports",
24100 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24101 "version": "0.0.0",
24102 "filename": "server/api/squareReportDetail/index.js",
24103 "groupTitle": "Square_Details_Reports"
24107 "url": "/api/square/details/reports/describe",
24108 "title": "Gets table info about Square Detail Reports",
24111 "title": "Example usage:",
24112 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24116 "name": "DescribeSquare_Detail_Reports",
24117 "group": "Square_Details_Reports",
24118 "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>",
24119 "version": "0.0.0",
24120 "filename": "server/api/squareReportDetail/index.js",
24121 "groupTitle": "Square_Details_Reports"
24125 "url": "/api/square/details/reports",
24126 "title": "Gets a list of Square Detail Reports",
24129 "title": "Example usage:",
24130 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24134 "name": "GetSquare_Detail_Reports",
24135 "group": "Square_Details_Reports",
24136 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24137 "version": "0.0.0",
24138 "filename": "server/api/squareReportDetail/index.js",
24139 "groupTitle": "Square_Details_Reports"
24143 "url": "/api/square/details/reports/{id}",
24144 "title": "Gets a single Square Detail Report",
24147 "title": "Example usage:",
24148 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24152 "name": "ShowSquare_Detail_Reports",
24153 "group": "Square_Details_Reports",
24154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24155 "version": "0.0.0",
24156 "filename": "server/api/squareReportDetail/index.js",
24157 "groupTitle": "Square_Details_Reports"
24161 "url": "/api/square/details/reports/{id}",
24162 "title": "Update an existing Square Detail Report",
24165 "title": "Example usage:",
24166 "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",
24170 "name": "updateSquare_Detail_Reports",
24171 "group": "Square_Details_Reports",
24172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24173 "version": "0.0.0",
24174 "filename": "server/api/squareReportDetail/index.js",
24175 "groupTitle": "Square_Details_Reports"
24179 "url": "/api/square/messages",
24180 "title": "Creates a new Message",
24183 "title": "Example usage:",
24184 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24188 "name": "CreateMessages",
24189 "group": "Square_Messages",
24197 "field": "uniqueid",
24215 "field": "direction",
24221 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24222 "version": "0.0.0",
24223 "filename": "server/api/squareMessage/index.js",
24224 "groupTitle": "Square_Messages"
24228 "url": "/api/square/messages/{id}",
24229 "title": "Deletes a Message",
24232 "title": "Example usage:",
24233 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24237 "name": "DeleteMessages",
24238 "group": "Square_Messages",
24239 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24240 "version": "0.0.0",
24241 "filename": "server/api/squareMessage/index.js",
24242 "groupTitle": "Square_Messages"
24246 "url": "/api/square/messages",
24247 "title": "Gets a list of Messages",
24250 "title": "Example usage:",
24251 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24255 "name": "GetMessages",
24256 "group": "Square_Messages",
24257 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24258 "version": "0.0.0",
24259 "filename": "server/api/squareMessage/index.js",
24260 "groupTitle": "Square_Messages"
24264 "url": "/api/square/messages/{id}",
24265 "title": "Gets a single Message",
24268 "title": "Example usage:",
24269 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24273 "name": "ShowMessages",
24274 "group": "Square_Messages",
24275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24276 "version": "0.0.0",
24277 "filename": "server/api/squareMessage/index.js",
24278 "groupTitle": "Square_Messages"
24282 "url": "/api/square/messages/{id}",
24283 "title": "Update an existing Message",
24286 "title": "Example usage:",
24287 "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",
24291 "name": "updateMessages",
24292 "group": "Square_Messages",
24293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24294 "version": "0.0.0",
24295 "filename": "server/api/squareMessage/index.js",
24296 "groupTitle": "Square_Messages"
24300 "url": "/api/square/odbc",
24301 "title": "Creates a new ODBC",
24304 "title": "Example usage:",
24305 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24309 "name": "CreateODBCs",
24310 "group": "Square_ODBC",
24332 "field": "description",
24338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24339 "version": "0.0.0",
24340 "filename": "server/api/squareOdbc/index.js",
24341 "groupTitle": "Square_ODBC"
24345 "url": "/api/square/odbc/{id}",
24346 "title": "Deletes a ODBC",
24349 "title": "Example usage:",
24350 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24354 "name": "DeleteODBCs",
24355 "group": "Square_ODBC",
24356 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24357 "version": "0.0.0",
24358 "filename": "server/api/squareOdbc/index.js",
24359 "groupTitle": "Square_ODBC"
24363 "url": "/api/square/odbc",
24364 "title": "Gets a list of ODBCs",
24367 "title": "Example usage:",
24368 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24372 "name": "GetODBCs",
24373 "group": "Square_ODBC",
24374 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24375 "version": "0.0.0",
24376 "filename": "server/api/squareOdbc/index.js",
24377 "groupTitle": "Square_ODBC"
24381 "url": "/api/square/odbc/{id}",
24382 "title": "Gets a single ODBC",
24385 "title": "Example usage:",
24386 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24390 "name": "ShowODBCs",
24391 "group": "Square_ODBC",
24392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24393 "version": "0.0.0",
24394 "filename": "server/api/squareOdbc/index.js",
24395 "groupTitle": "Square_ODBC"
24399 "url": "/api/square/odbc/{id}/test",
24400 "title": "Test Odbc",
24403 "title": "Example usage:",
24404 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24409 "group": "Square_ODBC",
24410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24411 "version": "0.0.0",
24412 "filename": "server/api/squareOdbc/index.js",
24413 "groupTitle": "Square_ODBC"
24417 "url": "/api/square/odbc/{id}",
24418 "title": "Update an existing ODBC",
24421 "title": "Example usage:",
24422 "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",
24426 "name": "updateODBCs",
24427 "group": "Square_ODBC",
24428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24429 "version": "0.0.0",
24430 "filename": "server/api/squareOdbc/index.js",
24431 "groupTitle": "Square_ODBC"
24435 "url": "/api/square/projects",
24436 "title": "Creates a new Project",
24439 "title": "Example usage:",
24440 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24444 "name": "CreateProjects",
24445 "group": "Square_Projects",
24460 "field": "description",
24474 "field": "preproduction",
24481 "field": "production",
24487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24488 "version": "0.0.0",
24489 "filename": "server/api/squareProject/index.js",
24490 "groupTitle": "Square_Projects"
24494 "url": "/api/square/projects/{id}",
24495 "title": "Deletes a Project",
24498 "title": "Example usage:",
24499 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24503 "name": "DeleteProjects",
24504 "group": "Square_Projects",
24505 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24506 "version": "0.0.0",
24507 "filename": "server/api/squareProject/index.js",
24508 "groupTitle": "Square_Projects"
24512 "url": "/api/square/projects",
24513 "title": "Gets a list of Projects",
24516 "title": "Example usage:",
24517 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24521 "name": "GetProjects",
24522 "group": "Square_Projects",
24523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24524 "version": "0.0.0",
24525 "filename": "server/api/squareProject/index.js",
24526 "groupTitle": "Square_Projects"
24530 "url": "/api/square/projects/{id}",
24531 "title": "Gets a single Project",
24534 "title": "Example usage:",
24535 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24539 "name": "ShowProjects",
24540 "group": "Square_Projects",
24541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24542 "version": "0.0.0",
24543 "filename": "server/api/squareProject/index.js",
24544 "groupTitle": "Square_Projects"
24548 "url": "/api/square/projects/{id}/users",
24549 "title": "Adds user permissions to a Project",
24552 "title": "Example usage:",
24553 "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",
24557 "name": "addUsers",
24558 "group": "Square_Projects",
24559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24560 "version": "0.0.0",
24561 "filename": "server/api/squareProject/index.js",
24562 "groupTitle": "Square_Projects"
24566 "url": "/api/square/projects/{id}/users",
24567 "title": "Gets users permissions from Project",
24570 "title": "Example usage:",
24571 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24575 "name": "getUsers",
24576 "group": "Square_Projects",
24577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24578 "version": "0.0.0",
24579 "filename": "server/api/squareProject/index.js",
24580 "groupTitle": "Square_Projects"
24584 "url": "/api/square/projects/{id}/users",
24585 "title": "Removes user permissions from a Project",
24588 "title": "Example usage:",
24589 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24593 "name": "removeUsers",
24594 "group": "Square_Projects",
24595 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24596 "version": "0.0.0",
24597 "filename": "server/api/squareProject/index.js",
24598 "groupTitle": "Square_Projects"
24602 "url": "/api/square/projects/{id}",
24603 "title": "Update an existing Project",
24606 "title": "Example usage:",
24607 "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",
24611 "name": "updateProjects",
24612 "group": "Square_Projects",
24613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24614 "version": "0.0.0",
24615 "filename": "server/api/squareProject/index.js",
24616 "groupTitle": "Square_Projects"
24620 "url": "/api/square/recordings",
24621 "title": "Creates a new Recording",
24624 "title": "Example usage:",
24625 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24629 "name": "CreateRecordings",
24630 "group": "Square_Recordings",
24638 "field": "uniqueid",
24645 "field": "callerid",
24652 "field": "calleridname",
24659 "field": "context",
24666 "field": "extension",
24673 "field": "priority",
24680 "field": "accountcode",
24694 "field": "projectName",
24701 "field": "saveName",
24708 "field": "filename",
24715 "field": "savePath",
24728 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24729 "version": "0.0.0",
24730 "filename": "server/api/squareRecording/index.js",
24731 "groupTitle": "Square_Recordings"
24735 "url": "/api/square/recordings",
24736 "title": "Gets a list of Recordings",
24739 "title": "Example usage:",
24740 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24744 "name": "GetRecordings",
24745 "group": "Square_Recordings",
24746 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24747 "version": "0.0.0",
24748 "filename": "server/api/squareRecording/index.js",
24749 "groupTitle": "Square_Recordings"
24753 "url": "/api/square/recordings/{id}",
24754 "title": "Gets a single Recording",
24757 "title": "Example usage:",
24758 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24762 "name": "ShowRecordings",
24763 "group": "Square_Recordings",
24764 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24765 "version": "0.0.0",
24766 "filename": "server/api/squareRecording/index.js",
24767 "groupTitle": "Square_Recordings"
24771 "url": "/api/square/recordings/{id}/delete",
24772 "title": "Delete recording",
24775 "title": "Example usage:",
24776 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24781 "group": "Square_Recordings",
24782 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24783 "version": "0.0.0",
24784 "filename": "server/api/squareRecording/index.js",
24785 "groupTitle": "Square_Recordings"
24789 "url": "/api/square/recordings/{id}/download",
24790 "title": "Download Recording",
24793 "title": "Example usage:",
24794 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24798 "name": "download",
24799 "group": "Square_Recordings",
24800 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24801 "version": "0.0.0",
24802 "filename": "server/api/squareRecording/index.js",
24803 "groupTitle": "Square_Recordings"
24807 "url": "/api/square/recordings/{id}",
24808 "title": "Update an existing Recording",
24811 "title": "Example usage:",
24812 "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",
24816 "name": "updateRecordings",
24817 "group": "Square_Recordings",
24818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24819 "version": "0.0.0",
24820 "filename": "server/api/squareRecording/index.js",
24821 "groupTitle": "Square_Recordings"
24825 "url": "/api/square/reports",
24826 "title": "Creates a new Square Report",
24829 "title": "Example usage:",
24830 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24834 "name": "CreateSquare_Reports",
24835 "group": "Square_Reports",
24843 "field": "network",
24850 "field": "network_script",
24857 "field": "request",
24864 "field": "channel",
24871 "field": "language",
24885 "field": "uniqueid",
24892 "field": "version",
24899 "field": "callerid",
24906 "field": "calleridname",
24913 "field": "callingpres",
24920 "field": "callingani2",
24927 "field": "callington",
24934 "field": "callingtns",
24955 "field": "context",
24962 "field": "extension",
24969 "field": "priority",
24976 "field": "enhanced",
24983 "field": "accountcode",
24990 "field": "threadid",
24997 "field": "project_name",
25011 "field": "leaveAt",
25024 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25025 "version": "0.0.0",
25026 "filename": "server/api/squareReport/index.js",
25027 "groupTitle": "Square_Reports"
25031 "url": "/api/square/reports/{id}",
25032 "title": "Deletes a Square Report",
25035 "title": "Example usage:",
25036 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25040 "name": "DeleteSquare_Reports",
25041 "group": "Square_Reports",
25042 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25043 "version": "0.0.0",
25044 "filename": "server/api/squareReport/index.js",
25045 "groupTitle": "Square_Reports"
25049 "url": "/api/square/reports/describe",
25050 "title": "Gets table info about Square Reports",
25053 "title": "Example usage:",
25054 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25058 "name": "DescribeSquare_Reports",
25059 "group": "Square_Reports",
25060 "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>",
25061 "version": "0.0.0",
25062 "filename": "server/api/squareReport/index.js",
25063 "groupTitle": "Square_Reports"
25067 "url": "/api/square/reports",
25068 "title": "Gets a list of Square Reports",
25071 "title": "Example usage:",
25072 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25076 "name": "GetSquare_Reports",
25077 "group": "Square_Reports",
25078 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25079 "version": "0.0.0",
25080 "filename": "server/api/squareReport/index.js",
25081 "groupTitle": "Square_Reports"
25085 "url": "/api/square/reports/{id}",
25086 "title": "Gets a single Square Report",
25089 "title": "Example usage:",
25090 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25094 "name": "ShowSquare_Reports",
25095 "group": "Square_Reports",
25096 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25097 "version": "0.0.0",
25098 "filename": "server/api/squareReport/index.js",
25099 "groupTitle": "Square_Reports"
25103 "url": "/api/square/reports/{id}",
25104 "title": "Update an existing Square Report",
25107 "title": "Example usage:",
25108 "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",
25112 "name": "updateSquare_Reports",
25113 "group": "Square_Reports",
25114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25115 "version": "0.0.0",
25116 "filename": "server/api/squareReport/index.js",
25117 "groupTitle": "Square_Reports"
25121 "url": "/api/integrations/sugarcrm/configurations",
25122 "title": "Creates a new SugarCRM Configuration",
25125 "title": "Example usage:",
25126 "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",
25130 "name": "CreateSugarCRM_Configurations",
25131 "group": "SugarCRM_Configurations",
25146 "field": "description",
25152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25153 "version": "0.0.0",
25154 "filename": "server/api/intSugarcrmConfiguration/index.js",
25155 "groupTitle": "SugarCRM_Configurations"
25159 "url": "/api/integrations/sugarcrm/configurations/{id}",
25160 "title": "Deletes a SugarCRM Configuration",
25163 "title": "Example usage:",
25164 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25168 "name": "DeleteSugarCRM_Configurations",
25169 "group": "SugarCRM_Configurations",
25170 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25171 "version": "0.0.0",
25172 "filename": "server/api/intSugarcrmConfiguration/index.js",
25173 "groupTitle": "SugarCRM_Configurations"
25177 "url": "/api/integrations/sugarcrm/configurations",
25178 "title": "Gets a list of SugarCRM Configurations",
25181 "title": "Example usage:",
25182 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25186 "name": "GetSugarCRM_Configurations",
25187 "group": "SugarCRM_Configurations",
25188 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25189 "version": "0.0.0",
25190 "filename": "server/api/intSugarcrmConfiguration/index.js",
25191 "groupTitle": "SugarCRM_Configurations"
25195 "url": "/api/integrations/sugarcrm/configurations/{id}",
25196 "title": "Gets a single SugarCRM Configuration",
25199 "title": "Example usage:",
25200 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25204 "name": "ShowSugarCRM_Configurations",
25205 "group": "SugarCRM_Configurations",
25206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25207 "version": "0.0.0",
25208 "filename": "server/api/intSugarcrmConfiguration/index.js",
25209 "groupTitle": "SugarCRM_Configurations"
25213 "url": "/api/integrations/sugarcrm/configurations/{id}",
25214 "title": "Update an existing SugarCRM Configuration",
25217 "title": "Example usage:",
25218 "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",
25222 "name": "updateSugarCRM_Configurations",
25223 "group": "SugarCRM_Configurations",
25224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25225 "version": "0.0.0",
25226 "filename": "server/api/intSugarcrmConfiguration/index.js",
25227 "groupTitle": "SugarCRM_Configurations"
25231 "url": "/api/integrations/sugarcrm/accounts",
25232 "title": "Creates a new Sugarcrm Account",
25235 "title": "Example usage:",
25236 "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",
25240 "name": "CreateSugarcrm_Accounts",
25241 "group": "Sugarcrm_Accounts",
25256 "field": "description",
25263 "field": "username",
25270 "field": "password",
25277 "field": "remoteUri",
25284 "field": "serverUrl",
25290 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25291 "version": "0.0.0",
25292 "filename": "server/api/intSugarcrmAccount/index.js",
25293 "groupTitle": "Sugarcrm_Accounts"
25297 "url": "/api/integrations/sugarcrm/accounts/{id}",
25298 "title": "Deletes a Sugarcrm Account",
25301 "title": "Example usage:",
25302 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25306 "name": "DeleteSugarcrm_Accounts",
25307 "group": "Sugarcrm_Accounts",
25308 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25309 "version": "0.0.0",
25310 "filename": "server/api/intSugarcrmAccount/index.js",
25311 "groupTitle": "Sugarcrm_Accounts"
25315 "url": "/api/integrations/sugarcrm/accounts",
25316 "title": "Gets a list of Sugarcrm Accounts",
25319 "title": "Example usage:",
25320 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25324 "name": "GetSugarcrm_Accounts",
25325 "group": "Sugarcrm_Accounts",
25326 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25327 "version": "0.0.0",
25328 "filename": "server/api/intSugarcrmAccount/index.js",
25329 "groupTitle": "Sugarcrm_Accounts"
25333 "url": "/api/integrations/sugarcrm/accounts/{id}",
25334 "title": "Gets a single Sugarcrm Account",
25337 "title": "Example usage:",
25338 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25342 "name": "ShowSugarcrm_Accounts",
25343 "group": "Sugarcrm_Accounts",
25344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25345 "version": "0.0.0",
25346 "filename": "server/api/intSugarcrmAccount/index.js",
25347 "groupTitle": "Sugarcrm_Accounts"
25351 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25352 "title": "Creates new configuration",
25355 "title": "Example usage:",
25356 "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",
25360 "name": "addConfiguration",
25361 "group": "Sugarcrm_Accounts",
25362 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25363 "version": "0.0.0",
25364 "filename": "server/api/intSugarcrmAccount/index.js",
25365 "groupTitle": "Sugarcrm_Accounts"
25369 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25370 "title": "Gets account configurations",
25373 "title": "Example usage:",
25374 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25378 "name": "getConfigurations",
25379 "group": "Sugarcrm_Accounts",
25380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25381 "version": "0.0.0",
25382 "filename": "server/api/intSugarcrmAccount/index.js",
25383 "groupTitle": "Sugarcrm_Accounts"
25387 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25388 "title": "Gets account fields",
25391 "title": "Example usage:",
25392 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25396 "name": "getFields",
25397 "group": "Sugarcrm_Accounts",
25398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25399 "version": "0.0.0",
25400 "filename": "server/api/intSugarcrmAccount/index.js",
25401 "groupTitle": "Sugarcrm_Accounts"
25405 "url": "/api/integrations/sugarcrm/accounts/{id}",
25406 "title": "Update an existing Sugarcrm Account",
25409 "title": "Example usage:",
25410 "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",
25414 "name": "updateSugarcrm_Accounts",
25415 "group": "Sugarcrm_Accounts",
25416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25417 "version": "0.0.0",
25418 "filename": "server/api/intSugarcrmAccount/index.js",
25419 "groupTitle": "Sugarcrm_Accounts"
25423 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25424 "title": "Gets configurations descriptions",
25427 "title": "Example usage:",
25428 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25432 "name": "getDescriptions",
25433 "group": "Sugarcrm_Configurations",
25434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25435 "version": "0.0.0",
25436 "filename": "server/api/intSugarcrmConfiguration/index.js",
25437 "groupTitle": "Sugarcrm_Configurations"
25441 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25442 "title": "Gets configurations fields",
25445 "title": "Example usage:",
25446 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25450 "name": "getFields",
25451 "group": "Sugarcrm_Configurations",
25452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25453 "version": "0.0.0",
25454 "filename": "server/api/intSugarcrmConfiguration/index.js",
25455 "groupTitle": "Sugarcrm_Configurations"
25459 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25460 "title": "Gets configurations subjects",
25463 "title": "Example usage:",
25464 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25468 "name": "getSubjects",
25469 "group": "Sugarcrm_Configurations",
25470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25471 "version": "0.0.0",
25472 "filename": "server/api/intSugarcrmConfiguration/index.js",
25473 "groupTitle": "Sugarcrm_Configurations"
25477 "url": "/api/integrations/sugarcrm/fields",
25478 "title": "Creates a new Sugarcrm Field",
25481 "title": "Example usage:",
25482 "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",
25486 "name": "CreateSugarcrm_Fields",
25487 "group": "Sugarcrm_Fields",
25497 "\"customVariable\"",
25508 "field": "content",
25524 "\"customVariable\""
25527 "field": "keyType",
25534 "field": "keyContent",
25541 "field": "idField",
25548 "field": "nameField",
25555 "field": "customField",
25562 "field": "variableName",
25568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25569 "version": "0.0.0",
25570 "filename": "server/api/intSugarcrmField/index.js",
25571 "groupTitle": "Sugarcrm_Fields"
25575 "url": "/api/integrations/sugarcrm/fields/{id}",
25576 "title": "Deletes a Sugarcrm Field",
25579 "title": "Example usage:",
25580 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25584 "name": "DeleteSugarcrm_Fields",
25585 "group": "Sugarcrm_Fields",
25586 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25587 "version": "0.0.0",
25588 "filename": "server/api/intSugarcrmField/index.js",
25589 "groupTitle": "Sugarcrm_Fields"
25593 "url": "/api/integrations/sugarcrm/fields",
25594 "title": "Gets a list of Sugarcrm Fields",
25597 "title": "Example usage:",
25598 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25602 "name": "GetSugarcrm_Fields",
25603 "group": "Sugarcrm_Fields",
25604 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25605 "version": "0.0.0",
25606 "filename": "server/api/intSugarcrmField/index.js",
25607 "groupTitle": "Sugarcrm_Fields"
25611 "url": "/api/integrations/sugarcrm/fields/{id}",
25612 "title": "Gets a single Sugarcrm Field",
25615 "title": "Example usage:",
25616 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25620 "name": "ShowSugarcrm_Fields",
25621 "group": "Sugarcrm_Fields",
25622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25623 "version": "0.0.0",
25624 "filename": "server/api/intSugarcrmField/index.js",
25625 "groupTitle": "Sugarcrm_Fields"
25629 "url": "/api/integrations/sugarcrm/fields/{id}",
25630 "title": "Update an existing Sugarcrm Field",
25633 "title": "Example usage:",
25634 "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",
25638 "name": "updateSugarcrm_Fields",
25639 "group": "Sugarcrm_Fields",
25640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25641 "version": "0.0.0",
25642 "filename": "server/api/intSugarcrmField/index.js",
25643 "groupTitle": "Sugarcrm_Fields"
25647 "url": "/api/system/process",
25648 "title": "Gets system information",
25651 "title": "Example usage:",
25652 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25656 "name": "GetSystemInformation",
25657 "group": "System_Information",
25658 "description": "<p>Motion returns the system information.</p>",
25659 "version": "0.0.0",
25660 "filename": "server/api/system/index.js",
25661 "groupTitle": "System_Information"
25665 "url": "/api/system",
25666 "title": "Gets system information",
25669 "title": "Example usage:",
25670 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25674 "name": "GetSystemInformation",
25675 "group": "System_Information",
25676 "description": "<p>Motion returns the system information.</p>",
25677 "version": "0.0.0",
25678 "filename": "server/api/system/index.js",
25679 "groupTitle": "System_Information"
25683 "url": "/api/tags",
25684 "title": "Creates a new Tag",
25687 "title": "Example usage:",
25688 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25692 "name": "CreateTags",
25715 "field": "description",
25721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25722 "version": "0.0.0",
25723 "filename": "server/api/tag/index.js",
25724 "groupTitle": "Tags"
25728 "url": "/api/tags/{id}",
25729 "title": "Deletes a Tag",
25732 "title": "Example usage:",
25733 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25737 "name": "DeleteTags",
25739 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25740 "version": "0.0.0",
25741 "filename": "server/api/tag/index.js",
25742 "groupTitle": "Tags"
25746 "url": "/api/tags",
25747 "title": "Gets a list of Tags",
25750 "title": "Example usage:",
25751 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25757 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25758 "version": "0.0.0",
25759 "filename": "server/api/tag/index.js",
25760 "groupTitle": "Tags"
25764 "url": "/api/tags/{id}",
25765 "title": "Gets a single Tag",
25768 "title": "Example usage:",
25769 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25773 "name": "ShowTags",
25775 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25776 "version": "0.0.0",
25777 "filename": "server/api/tag/index.js",
25778 "groupTitle": "Tags"
25782 "url": "/api/tags/{id}",
25783 "title": "Update an existing Tag",
25786 "title": "Example usage:",
25787 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25791 "name": "updateTags",
25793 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25794 "version": "0.0.0",
25795 "filename": "server/api/tag/index.js",
25796 "groupTitle": "Tags"
25800 "url": "/api/teams/{id}/queues",
25801 "title": "Add queues to a team",
25804 "title": "Example usage:",
25805 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25809 "name": "AddQueues",
25811 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25812 "version": "0.0.0",
25813 "filename": "server/api/team/index.js",
25814 "groupTitle": "Teams"
25818 "url": "/api/teams",
25819 "title": "Creates a new Team",
25822 "title": "Example usage:",
25823 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25827 "name": "CreateTeams",
25843 "field": "description",
25849 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25850 "version": "0.0.0",
25851 "filename": "server/api/team/index.js",
25852 "groupTitle": "Teams"
25856 "url": "/api/teams/{id}",
25857 "title": "Deletes a Team",
25860 "title": "Example usage:",
25861 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25865 "name": "DeleteTeams",
25867 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25868 "version": "0.0.0",
25869 "filename": "server/api/team/index.js",
25870 "groupTitle": "Teams"
25874 "url": "/api/teams/{id}/users",
25875 "title": "Gets agents from team",
25878 "title": "Example usage:",
25879 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25883 "name": "GetAgents",
25885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25886 "version": "0.0.0",
25887 "filename": "server/api/team/index.js",
25888 "groupTitle": "Teams"
25892 "url": "/api/teams/{id}/queues?channel={channel}",
25893 "title": "Gets Queues list",
25896 "title": "Example usage:",
25897 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
25901 "name": "GetQueues",
25903 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25904 "version": "0.0.0",
25905 "filename": "server/api/team/index.js",
25906 "groupTitle": "Teams"
25910 "url": "/api/teams",
25911 "title": "Gets a list of Teams",
25914 "title": "Example usage:",
25915 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
25919 "name": "GetTeams",
25921 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25922 "version": "0.0.0",
25923 "filename": "server/api/team/index.js",
25924 "groupTitle": "Teams"
25928 "url": "/api/teams/{id}/users",
25929 "title": "Removes agents from a team",
25932 "title": "Example usage:",
25933 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25937 "name": "RemoveAgents",
25939 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25940 "version": "0.0.0",
25941 "filename": "server/api/team/index.js",
25942 "groupTitle": "Teams"
25946 "url": "/api/teams/{id}/queues",
25947 "title": "Remove queues to a team",
25950 "title": "Example usage:",
25951 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25955 "name": "RemoveQueues",
25957 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/team/index.js",
25960 "groupTitle": "Teams"
25964 "url": "/api/mail/queues/{id}/teams",
25965 "title": "Remove teams from a queue",
25968 "title": "Example usage:",
25969 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25973 "name": "RemoveTeams",
25975 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25976 "version": "0.0.0",
25977 "filename": "server/api/mailQueue/index.js",
25978 "groupTitle": "Teams"
25982 "url": "/api/openchannel/queues/{id}/teams",
25983 "title": "Remove teams from a queue",
25986 "title": "Example usage:",
25987 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25991 "name": "RemoveTeams",
25993 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25994 "version": "0.0.0",
25995 "filename": "server/api/openchannelQueue/index.js",
25996 "groupTitle": "Teams"
26000 "url": "/api/voice/queues/{id}/teams",
26001 "title": "Remove teams from a queue",
26004 "title": "Example usage:",
26005 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26009 "name": "RemoveTeams",
26011 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26012 "version": "0.0.0",
26013 "filename": "server/api/voiceQueue/index.js",
26014 "groupTitle": "Teams"
26018 "url": "/api/sms/queues/{id}/teams",
26019 "title": "Remove teams from a queue",
26022 "title": "Example usage:",
26023 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26027 "name": "RemoveTeams",
26029 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26030 "version": "0.0.0",
26031 "filename": "server/api/smsQueue/index.js",
26032 "groupTitle": "Teams"
26036 "url": "/api/whatsapp/queues/{id}/teams",
26037 "title": "Remove teams from a queue",
26040 "title": "Example usage:",
26041 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26045 "name": "RemoveTeams",
26047 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26048 "version": "0.0.0",
26049 "filename": "server/api/whatsappQueue/index.js",
26050 "groupTitle": "Teams"
26054 "url": "/api/chat/queues/{id}/teams",
26055 "title": "Remove teams from a queue",
26058 "title": "Example usage:",
26059 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26063 "name": "RemoveTeams",
26065 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066 "version": "0.0.0",
26067 "filename": "server/api/chatQueue/index.js",
26068 "groupTitle": "Teams"
26072 "url": "/api/fax/queues/{id}/teams",
26073 "title": "Remove teams from a queue",
26076 "title": "Example usage:",
26077 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26081 "name": "RemoveTeams",
26083 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26084 "version": "0.0.0",
26085 "filename": "server/api/faxQueue/index.js",
26086 "groupTitle": "Teams"
26090 "url": "/api/teams/{id}",
26091 "title": "Gets a single Team",
26094 "title": "Example usage:",
26095 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26099 "name": "ShowTeams",
26101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26102 "version": "0.0.0",
26103 "filename": "server/api/team/index.js",
26104 "groupTitle": "Teams"
26108 "url": "/api/teams/{id}/users",
26109 "title": "Adds agents to a team",
26112 "title": "Example usage:",
26113 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26117 "name": "addAgents",
26119 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26120 "version": "0.0.0",
26121 "filename": "server/api/team/index.js",
26122 "groupTitle": "Teams"
26126 "url": "/api/teams/{id}",
26127 "title": "Update an existing Team",
26130 "title": "Example usage:",
26131 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26135 "name": "updateTeams",
26137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26138 "version": "0.0.0",
26139 "filename": "server/api/team/index.js",
26140 "groupTitle": "Teams"
26144 "url": "/api/templates",
26145 "title": "Creates a new Template",
26148 "title": "Example usage:",
26149 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26153 "name": "CreateTemplates",
26154 "group": "Templates",
26169 "field": "description",
26182 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183 "version": "0.0.0",
26184 "filename": "server/api/template/index.js",
26185 "groupTitle": "Templates"
26189 "url": "/api/templates/{id}",
26190 "title": "Deletes a Template",
26193 "title": "Example usage:",
26194 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26198 "name": "DeleteTemplates",
26199 "group": "Templates",
26200 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26201 "version": "0.0.0",
26202 "filename": "server/api/template/index.js",
26203 "groupTitle": "Templates"
26207 "url": "/api/templates",
26208 "title": "Gets a list of Templates",
26211 "title": "Example usage:",
26212 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26216 "name": "GetTemplates",
26217 "group": "Templates",
26218 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26219 "version": "0.0.0",
26220 "filename": "server/api/template/index.js",
26221 "groupTitle": "Templates"
26225 "url": "/api/templates/{id}",
26226 "title": "Gets a single Template",
26229 "title": "Example usage:",
26230 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26234 "name": "ShowTemplates",
26235 "group": "Templates",
26236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26237 "version": "0.0.0",
26238 "filename": "server/api/template/index.js",
26239 "groupTitle": "Templates"
26243 "url": "/api/templates/{id}",
26244 "title": "Update an existing Template",
26247 "title": "Example usage:",
26248 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26252 "name": "updateTemplates",
26253 "group": "Templates",
26254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26255 "version": "0.0.0",
26256 "filename": "server/api/template/index.js",
26257 "groupTitle": "Templates"
26261 "url": "/api/triggers",
26262 "title": "Creates a new Trigger",
26265 "title": "Example usage:",
26266 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26270 "name": "CreateTriggers",
26271 "group": "Triggers",
26286 "field": "channel",
26293 "field": "description",
26306 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26307 "version": "0.0.0",
26308 "filename": "server/api/trigger/index.js",
26309 "groupTitle": "Triggers"
26313 "url": "/api/triggers/{id}",
26314 "title": "Deletes a Trigger",
26317 "title": "Example usage:",
26318 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26322 "name": "DeleteTriggers",
26323 "group": "Triggers",
26324 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26325 "version": "0.0.0",
26326 "filename": "server/api/trigger/index.js",
26327 "groupTitle": "Triggers"
26331 "url": "/api/triggers",
26332 "title": "Gets a list of Triggers",
26335 "title": "Example usage:",
26336 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26340 "name": "GetTriggers",
26341 "group": "Triggers",
26342 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26343 "version": "0.0.0",
26344 "filename": "server/api/trigger/index.js",
26345 "groupTitle": "Triggers"
26349 "url": "/api/triggers/{id}",
26350 "title": "Gets a single Trigger",
26353 "title": "Example usage:",
26354 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26358 "name": "ShowTriggers",
26359 "group": "Triggers",
26360 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26361 "version": "0.0.0",
26362 "filename": "server/api/trigger/index.js",
26363 "groupTitle": "Triggers"
26367 "url": "/api/triggers/{id}/actions",
26368 "title": "Creates new actions",
26371 "title": "Example usage:",
26372 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26376 "name": "addAction",
26377 "group": "Triggers",
26393 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26400 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26407 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26414 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26448 "version": "0.0.0",
26449 "filename": "server/api/trigger/index.js",
26450 "groupTitle": "Triggers"
26454 "url": "/api/triggers/{id}/all_conditions",
26455 "title": "Creates a new \"AND\"condition",
26458 "title": "Example usage:",
26459 "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",
26463 "name": "addAllCondition",
26464 "group": "Triggers",
26486 "field": "operator",
26499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26500 "version": "0.0.0",
26501 "filename": "server/api/trigger/index.js",
26502 "groupTitle": "Triggers"
26506 "url": "/api/triggers/{id}/any_conditions",
26507 "title": "Creates a new \"OR\"condition",
26510 "title": "Example usage:",
26511 "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",
26515 "name": "addAnyCondition",
26516 "group": "Triggers",
26538 "field": "operator",
26551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26552 "version": "0.0.0",
26553 "filename": "server/api/trigger/index.js",
26554 "groupTitle": "Triggers"
26558 "url": "/api/triggers/{id}/actions",
26559 "title": "Gets Trigger Actions",
26562 "title": "Example usage:",
26563 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26567 "name": "getActions",
26568 "group": "Triggers",
26569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26570 "version": "0.0.0",
26571 "filename": "server/api/trigger/index.js",
26572 "groupTitle": "Triggers"
26576 "url": "/api/triggers/{id}/all_conditions",
26577 "title": "Gets \"AND\" Trigger Conditions",
26580 "title": "Example usage:",
26581 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26585 "name": "getAllConditions",
26586 "group": "Triggers",
26587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26588 "version": "0.0.0",
26589 "filename": "server/api/trigger/index.js",
26590 "groupTitle": "Triggers"
26594 "url": "/api/triggers/{id}/any_conditions",
26595 "title": "Gets \"OR\" Trigger Conditions",
26598 "title": "Example usage:",
26599 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26603 "name": "getAnyConditions",
26604 "group": "Triggers",
26605 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26606 "version": "0.0.0",
26607 "filename": "server/api/trigger/index.js",
26608 "groupTitle": "Triggers"
26612 "url": "/api/triggers/{id}",
26613 "title": "Update an existing Trigger",
26616 "title": "Example usage:",
26617 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26621 "name": "updateTriggers",
26622 "group": "Triggers",
26623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26624 "version": "0.0.0",
26625 "filename": "server/api/trigger/index.js",
26626 "groupTitle": "Triggers"
26630 "url": "/api/trunks/clone",
26631 "title": "Clone an existing Trunk",
26634 "title": "Example usage:",
26635 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26639 "name": "CloneTrunks",
26641 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26642 "version": "0.0.0",
26643 "filename": "server/api/trunk/index.js",
26644 "groupTitle": "Trunks"
26648 "url": "/api/trunks",
26649 "title": "Create a new trunk",
26652 "title": "Example usage:",
26653 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26685 "field": "context",
26692 "\"ALLOWED_NOT_SCREENED\"",
26693 "\"ALLOWED_PASSED_SCREEN\"",
26694 "\"ALLOWED_FAILED_SCREEN\"",
26696 "\"PROHIB_NOT_SCREENED\"",
26697 "\"PROHIB_PASSED_SCREEN\"",
26698 "\"PROHIB_FAILED_SCREEN\"",
26702 "field": "callingpres",
26730 "field": "md5secret",
26737 "field": "remotesecret",
26744 "field": "transport",
26745 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26758 "field": "dtmfmode",
26772 "field": "directmedia",
26783 "field": "directrtpsetup",
26790 "field": "directmediapermit",
26797 "field": "directmediadeny",
26805 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
26811 "field": "callgroup",
26818 "field": "namedcallgroup",
26825 "field": "pickupgroup",
26832 "field": "namedpickupgroup",
26839 "field": "language",
26846 "field": "tonezone",
26853 "field": "disallow",
26861 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
26871 "field": "autoframing",
26878 "field": "insecure",
26879 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
26889 "field": "trustrpid",
26900 "field": "trust_id_outbound",
26912 "field": "progressinband",
26923 "field": "promiscredir",
26934 "field": "useclientcode",
26941 "field": "accountcode",
26955 "field": "callerid",
26962 "field": "amaflags",
26973 "field": "callcounter",
26980 "field": "busylevel",
26991 "field": "allowoverlap",
27002 "field": "allowsubscribe",
27013 "field": "allowtransfer",
27024 "field": "ignoresdpversion",
27031 "field": "subscribecontext",
27038 "field": "template",
27050 "field": "videosupport",
27057 "field": "maxcallbitrate",
27068 "field": "rfc2833compensate",
27075 "field": "mailbox",
27087 "field": "session_timers",
27094 "field": "session_expires",
27101 "field": "session_minse",
27112 "field": "session_refresher",
27119 "field": "t38pt_usertpsource",
27126 "field": "regexten",
27133 "field": "fromdomain",
27140 "field": "fromuser",
27158 "field": "qualify",
27165 "field": "keepalive",
27172 "field": "defaultip",
27179 "field": "defaultuser",
27186 "field": "rtptimeout",
27193 "field": "rtpholdtimeout",
27200 "field": "rtpkeepalive",
27212 "field": "sendrpid",
27219 "field": "outboundproxy",
27226 "field": "callbackextension",
27233 "field": "timert1",
27247 "field": "qualifyfreq",
27254 "field": "contactpermit",
27261 "field": "contactdeny",
27268 "field": "contactacl",
27275 "field": "unsolicited_mailbox",
27282 "field": "use_q850_reason",
27289 "field": "maxforwards",
27300 "field": "encryption",
27322 "field": "force_avp",
27333 "field": "icesupport",
27344 "field": "dtlsenable",
27357 "field": "dtlsverify",
27364 "field": "dtlsrekey",
27371 "field": "dtlscertfile",
27378 "field": "dtlsprivatekey",
27385 "field": "dtlscipher",
27392 "field": "dtlscafile",
27399 "field": "dtlscapath",
27411 "field": "dtlssetup",
27418 "field": "dtlsfingerprint",
27429 "field": "usereqphone",
27436 "field": "recordonfeature",
27443 "field": "recordofffeature",
27450 "field": "call_limit",
27461 "field": "registertrying",
27472 "field": "subscribemwi",
27479 "field": "vmexten",
27486 "field": "mohinterpret",
27493 "field": "mohsuggest",
27500 "field": "parkinglot",
27507 "field": "description",
27528 "field": "canreinvite",
27535 "field": "registry",
27542 "field": "otherFields",
27556 "field": "t38pt_udptl",
27562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27563 "version": "0.0.0",
27564 "filename": "server/api/trunk/index.js",
27565 "groupTitle": "Trunks"
27569 "url": "/api/trunks/{id}",
27570 "title": "Deletes a trunk",
27573 "title": "Example usage:",
27574 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27580 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27581 "version": "0.0.0",
27582 "filename": "server/api/trunk/index.js",
27583 "groupTitle": "Trunks"
27587 "url": "/api/trunks",
27588 "title": "Gets a list of Trunks",
27591 "title": "Example usage:",
27592 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27596 "name": "GetTrunks",
27598 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27599 "version": "0.0.0",
27600 "filename": "server/api/trunk/index.js",
27601 "groupTitle": "Trunks"
27605 "url": "/api/trunks/{id}",
27606 "title": "Gets a single Trunk",
27609 "title": "Example usage:",
27610 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27614 "name": "ShowTrunks",
27616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27617 "version": "0.0.0",
27618 "filename": "server/api/trunk/index.js",
27619 "groupTitle": "Trunks"
27623 "url": "/api/trunks/{id}",
27624 "title": "Update an existing trunk",
27627 "title": "Example usage:",
27628 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27635 "version": "0.0.0",
27636 "filename": "server/api/trunk/index.js",
27637 "groupTitle": "Trunks"
27641 "url": "/api/userProfile/resources",
27642 "title": "Creates a new User Profile Resource",
27645 "title": "Example usage:",
27646 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27650 "name": "CreateUser_Profile_Resources",
27651 "group": "User_Profile_Resources",
27666 "field": "resourceId",
27679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27680 "version": "0.0.0",
27681 "filename": "server/api/userProfileResource/index.js",
27682 "groupTitle": "User_Profile_Resources"
27686 "url": "/api/userProfile/resources/{id}",
27687 "title": "Deletes a User Profile Resource",
27690 "title": "Example usage:",
27691 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27695 "name": "DeleteUser_Profile_Resources",
27696 "group": "User_Profile_Resources",
27697 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27698 "version": "0.0.0",
27699 "filename": "server/api/userProfileResource/index.js",
27700 "groupTitle": "User_Profile_Resources"
27704 "url": "/api/userProfile/resources/describe",
27705 "title": "Gets table info about User Profile Resources",
27708 "title": "Example usage:",
27709 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27713 "name": "DescribeUser_Profile_Resources",
27714 "group": "User_Profile_Resources",
27715 "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>",
27716 "version": "0.0.0",
27717 "filename": "server/api/userProfileResource/index.js",
27718 "groupTitle": "User_Profile_Resources"
27722 "url": "/api/userProfile/resources",
27723 "title": "Gets a list of User Profile Resources",
27726 "title": "Example usage:",
27727 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27731 "name": "GetUser_Profile_Resources",
27732 "group": "User_Profile_Resources",
27733 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27734 "version": "0.0.0",
27735 "filename": "server/api/userProfileResource/index.js",
27736 "groupTitle": "User_Profile_Resources"
27740 "url": "/api/userProfile/resources/{id}",
27741 "title": "Gets a single User Profile Resource",
27744 "title": "Example usage:",
27745 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27749 "name": "ShowUser_Profile_Resources",
27750 "group": "User_Profile_Resources",
27751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27752 "version": "0.0.0",
27753 "filename": "server/api/userProfileResource/index.js",
27754 "groupTitle": "User_Profile_Resources"
27758 "url": "/api/userProfile/resources/{id}",
27759 "title": "Update an existing User Profile Resource",
27762 "title": "Example usage:",
27763 "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",
27767 "name": "updateUser_Profile_Resources",
27768 "group": "User_Profile_Resources",
27769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27770 "version": "0.0.0",
27771 "filename": "server/api/userProfileResource/index.js",
27772 "groupTitle": "User_Profile_Resources"
27776 "url": "/api/userProfile/sections",
27777 "title": "Creates a new User Profile Section",
27780 "title": "Example usage:",
27781 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27785 "name": "CreateUser_Profile_Sections",
27786 "group": "User_Profile_Sections",
27801 "field": "category",
27808 "field": "sectionId",
27815 "field": "enabled",
27822 "field": "autoAssociation",
27829 "field": "crudPermissions",
27835 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27836 "version": "0.0.0",
27837 "filename": "server/api/userProfileSection/index.js",
27838 "groupTitle": "User_Profile_Sections"
27842 "url": "/api/userProfile/sections/{id}",
27843 "title": "Deletes a User Profile Section",
27846 "title": "Example usage:",
27847 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27851 "name": "DeleteUser_Profile_Sections",
27852 "group": "User_Profile_Sections",
27853 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27854 "version": "0.0.0",
27855 "filename": "server/api/userProfileSection/index.js",
27856 "groupTitle": "User_Profile_Sections"
27860 "url": "/api/userProfile/sections/describe",
27861 "title": "Gets table info about User Profile Sections",
27864 "title": "Example usage:",
27865 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27869 "name": "DescribeUser_Profile_Sections",
27870 "group": "User_Profile_Sections",
27871 "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>",
27872 "version": "0.0.0",
27873 "filename": "server/api/userProfileSection/index.js",
27874 "groupTitle": "User_Profile_Sections"
27878 "url": "/api/userProfile/sections",
27879 "title": "Gets a list of User Profile Sections",
27882 "title": "Example usage:",
27883 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
27887 "name": "GetUser_Profile_Sections",
27888 "group": "User_Profile_Sections",
27889 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27890 "version": "0.0.0",
27891 "filename": "server/api/userProfileSection/index.js",
27892 "groupTitle": "User_Profile_Sections"
27896 "url": "/api/userProfile/sections/{id}",
27897 "title": "Gets a single User Profile Section",
27900 "title": "Example usage:",
27901 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
27905 "name": "ShowUser_Profile_Sections",
27906 "group": "User_Profile_Sections",
27907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27908 "version": "0.0.0",
27909 "filename": "server/api/userProfileSection/index.js",
27910 "groupTitle": "User_Profile_Sections"
27914 "url": "/api/userProfile/sections/{id}",
27915 "title": "Update an existing User Profile Section",
27918 "title": "Example usage:",
27919 "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",
27923 "name": "updateUser_Profile_Sections",
27924 "group": "User_Profile_Sections",
27925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27926 "version": "0.0.0",
27927 "filename": "server/api/userProfileSection/index.js",
27928 "groupTitle": "User_Profile_Sections"
27932 "url": "/api/userProfiles/{id}/resources",
27933 "title": "Add resources' permissions to User Profile",
27936 "title": "Example usage:",
27937 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27941 "name": "AddResources",
27942 "group": "User_Profiles",
27943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27944 "version": "0.0.0",
27945 "filename": "server/api/userProfile/index.js",
27946 "groupTitle": "User_Profiles"
27950 "url": "/api/userProfiles/{id}/sections",
27951 "title": "Add sections' permissions to User Profile",
27954 "title": "Example usage:",
27955 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27959 "name": "AddSections",
27960 "group": "User_Profiles",
27961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27962 "version": "0.0.0",
27963 "filename": "server/api/userProfile/index.js",
27964 "groupTitle": "User_Profiles"
27968 "url": "/api/userProfiles/clone",
27969 "title": "Clone an existing User Profile",
27972 "title": "Example usage:",
27973 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27977 "name": "CloneUser_Profiles",
27978 "group": "User_Profiles",
27979 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27980 "version": "0.0.0",
27981 "filename": "server/api/userProfile/index.js",
27982 "groupTitle": "User_Profiles"
27986 "url": "/api/userProfiles",
27987 "title": "Creates a new User Profile",
27990 "title": "Example usage:",
27991 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27995 "name": "CreateUser_Profiles",
27996 "group": "User_Profiles",
28011 "field": "crudPermissions",
28018 "field": "description",
28024 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28025 "version": "0.0.0",
28026 "filename": "server/api/userProfile/index.js",
28027 "groupTitle": "User_Profiles"
28031 "url": "/api/userProfiles/{id}",
28032 "title": "Deletes a User Profile",
28035 "title": "Example usage:",
28036 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28040 "name": "DeleteUser_Profiles",
28041 "group": "User_Profiles",
28042 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28043 "version": "0.0.0",
28044 "filename": "server/api/userProfile/index.js",
28045 "groupTitle": "User_Profiles"
28049 "url": "/api/userProfiles/describe",
28050 "title": "Gets table info about User Profiles",
28053 "title": "Example usage:",
28054 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28058 "name": "DescribeUser_Profiles",
28059 "group": "User_Profiles",
28060 "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>",
28061 "version": "0.0.0",
28062 "filename": "server/api/userProfile/index.js",
28063 "groupTitle": "User_Profiles"
28067 "url": "/api/userProfiles/{id}/resources?section={section}",
28068 "title": "Get Resources assigned to a Section",
28071 "title": "Example usage:",
28072 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28076 "name": "GetResources",
28077 "group": "User_Profiles",
28078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28079 "version": "0.0.0",
28080 "filename": "server/api/userProfile/index.js",
28081 "groupTitle": "User_Profiles"
28085 "url": "/api/userProfiles/{id}/sections",
28086 "title": "Get sections associated to a User Profile",
28089 "title": "Example usage:",
28090 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28094 "name": "GetSections",
28095 "group": "User_Profiles",
28096 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28097 "version": "0.0.0",
28098 "filename": "server/api/userProfile/index.js",
28099 "groupTitle": "User_Profiles"
28103 "url": "/api/userProfiles",
28104 "title": "Gets a list of User Profiles",
28107 "title": "Example usage:",
28108 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28112 "name": "GetUser_Profiles",
28113 "group": "User_Profiles",
28114 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28115 "version": "0.0.0",
28116 "filename": "server/api/userProfile/index.js",
28117 "groupTitle": "User_Profiles"
28121 "url": "/api/userProfiles/{id}/resources",
28122 "title": "Removes resources' permissions from User Profile",
28125 "title": "Example usage:",
28126 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28130 "name": "RemoveResources",
28131 "group": "User_Profiles",
28132 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28133 "version": "0.0.0",
28134 "filename": "server/api/userProfile/index.js",
28135 "groupTitle": "User_Profiles"
28139 "url": "/api/userProfiles/{id}/sections",
28140 "title": "Removes sections' permissions from User Profile",
28143 "title": "Example usage:",
28144 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28148 "name": "RemoveSections",
28149 "group": "User_Profiles",
28150 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28151 "version": "0.0.0",
28152 "filename": "server/api/userProfile/index.js",
28153 "groupTitle": "User_Profiles"
28157 "url": "/api/userProfiles/{id}",
28158 "title": "Gets a single User Profile",
28161 "title": "Example usage:",
28162 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28166 "name": "ShowUser_Profiles",
28167 "group": "User_Profiles",
28168 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28169 "version": "0.0.0",
28170 "filename": "server/api/userProfile/index.js",
28171 "groupTitle": "User_Profiles"
28175 "url": "/api/userProfiles/{id}",
28176 "title": "Update an existing User Profile",
28179 "title": "Example usage:",
28180 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28184 "name": "updateUser_Profiles",
28185 "group": "User_Profiles",
28186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28187 "version": "0.0.0",
28188 "filename": "server/api/userProfile/index.js",
28189 "groupTitle": "User_Profiles"
28193 "url": "/api/users/{id}/chat_interactions",
28194 "title": "Add chat interaction tabs to an agent",
28197 "title": "Example usage:",
28198 "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",
28202 "name": "AddChatInteractions",
28204 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28205 "version": "0.0.0",
28206 "filename": "server/api/user/index.js",
28207 "groupTitle": "Users"
28211 "url": "/api/users/{id}/chat_websites",
28212 "title": "Add a Chat Website to a user",
28215 "title": "Example usage:",
28216 "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",
28220 "name": "AddChatWebsites",
28222 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28223 "version": "0.0.0",
28224 "filename": "server/api/user/index.js",
28225 "groupTitle": "Users"
28229 "url": "/api/users/{id}/contacts",
28230 "title": "Add contacts to a user",
28233 "title": "Example usage:",
28234 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28238 "name": "AddContacts",
28240 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28241 "version": "0.0.0",
28242 "filename": "server/api/user/index.js",
28243 "groupTitle": "Users"
28247 "url": "/api/users/{id}/fax_accounts",
28248 "title": "Add a Fax Account to a user",
28251 "title": "Example usage:",
28252 "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",
28256 "name": "AddFaxAccounts",
28258 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28259 "version": "0.0.0",
28260 "filename": "server/api/user/index.js",
28261 "groupTitle": "Users"
28265 "url": "/api/users/{id}/fax_interactions",
28266 "title": "Add fax interaction tabs to an agent",
28269 "title": "Example usage:",
28270 "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",
28274 "name": "AddFaxInteractions",
28276 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28277 "version": "0.0.0",
28278 "filename": "server/api/user/index.js",
28279 "groupTitle": "Users"
28283 "url": "/api/users/{id}/mail_accounts",
28284 "title": "Add a Mail Account to a user",
28287 "title": "Example usage:",
28288 "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",
28292 "name": "AddMailAccounts",
28294 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28295 "version": "0.0.0",
28296 "filename": "server/api/user/index.js",
28297 "groupTitle": "Users"
28301 "url": "/api/users/{id}/mail_interactions",
28302 "title": "Add mail interaction tabs to an agent",
28305 "title": "Example usage:",
28306 "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",
28310 "name": "AddMailInteractions",
28312 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28313 "version": "0.0.0",
28314 "filename": "server/api/user/index.js",
28315 "groupTitle": "Users"
28319 "url": "/api/users/{id}/openchannel_accounts",
28320 "title": "Add a Open Channel Account to a user",
28323 "title": "Example usage:",
28324 "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",
28328 "name": "AddOpenchannelAccounts",
28330 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28331 "version": "0.0.0",
28332 "filename": "server/api/user/index.js",
28333 "groupTitle": "Users"
28337 "url": "/api/users/{id}/openchannel_interactions",
28338 "title": "Add openchannel interaction tabs to an agent",
28341 "title": "Example usage:",
28342 "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",
28346 "name": "AddOpenchannelInteractions",
28348 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28349 "version": "0.0.0",
28350 "filename": "server/api/user/index.js",
28351 "groupTitle": "Users"
28355 "url": "/api/users/{id}/queues",
28356 "title": "Add queues to an agent",
28359 "title": "Example usage:",
28360 "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",
28364 "name": "AddQueues",
28366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28367 "version": "0.0.0",
28368 "filename": "server/api/user/index.js",
28369 "groupTitle": "Users"
28373 "url": "/api/users/{id}/sms_accounts",
28374 "title": "Add a Sms Account to a user",
28377 "title": "Example usage:",
28378 "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",
28382 "name": "AddSmsAccounts",
28384 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28385 "version": "0.0.0",
28386 "filename": "server/api/user/index.js",
28387 "groupTitle": "Users"
28391 "url": "/api/users/{id}/sms_interactions",
28392 "title": "Add sms interaction tabs to an agent",
28395 "title": "Example usage:",
28396 "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",
28400 "name": "AddSmsInteractions",
28402 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28403 "version": "0.0.0",
28404 "filename": "server/api/user/index.js",
28405 "groupTitle": "Users"
28409 "url": "/api/users/{id}/square_projects",
28410 "title": "Add a Square Project to a user",
28413 "title": "Example usage:",
28414 "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",
28418 "name": "AddSquareProjects",
28420 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28421 "version": "0.0.0",
28422 "filename": "server/api/user/index.js",
28423 "groupTitle": "Users"
28427 "url": "/api/users/{id}/teams",
28428 "title": "Add teams to an agent",
28431 "title": "Example usage:",
28432 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28436 "name": "AddTeams",
28438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28439 "version": "0.0.0",
28440 "filename": "server/api/user/index.js",
28441 "groupTitle": "Users"
28445 "url": "/api/users/{id}/whatsapp_accounts",
28446 "title": "Add a Whatsapp Account to a user",
28449 "title": "Example usage:",
28450 "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",
28454 "name": "AddWhatsappAccounts",
28456 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28457 "version": "0.0.0",
28458 "filename": "server/api/user/index.js",
28459 "groupTitle": "Users"
28463 "url": "/api/users/{id}/whatsapp_interactions",
28464 "title": "Add Whatsapp interaction tabs to an agent",
28467 "title": "Example usage:",
28468 "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",
28472 "name": "AddWhatsappInteractions",
28474 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28475 "version": "0.0.0",
28476 "filename": "server/api/user/index.js",
28477 "groupTitle": "Users"
28481 "url": "/api/users/{id}/password",
28482 "title": "Change user password",
28485 "title": "Example usage:",
28486 "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",
28490 "name": "ChangePwd",
28492 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28493 "version": "0.0.0",
28494 "filename": "server/api/user/index.js",
28495 "groupTitle": "Users"
28499 "url": "/api/users",
28500 "title": "Create a new user",
28503 "title": "Example usage:",
28504 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28510 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28511 "version": "0.0.0",
28512 "filename": "server/api/user/index.js",
28513 "groupTitle": "Users"
28517 "url": "/api/users/{id}/api_key",
28518 "title": "Create a new API access key for the user",
28521 "title": "Example usage:",
28522 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28526 "name": "CreateApiKey",
28528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28529 "version": "0.0.0",
28530 "filename": "server/api/user/index.js",
28531 "groupTitle": "Users"
28535 "url": "/api/users/{id}",
28536 "title": "Deletes a user",
28539 "title": "Example usage:",
28540 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28546 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28547 "version": "0.0.0",
28548 "filename": "server/api/user/index.js",
28549 "groupTitle": "Users"
28553 "url": "/api/users/describe",
28554 "title": "Gets table info about Users",
28557 "title": "Example usage:",
28558 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28562 "name": "DescribeUsers",
28564 "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>",
28565 "version": "0.0.0",
28566 "filename": "server/api/user/index.js",
28567 "groupTitle": "Users"
28571 "url": "/api/users/{id}/agents",
28572 "title": "GetAgents",
28575 "title": "Example usage:",
28576 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28580 "name": "GetAgents",
28582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28583 "version": "0.0.0",
28584 "filename": "server/api/user/index.js",
28585 "groupTitle": "Users"
28589 "url": "/api/users/{id}/api_key",
28590 "title": "Get the API access key for the user",
28593 "title": "Example usage:",
28594 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28598 "name": "GetApiKey",
28600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28601 "version": "0.0.0",
28602 "filename": "server/api/user/index.js",
28603 "groupTitle": "Users"
28607 "url": "/api/users/{id}/groups",
28608 "title": "GetChatGroups",
28611 "title": "Example usage:",
28612 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28616 "name": "GetChatGroups",
28618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28619 "version": "0.0.0",
28620 "filename": "server/api/user/index.js",
28621 "groupTitle": "Users"
28625 "url": "/api/users/{id}/chat/interactions",
28626 "title": "GetChatInteractions",
28629 "title": "Example usage:",
28630 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28634 "name": "GetChatInteractions",
28636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28637 "version": "0.0.0",
28638 "filename": "server/api/user/index.js",
28639 "groupTitle": "Users"
28643 "url": "/api/users/{id}/chat_websites",
28644 "title": "GetChatWebsites",
28647 "title": "Example usage:",
28648 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28652 "name": "GetChatWebsites",
28654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28655 "version": "0.0.0",
28656 "filename": "server/api/user/index.js",
28657 "groupTitle": "Users"
28661 "url": "/api/users/{id}/contacts",
28662 "title": "GetContacts",
28665 "title": "Example usage:",
28666 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28670 "name": "GetContacts",
28672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28673 "version": "0.0.0",
28674 "filename": "server/api/user/index.js",
28675 "groupTitle": "Users"
28679 "url": "/api/users/{id}/fax_accounts",
28680 "title": "GetFaxAccounts",
28683 "title": "Example usage:",
28684 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28688 "name": "GetFaxAccounts",
28690 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28691 "version": "0.0.0",
28692 "filename": "server/api/user/index.js",
28693 "groupTitle": "Users"
28697 "url": "/api/users/{id}/fax/interactions",
28698 "title": "GetFaxInteractions",
28701 "title": "Example usage:",
28702 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28706 "name": "GetFaxInteractions",
28708 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28709 "version": "0.0.0",
28710 "filename": "server/api/user/index.js",
28711 "groupTitle": "Users"
28715 "url": "/api/users/{id}/lists",
28716 "title": "GetLists",
28719 "title": "Example usage:",
28720 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28724 "name": "GetLists",
28726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28727 "version": "0.0.0",
28728 "filename": "server/api/user/index.js",
28729 "groupTitle": "Users"
28733 "url": "/api/users/{id}/mail_accounts",
28734 "title": "GetMailAccounts",
28737 "title": "Example usage:",
28738 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28742 "name": "GetMailAccounts",
28744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28745 "version": "0.0.0",
28746 "filename": "server/api/user/index.js",
28747 "groupTitle": "Users"
28751 "url": "/api/users/{id}/mail/interactions",
28752 "title": "GetMailInteractions",
28755 "title": "Example usage:",
28756 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28760 "name": "GetMailInteractions",
28762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28763 "version": "0.0.0",
28764 "filename": "server/api/user/index.js",
28765 "groupTitle": "Users"
28769 "url": "/api/users/{id}/openchannel_accounts",
28770 "title": "GetOpenchannelAccounts",
28773 "title": "Example usage:",
28774 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28778 "name": "GetOpenchannelAccounts",
28780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28781 "version": "0.0.0",
28782 "filename": "server/api/user/index.js",
28783 "groupTitle": "Users"
28787 "url": "/api/users/{id}/openchannel/interactions",
28788 "title": "GetOpenchannelInteractions",
28791 "title": "Example usage:",
28792 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28796 "name": "GetOpenchannelInteractions",
28798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28799 "version": "0.0.0",
28800 "filename": "server/api/user/index.js",
28801 "groupTitle": "Users"
28805 "url": "/api/users/{id}/prefixes",
28806 "title": "GetPrefixes",
28809 "title": "Example usage:",
28810 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28814 "name": "GetPrefixes",
28816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28817 "version": "0.0.0",
28818 "filename": "server/api/user/index.js",
28819 "groupTitle": "Users"
28823 "url": "/api/users/{id}/queues?channel={channel}",
28824 "title": "Gets Queues list",
28827 "title": "Example usage:",
28828 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
28832 "name": "GetQueues",
28834 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28835 "version": "0.0.0",
28836 "filename": "server/api/user/index.js",
28837 "groupTitle": "Users"
28841 "url": "/api/users/{id}/recordings",
28842 "title": "GetRecordings",
28845 "title": "Example usage:",
28846 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
28850 "name": "GetRecordings",
28852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28853 "version": "0.0.0",
28854 "filename": "server/api/user/index.js",
28855 "groupTitle": "Users"
28859 "url": "/api/users/{id}/scheduled_calls",
28860 "title": "GetScheduledCalls",
28863 "title": "Example usage:",
28864 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
28868 "name": "GetScheduledCalls",
28870 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28871 "version": "0.0.0",
28872 "filename": "server/api/user/index.js",
28873 "groupTitle": "Users"
28877 "url": "/api/users/{id}/screen_recordings",
28878 "title": "GetScreenRecordings",
28881 "title": "Example usage:",
28882 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
28886 "name": "GetScreenRecordings",
28888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28889 "version": "0.0.0",
28890 "filename": "server/api/user/index.js",
28891 "groupTitle": "Users"
28895 "url": "/api/users/{id}/sms_accounts",
28896 "title": "GetSmsAccounts",
28899 "title": "Example usage:",
28900 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
28904 "name": "GetSmsAccounts",
28906 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28907 "version": "0.0.0",
28908 "filename": "server/api/user/index.js",
28909 "groupTitle": "Users"
28913 "url": "/api/users/{id}/sms/interactions",
28914 "title": "GetSmsInteractions",
28917 "title": "Example usage:",
28918 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
28922 "name": "GetSmsInteractions",
28924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28925 "version": "0.0.0",
28926 "filename": "server/api/user/index.js",
28927 "groupTitle": "Users"
28931 "url": "/api/users/{id}/square_projects",
28932 "title": "GetSquareProjects",
28935 "title": "Example usage:",
28936 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
28940 "name": "GetSquareProjects",
28942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28943 "version": "0.0.0",
28944 "filename": "server/api/user/index.js",
28945 "groupTitle": "Users"
28949 "url": "/api/users/{id}/teams",
28950 "title": "GetTeams",
28953 "title": "Example usage:",
28954 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
28958 "name": "GetTeams",
28960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28961 "version": "0.0.0",
28962 "filename": "server/api/user/index.js",
28963 "groupTitle": "Users"
28967 "url": "/api/users",
28968 "title": "Gets a list of Users",
28971 "title": "Example usage:",
28972 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
28976 "name": "GetUsers",
28978 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28979 "version": "0.0.0",
28980 "filename": "server/api/user/index.js",
28981 "groupTitle": "Users"
28985 "url": "/api/users/{id}/queues_rt",
28986 "title": "GetVoiceQueuesRt",
28989 "title": "Example usage:",
28990 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
28994 "name": "GetVoiceQueuesRt",
28996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28997 "version": "0.0.0",
28998 "filename": "server/api/user/index.js",
28999 "groupTitle": "Users"
29003 "url": "/api/users/{id}/whatsapp_accounts",
29004 "title": "GetWhatsappAccounts",
29007 "title": "Example usage:",
29008 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29012 "name": "GetWhatsappAccounts",
29014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29015 "version": "0.0.0",
29016 "filename": "server/api/user/index.js",
29017 "groupTitle": "Users"
29021 "url": "/api/users/{id}/whatsapp/interactions",
29022 "title": "GetWhatsappInteractions",
29025 "title": "Example usage:",
29026 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29030 "name": "GetWhatsappInteractions",
29032 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29033 "version": "0.0.0",
29034 "filename": "server/api/user/index.js",
29035 "groupTitle": "Users"
29039 "url": "/api/users/{id}/login",
29043 "title": "Example usage:",
29044 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29050 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29051 "version": "0.0.0",
29052 "filename": "server/api/user/index.js",
29053 "groupTitle": "Users"
29057 "url": "/api/users/{id}/logout",
29061 "title": "Example usage:",
29062 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29068 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29069 "version": "0.0.0",
29070 "filename": "server/api/user/index.js",
29071 "groupTitle": "Users"
29075 "url": "/api/users/{id}/pause",
29079 "title": "Example usage:",
29080 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29087 "version": "0.0.0",
29088 "filename": "server/api/user/index.js",
29089 "groupTitle": "Users"
29093 "url": "/api/users/{id}/api_key",
29094 "title": "Remove API access key for the user",
29097 "title": "Example usage:",
29098 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29102 "name": "RemoveApiKey",
29104 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29105 "version": "0.0.0",
29106 "filename": "server/api/user/index.js",
29107 "groupTitle": "Users"
29111 "url": "/api/users/{id}/chat_interactions",
29112 "title": "Removes interactions from an agent",
29115 "title": "Example usage:",
29116 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29120 "name": "RemoveChatInteractions",
29122 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29123 "version": "0.0.0",
29124 "filename": "server/api/user/index.js",
29125 "groupTitle": "Users"
29129 "url": "/api/users/{id}/chat_websites",
29130 "title": "Removes a Chat Website from a user",
29133 "title": "Example usage:",
29134 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29138 "name": "RemoveChatWebsites",
29140 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29141 "version": "0.0.0",
29142 "filename": "server/api/user/index.js",
29143 "groupTitle": "Users"
29147 "url": "/api/users/{id}/fax_accounts",
29148 "title": "Removes a Fax Account from a user",
29151 "title": "Example usage:",
29152 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29156 "name": "RemoveFaxAccounts",
29158 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29159 "version": "0.0.0",
29160 "filename": "server/api/user/index.js",
29161 "groupTitle": "Users"
29165 "url": "/api/users/{id}/fax_interactions",
29166 "title": "Removes interactions from an agent",
29169 "title": "Example usage:",
29170 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29174 "name": "RemoveFaxInteractions",
29176 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29177 "version": "0.0.0",
29178 "filename": "server/api/user/index.js",
29179 "groupTitle": "Users"
29183 "url": "/api/users/{id}/mail_accounts",
29184 "title": "Removes a Mail Account from a user",
29187 "title": "Example usage:",
29188 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29192 "name": "RemoveMailAccounts",
29194 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29195 "version": "0.0.0",
29196 "filename": "server/api/user/index.js",
29197 "groupTitle": "Users"
29201 "url": "/api/users/{id}/mail_interactions",
29202 "title": "Removes interactions from an agent",
29205 "title": "Example usage:",
29206 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29210 "name": "RemoveMailInteractions",
29212 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29213 "version": "0.0.0",
29214 "filename": "server/api/user/index.js",
29215 "groupTitle": "Users"
29219 "url": "/api/users/{id}/openchannel_accounts",
29220 "title": "Removes a Open Channel Account from a user",
29223 "title": "Example usage:",
29224 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29228 "name": "RemoveOpenchannelAccounts",
29230 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29231 "version": "0.0.0",
29232 "filename": "server/api/user/index.js",
29233 "groupTitle": "Users"
29237 "url": "/api/users/{id}/openchannel_interactions",
29238 "title": "Removes openchannel interactions from an agent",
29241 "title": "Example usage:",
29242 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29246 "name": "RemoveOpenchannelInteractions",
29248 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29249 "version": "0.0.0",
29250 "filename": "server/api/user/index.js",
29251 "groupTitle": "Users"
29255 "url": "/api/users/{id}/queues",
29256 "title": "Remove queues to an agent",
29259 "title": "Example usage:",
29260 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29264 "name": "RemoveQueues",
29266 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29267 "version": "0.0.0",
29268 "filename": "server/api/user/index.js",
29269 "groupTitle": "Users"
29273 "url": "/api/users/{id}/sms_accounts",
29274 "title": "Removes a Sms Account from a user",
29277 "title": "Example usage:",
29278 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29282 "name": "RemoveSmsAccounts",
29284 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29285 "version": "0.0.0",
29286 "filename": "server/api/user/index.js",
29287 "groupTitle": "Users"
29291 "url": "/api/users/{id}/sms_interactions",
29292 "title": "Removes interactions from an agent",
29295 "title": "Example usage:",
29296 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29300 "name": "RemoveSmsInteractions",
29302 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29303 "version": "0.0.0",
29304 "filename": "server/api/user/index.js",
29305 "groupTitle": "Users"
29309 "url": "/api/users/{id}/square_projects",
29310 "title": "Removes a Square Project from a user",
29313 "title": "Example usage:",
29314 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29318 "name": "RemoveSquareProjects",
29320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29321 "version": "0.0.0",
29322 "filename": "server/api/user/index.js",
29323 "groupTitle": "Users"
29327 "url": "/api/users/{id}/teams",
29328 "title": "Removes teams from an agent",
29331 "title": "Example usage:",
29332 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29336 "name": "RemoveTeams",
29338 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29339 "version": "0.0.0",
29340 "filename": "server/api/user/index.js",
29341 "groupTitle": "Users"
29345 "url": "/api/users/{id}/whatsapp_accounts",
29346 "title": "Removes a Whatsapp Account from a user",
29349 "title": "Example usage:",
29350 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29354 "name": "RemoveWhatsappAccounts",
29356 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29357 "version": "0.0.0",
29358 "filename": "server/api/user/index.js",
29359 "groupTitle": "Users"
29363 "url": "/api/users/{id}/whatsapp_interactions",
29364 "title": "Removes Whatsapp interactions from an agent",
29367 "title": "Example usage:",
29368 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29372 "name": "RemoveWhatsappInteractions",
29374 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29375 "version": "0.0.0",
29376 "filename": "server/api/user/index.js",
29377 "groupTitle": "Users"
29381 "url": "/api/users/{id}",
29382 "title": "Gets a single User",
29385 "title": "Example usage:",
29386 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29390 "name": "ShowUsers",
29392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29393 "version": "0.0.0",
29394 "filename": "server/api/user/index.js",
29395 "groupTitle": "Users"
29399 "url": "/api/users/{id}/unpause",
29400 "title": "Unpause",
29403 "title": "Example usage:",
29404 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29411 "version": "0.0.0",
29412 "filename": "server/api/user/index.js",
29413 "groupTitle": "Users"
29417 "url": "/api/users/whoami",
29421 "title": "Example usage:",
29422 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29429 "version": "0.0.0",
29430 "filename": "server/api/user/index.js",
29431 "groupTitle": "Users"
29435 "url": "/api/users/{id}/avatar",
29436 "title": "Add avatar",
29439 "title": "Example usage:",
29440 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29444 "name": "addAvatar",
29446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29447 "version": "0.0.0",
29448 "filename": "server/api/user/index.js",
29449 "groupTitle": "Users"
29453 "url": "/api/users/create_many",
29454 "title": "Create Users",
29457 "title": "Example usage:",
29458 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29462 "name": "bulkCreate",
29464 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29465 "version": "0.0.0",
29466 "filename": "server/api/user/index.js",
29467 "groupTitle": "Users"
29471 "url": "/api/users/{id}/avatar",
29472 "title": "Get avatar",
29475 "title": "Example usage:",
29476 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29480 "name": "getAvatar",
29482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29483 "version": "0.0.0",
29484 "filename": "server/api/user/index.js",
29485 "groupTitle": "Users"
29489 "url": "/api/users/{id}",
29490 "title": "Update an existing User",
29493 "title": "Example usage:",
29494 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29498 "name": "updateUsers",
29500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29501 "version": "0.0.0",
29502 "filename": "server/api/user/index.js",
29503 "groupTitle": "Users"
29507 "url": "/api/variables",
29508 "title": "Creates a new Variable",
29511 "title": "Example usage:",
29512 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29516 "name": "CreateVariables",
29517 "group": "Variables",
29532 "field": "description",
29538 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29539 "version": "0.0.0",
29540 "filename": "server/api/variable/index.js",
29541 "groupTitle": "Variables"
29545 "url": "/api/variables/{id}",
29546 "title": "Deletes a Variable",
29549 "title": "Example usage:",
29550 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29554 "name": "DeleteVariables",
29555 "group": "Variables",
29556 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29557 "version": "0.0.0",
29558 "filename": "server/api/variable/index.js",
29559 "groupTitle": "Variables"
29563 "url": "/api/variables",
29564 "title": "Gets a list of Variables",
29567 "title": "Example usage:",
29568 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29572 "name": "GetVariables",
29573 "group": "Variables",
29574 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29575 "version": "0.0.0",
29576 "filename": "server/api/variable/index.js",
29577 "groupTitle": "Variables"
29581 "url": "/api/variables/{id}",
29582 "title": "Gets a single Variable",
29585 "title": "Example usage:",
29586 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29590 "name": "ShowVariables",
29591 "group": "Variables",
29592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29593 "version": "0.0.0",
29594 "filename": "server/api/variable/index.js",
29595 "groupTitle": "Variables"
29599 "url": "/api/variables/{id}",
29600 "title": "Update an existing Variable",
29603 "title": "Example usage:",
29604 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29608 "name": "updateVariables",
29609 "group": "Variables",
29610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29611 "version": "0.0.0",
29612 "filename": "server/api/variable/index.js",
29613 "groupTitle": "Variables"
29617 "url": "/api/version/fetch",
29618 "title": "Fetch git version",
29621 "title": "Example usage:",
29622 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29626 "name": "FetchVersion",
29627 "group": "Version",
29628 "description": "<p>Motion run the following command: git fetch origin master</p>",
29629 "version": "0.0.0",
29630 "filename": "server/api/version/index.js",
29631 "groupTitle": "Version"
29635 "url": "/api/version",
29636 "title": "Gets version",
29639 "title": "Example usage:",
29640 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29644 "name": "GetVersion",
29645 "group": "Version",
29646 "description": "<p>Motion returns the current and latest motion version.</p>",
29647 "version": "0.0.0",
29648 "filename": "server/api/version/index.js",
29649 "groupTitle": "Version"
29653 "url": "/api/version/migrations",
29654 "title": "Launch database migrations",
29657 "title": "Example usage:",
29658 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29662 "name": "MigrateVersion",
29663 "group": "Version",
29664 "description": "<p>Motion launch the database migrations, according to the application version</p>",
29665 "version": "0.0.0",
29666 "filename": "server/api/version/index.js",
29667 "groupTitle": "Version"
29671 "url": "/api/version/pull",
29672 "title": "Pull git version",
29675 "title": "Example usage:",
29676 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29680 "name": "PullVersion",
29681 "group": "Version",
29682 "description": "<p>Motion run the following command: git pull</p>",
29683 "version": "0.0.0",
29684 "filename": "server/api/version/index.js",
29685 "groupTitle": "Version"
29689 "url": "/api/version/reset",
29690 "title": "Reset git version",
29693 "title": "Example usage:",
29694 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29698 "name": "ResetVersion",
29699 "group": "Version",
29700 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29701 "version": "0.0.0",
29702 "filename": "server/api/version/index.js",
29703 "groupTitle": "Version"
29707 "url": "/api/version/restart",
29708 "title": "Restart motion2 after update",
29711 "title": "Example usage:",
29712 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29716 "name": "RestartVersion",
29717 "group": "Version",
29718 "description": "<p>Motion run the following command: pm2 restart motion</p>",
29719 "version": "0.0.0",
29720 "filename": "server/api/version/index.js",
29721 "groupTitle": "Version"
29725 "url": "/api/voice/agents/reports/describe",
29726 "title": "Gets table info about Agent Reports",
29729 "title": "Example usage:",
29730 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29734 "name": "DescribeAgent_Reports",
29735 "group": "Voice_Agent_Reports",
29736 "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>",
29737 "version": "0.0.0",
29738 "filename": "server/api/voiceAgentReport/index.js",
29739 "groupTitle": "Voice_Agent_Reports"
29743 "url": "/api/voice/agents/reports",
29744 "title": "Gets a list of Agent Reports",
29747 "title": "Example usage:",
29748 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29752 "name": "GetAgent_Reports",
29753 "group": "Voice_Agent_Reports",
29754 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29755 "version": "0.0.0",
29756 "filename": "server/api/voiceAgentReport/index.js",
29757 "groupTitle": "Voice_Agent_Reports"
29761 "url": "/api/voice/agents/reports/{id}",
29762 "title": "Gets a single Agent Report",
29765 "title": "Example usage:",
29766 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29770 "name": "ShowAgent_Reports",
29771 "group": "Voice_Agent_Reports",
29772 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29773 "version": "0.0.0",
29774 "filename": "server/api/voiceAgentReport/index.js",
29775 "groupTitle": "Voice_Agent_Reports"
29779 "url": "/api/voice/calls/reports/describe",
29780 "title": "Gets table info about Call Reports",
29783 "title": "Example usage:",
29784 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29788 "name": "DescribeCall_Reports",
29789 "group": "Voice_Call_Reports",
29790 "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>",
29791 "version": "0.0.0",
29792 "filename": "server/api/voiceCallReport/index.js",
29793 "groupTitle": "Voice_Call_Reports"
29797 "url": "/api/voice/calls/reports",
29798 "title": "Gets a list of Call Reports",
29801 "title": "Example usage:",
29802 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
29806 "name": "GetCall_Reports",
29807 "group": "Voice_Call_Reports",
29808 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29809 "version": "0.0.0",
29810 "filename": "server/api/voiceCallReport/index.js",
29811 "groupTitle": "Voice_Call_Reports"
29815 "url": "/api/voice/calls/reports/{id}",
29816 "title": "Gets a single Call Report",
29819 "title": "Example usage:",
29820 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
29824 "name": "ShowCall_Reports",
29825 "group": "Voice_Call_Reports",
29826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29827 "version": "0.0.0",
29828 "filename": "server/api/voiceCallReport/index.js",
29829 "groupTitle": "Voice_Call_Reports"
29833 "url": "/api/voice/calls/reports/{id}",
29834 "title": "Update a single cdr",
29837 "title": "Example usage:",
29838 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
29843 "group": "Voice_Call_Reports",
29844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29845 "version": "0.0.0",
29846 "filename": "server/api/voiceCallReport/index.js",
29847 "groupTitle": "Voice_Call_Reports"
29851 "url": "/api/voice/chanspy",
29852 "title": "Creates a new ChanSpy",
29855 "title": "Example usage:",
29856 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29860 "name": "CreateChanSpy",
29861 "group": "Voice_ChanSpy",
29883 "field": "options",
29897 "field": "password",
29911 "field": "recordingFormat",
29918 "field": "description",
29924 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29925 "version": "0.0.0",
29926 "filename": "server/api/voiceChanSpy/index.js",
29927 "groupTitle": "Voice_ChanSpy"
29931 "url": "/api/voice/chanspy/{id}",
29932 "title": "Deletes a ChanSpy",
29935 "title": "Example usage:",
29936 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
29940 "name": "DeleteChanSpy",
29941 "group": "Voice_ChanSpy",
29942 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29943 "version": "0.0.0",
29944 "filename": "server/api/voiceChanSpy/index.js",
29945 "groupTitle": "Voice_ChanSpy"
29949 "url": "/api/voice/chanspy",
29950 "title": "Gets a list of ChanSpy",
29953 "title": "Example usage:",
29954 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
29958 "name": "GetChanSpy",
29959 "group": "Voice_ChanSpy",
29960 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29961 "version": "0.0.0",
29962 "filename": "server/api/voiceChanSpy/index.js",
29963 "groupTitle": "Voice_ChanSpy"
29967 "url": "/api/voice/chanspy/{id}",
29968 "title": "Gets a single ChanSpy",
29971 "title": "Example usage:",
29972 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
29976 "name": "ShowChanSpy",
29977 "group": "Voice_ChanSpy",
29978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29979 "version": "0.0.0",
29980 "filename": "server/api/voiceChanSpy/index.js",
29981 "groupTitle": "Voice_ChanSpy"
29985 "url": "/api/voice/chanspy/{id}",
29986 "title": "Update an existing ChanSpy",
29989 "title": "Example usage:",
29990 "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",
29994 "name": "updateChanSpy",
29995 "group": "Voice_ChanSpy",
29996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29997 "version": "0.0.0",
29998 "filename": "server/api/voiceChanSpy/index.js",
29999 "groupTitle": "Voice_ChanSpy"
30003 "url": "/api/voice/contexts",
30004 "title": "Create a new context",
30007 "title": "Example usage:",
30008 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30013 "group": "Voice_Contexts",
30028 "field": "description",
30035 "field": "defaultEntry",
30041 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30042 "version": "0.0.0",
30043 "filename": "server/api/voiceContext/index.js",
30044 "groupTitle": "Voice_Contexts"
30048 "url": "/api/voice/contexts/{id}",
30049 "title": "Deletes a context",
30052 "title": "Example usage:",
30053 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30058 "group": "Voice_Contexts",
30059 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30060 "version": "0.0.0",
30061 "filename": "server/api/voiceContext/index.js",
30062 "groupTitle": "Voice_Contexts"
30066 "url": "/api/voice/contexts",
30067 "title": "Gets a list of Contexts",
30070 "title": "Example usage:",
30071 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30075 "name": "GetContexts",
30076 "group": "Voice_Contexts",
30077 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30078 "version": "0.0.0",
30079 "filename": "server/api/voiceContext/index.js",
30080 "groupTitle": "Voice_Contexts"
30084 "url": "/api/voice/contexts/{id}",
30085 "title": "Gets a single Context",
30088 "title": "Example usage:",
30089 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30093 "name": "ShowContexts",
30094 "group": "Voice_Contexts",
30095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30096 "version": "0.0.0",
30097 "filename": "server/api/voiceContext/index.js",
30098 "groupTitle": "Voice_Contexts"
30102 "url": "/api/voice/contexts/{id}",
30103 "title": "Update an existing context",
30106 "title": "Example usage:",
30107 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30112 "group": "Voice_Contexts",
30113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30114 "version": "0.0.0",
30115 "filename": "server/api/voiceContext/index.js",
30116 "groupTitle": "Voice_Contexts"
30120 "url": "/api/voice/dials/reports/describe",
30121 "title": "Gets table info about Dial Reports",
30124 "title": "Example usage:",
30125 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30129 "name": "DescribeDial_Reports",
30130 "group": "Voice_Dial_Reports",
30131 "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>",
30132 "version": "0.0.0",
30133 "filename": "server/api/voiceDialReport/index.js",
30134 "groupTitle": "Voice_Dial_Reports"
30138 "url": "/api/voice/dials/reports",
30139 "title": "Gets a list of Dial Reports",
30142 "title": "Example usage:",
30143 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30147 "name": "GetDial_Reports",
30148 "group": "Voice_Dial_Reports",
30149 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30150 "version": "0.0.0",
30151 "filename": "server/api/voiceDialReport/index.js",
30152 "groupTitle": "Voice_Dial_Reports"
30156 "url": "/api/voice/dials/reports/{id}",
30157 "title": "Gets a single Dial Report",
30160 "title": "Example usage:",
30161 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30165 "name": "ShowDial_Reports",
30166 "group": "Voice_Dial_Reports",
30167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30168 "version": "0.0.0",
30169 "filename": "server/api/voiceDialReport/index.js",
30170 "groupTitle": "Voice_Dial_Reports"
30174 "url": "/api/voice/extensions/{id}",
30175 "title": "Deletes a Extension",
30178 "title": "Example usage:",
30179 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30183 "name": "DeleteExtensions",
30184 "group": "Voice_Extensions",
30185 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30186 "version": "0.0.0",
30187 "filename": "server/api/voiceExtension/index.js",
30188 "groupTitle": "Voice_Extensions"
30192 "url": "/api/voice/extensions",
30193 "title": "Gets a list of Extensions",
30196 "title": "Example usage:",
30197 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30201 "name": "GetExtensions",
30202 "group": "Voice_Extensions",
30203 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30204 "version": "0.0.0",
30205 "filename": "server/api/voiceExtension/index.js",
30206 "groupTitle": "Voice_Extensions"
30210 "url": "/api/voice/extensions/{id}",
30211 "title": "Gets a single Extension",
30214 "title": "Example usage:",
30215 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30219 "name": "ShowExtensions",
30220 "group": "Voice_Extensions",
30221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30222 "version": "0.0.0",
30223 "filename": "server/api/voiceExtension/index.js",
30224 "groupTitle": "Voice_Extensions"
30228 "url": "/api/voice/extensions",
30229 "title": "Create new applications",
30232 "title": "Example usage:",
30233 "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",
30237 "name": "addApplications",
30238 "group": "Voice_Extensions",
30239 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30240 "version": "0.0.0",
30241 "filename": "server/api/voiceExtension/index.js",
30242 "groupTitle": "Voice_Extensions"
30246 "url": "/api/voice/extensions",
30247 "title": "Create an extension",
30250 "title": "Example usage:",
30251 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30256 "group": "Voice_Extensions",
30257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30258 "version": "0.0.0",
30259 "filename": "server/api/voiceExtension/index.js",
30260 "groupTitle": "Voice_Extensions"
30264 "url": "/api/voice/extensions/{id}",
30265 "title": "Update an extension",
30268 "title": "Example usage:",
30269 "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",
30274 "group": "Voice_Extensions",
30275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30276 "version": "0.0.0",
30277 "filename": "server/api/voiceExtension/index.js",
30278 "groupTitle": "Voice_Extensions"
30282 "url": "/api/voice/mohs",
30283 "title": "Create a new a new MOH",
30286 "title": "Example usage:",
30287 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30292 "group": "Voice_MOHs",
30293 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30294 "version": "0.0.0",
30295 "filename": "server/api/voiceMusicOnHold/index.js",
30296 "groupTitle": "Voice_MOHs"
30300 "url": "/api/voice/mohs/{id}/sounds",
30301 "title": "Add sound to MOH",
30304 "title": "Example usage:",
30305 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30309 "name": "AddSound",
30310 "group": "Voice_MOHs",
30311 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30312 "version": "0.0.0",
30313 "filename": "server/api/voiceMusicOnHold/index.js",
30314 "groupTitle": "Voice_MOHs"
30318 "url": "/api/voice/mohs/{id}",
30319 "title": "Deletes an MOH",
30322 "title": "Example usage:",
30323 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30327 "name": "DestroyMoh",
30328 "group": "Voice_MOHs",
30329 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30330 "version": "0.0.0",
30331 "filename": "server/api/voiceMusicOnHold/index.js",
30332 "groupTitle": "Voice_MOHs"
30336 "url": "/api/voice/mohs",
30337 "title": "Gets a list of Music On Holds",
30340 "title": "Example usage:",
30341 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30345 "name": "GetMusic_On_Holds",
30346 "group": "Voice_MOHs",
30347 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30348 "version": "0.0.0",
30349 "filename": "server/api/voiceMusicOnHold/index.js",
30350 "groupTitle": "Voice_MOHs"
30354 "url": "/api/voice/mohs/{id}/sounds",
30355 "title": "Gets sounds from MOH",
30358 "title": "Example usage:",
30359 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30363 "name": "GetSounds",
30364 "group": "Voice_MOHs",
30365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30366 "version": "0.0.0",
30367 "filename": "server/api/voiceMusicOnHold/index.js",
30368 "groupTitle": "Voice_MOHs"
30372 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30373 "title": "Remove sound from MOH",
30376 "title": "Example usage:",
30377 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30381 "name": "RemoveSound",
30382 "group": "Voice_MOHs",
30383 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30384 "version": "0.0.0",
30385 "filename": "server/api/voiceMusicOnHold/index.js",
30386 "groupTitle": "Voice_MOHs"
30390 "url": "/api/voice/mohs/{id}",
30391 "title": "Gets a single Music On Hold",
30394 "title": "Example usage:",
30395 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30399 "name": "ShowMusic_On_Holds",
30400 "group": "Voice_MOHs",
30401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30402 "version": "0.0.0",
30403 "filename": "server/api/voiceMusicOnHold/index.js",
30404 "groupTitle": "Voice_MOHs"
30408 "url": "/api/voice/mohs/{id}",
30409 "title": "Update an existing Music On Hold",
30412 "title": "Example usage:",
30413 "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",
30417 "name": "updateMusic_On_Holds",
30418 "group": "Voice_MOHs",
30419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30420 "version": "0.0.0",
30421 "filename": "server/api/voiceMusicOnHold/index.js",
30422 "groupTitle": "Voice_MOHs"
30426 "url": "/api/voice/mails",
30427 "title": "Creates a new Mail",
30430 "title": "Example usage:",
30431 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30435 "name": "CreateMails",
30436 "group": "Voice_Mails",
30444 "field": "customer_id",
30451 "field": "context",
30458 "field": "mailbox",
30465 "field": "password",
30472 "field": "fullname",
30522 "field": "dialout",
30529 "field": "callback",
30551 "field": "operator",
30562 "field": "envelope",
30573 "field": "sayduration",
30580 "field": "saydurationm",
30591 "field": "sendvoicemail",
30613 "field": "nextaftercmd",
30624 "field": "forcename",
30635 "field": "forcegreetings",
30646 "field": "hidefromdir",
30660 "field": "emailsubject",
30667 "field": "emailbody",
30674 "field": "maxsecs",
30694 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30695 "version": "0.0.0",
30696 "filename": "server/api/voiceMail/index.js",
30697 "groupTitle": "Voice_Mails"
30701 "url": "/api/voice/mails/{id}",
30702 "title": "Deletes a Mail",
30705 "title": "Example usage:",
30706 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30710 "name": "DeleteMails",
30711 "group": "Voice_Mails",
30712 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30713 "version": "0.0.0",
30714 "filename": "server/api/voiceMail/index.js",
30715 "groupTitle": "Voice_Mails"
30719 "url": "/api/voice/mails",
30720 "title": "Gets a list of Mails",
30723 "title": "Example usage:",
30724 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30728 "name": "GetMails",
30729 "group": "Voice_Mails",
30730 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30731 "version": "0.0.0",
30732 "filename": "server/api/voiceMail/index.js",
30733 "groupTitle": "Voice_Mails"
30737 "url": "/api/voice/mails/{id}",
30738 "title": "Gets a single Mail",
30741 "title": "Example usage:",
30742 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30746 "name": "ShowMails",
30747 "group": "Voice_Mails",
30748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30749 "version": "0.0.0",
30750 "filename": "server/api/voiceMail/index.js",
30751 "groupTitle": "Voice_Mails"
30755 "url": "/api/voice/mails/{id}/messages",
30756 "title": "Gets voice mail messages",
30759 "title": "Example usage:",
30760 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30764 "name": "getMessages",
30765 "group": "Voice_Mails",
30766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30767 "version": "0.0.0",
30768 "filename": "server/api/voiceMail/index.js",
30769 "groupTitle": "Voice_Mails"
30773 "url": "/api/voice/mails/{id}",
30774 "title": "Update an existing Mail",
30777 "title": "Example usage:",
30778 "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",
30782 "name": "updateMails",
30783 "group": "Voice_Mails",
30784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30785 "version": "0.0.0",
30786 "filename": "server/api/voiceMail/index.js",
30787 "groupTitle": "Voice_Mails"
30791 "url": "/api/voice/mails/messages",
30792 "title": "Creates a new Message",
30795 "title": "Example usage:",
30796 "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",
30800 "name": "CreateMessages",
30801 "group": "Voice_Messages",
30830 "field": "context",
30837 "field": "macrocontext",
30844 "field": "callerid",
30851 "field": "origtime",
30858 "field": "duration",
30865 "field": "mailboxuser",
30872 "field": "mailboxcontext",
30879 "field": "recording",
30906 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30907 "version": "0.0.0",
30908 "filename": "server/api/voiceMailMessage/index.js",
30909 "groupTitle": "Voice_Messages"
30913 "url": "/api/voice/mails/messages/{id}",
30914 "title": "Deletes a Message",
30917 "title": "Example usage:",
30918 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
30922 "name": "DeleteMessages",
30923 "group": "Voice_Messages",
30924 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30925 "version": "0.0.0",
30926 "filename": "server/api/voiceMailMessage/index.js",
30927 "groupTitle": "Voice_Messages"
30931 "url": "/api/voice/mails/messages",
30932 "title": "Gets a list of Messages",
30935 "title": "Example usage:",
30936 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
30940 "name": "GetMessages",
30941 "group": "Voice_Messages",
30942 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30943 "version": "0.0.0",
30944 "filename": "server/api/voiceMailMessage/index.js",
30945 "groupTitle": "Voice_Messages"
30949 "url": "/api/voice/mails/messages/{id}",
30950 "title": "Gets a single Message",
30953 "title": "Example usage:",
30954 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
30958 "name": "ShowMessages",
30959 "group": "Voice_Messages",
30960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30961 "version": "0.0.0",
30962 "filename": "server/api/voiceMailMessage/index.js",
30963 "groupTitle": "Voice_Messages"
30967 "url": "voice/mails/messages/{id}/download",
30968 "title": "Download Voice Message",
30971 "title": "Example usage:",
30972 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
30976 "name": "download",
30977 "group": "Voice_Messages",
30978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30979 "version": "0.0.0",
30980 "filename": "server/api/voiceMailMessage/index.js",
30981 "groupTitle": "Voice_Messages"
30985 "url": "/api/voice/mails/messages/{id}",
30986 "title": "Update an existing Message",
30989 "title": "Example usage:",
30990 "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",
30994 "name": "updateMessages",
30995 "group": "Voice_Messages",
30996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30997 "version": "0.0.0",
30998 "filename": "server/api/voiceMailMessage/index.js",
30999 "groupTitle": "Voice_Messages"
31003 "url": "/api/voice/prefixes/{id}/users",
31004 "title": "Add agents to a prefix",
31007 "title": "Example usage:",
31008 "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",
31012 "name": "AddAgents",
31013 "group": "Voice_Prefixes",
31014 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31015 "version": "0.0.0",
31016 "filename": "server/api/voicePrefix/index.js",
31017 "groupTitle": "Voice_Prefixes"
31021 "url": "/api/voice/prefixes/{id}",
31022 "title": "Deletes a Prefix",
31025 "title": "Example usage:",
31026 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31030 "name": "DeletePrefixes",
31031 "group": "Voice_Prefixes",
31032 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31033 "version": "0.0.0",
31034 "filename": "server/api/voicePrefix/index.js",
31035 "groupTitle": "Voice_Prefixes"
31039 "url": "/api/voice/prefixes/describe",
31040 "title": "Gets table info about Prefixes",
31043 "title": "Example usage:",
31044 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31048 "name": "DescribePrefixes",
31049 "group": "Voice_Prefixes",
31050 "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>",
31051 "version": "0.0.0",
31052 "filename": "server/api/voicePrefix/index.js",
31053 "groupTitle": "Voice_Prefixes"
31057 "url": "/api/voice/prefixes/{id}/users",
31058 "title": "Gets agents from prefix",
31061 "title": "Example usage:",
31062 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31066 "name": "GetAgents",
31067 "group": "Voice_Prefixes",
31068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31069 "version": "0.0.0",
31070 "filename": "server/api/voicePrefix/index.js",
31071 "groupTitle": "Voice_Prefixes"
31075 "url": "/api/voice/prefixes",
31076 "title": "Gets a list of Prefixes",
31079 "title": "Example usage:",
31080 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31084 "name": "GetPrefixes",
31085 "group": "Voice_Prefixes",
31086 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31087 "version": "0.0.0",
31088 "filename": "server/api/voicePrefix/index.js",
31089 "groupTitle": "Voice_Prefixes"
31093 "url": "/api/voice/prefixes/{id}/users",
31094 "title": "Removes agents from a prefix",
31097 "title": "Example usage:",
31098 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31102 "name": "RemoveAgents",
31103 "group": "Voice_Prefixes",
31104 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31105 "version": "0.0.0",
31106 "filename": "server/api/voicePrefix/index.js",
31107 "groupTitle": "Voice_Prefixes"
31111 "url": "/api/voice/prefixes/{id}",
31112 "title": "Gets a single Prefix",
31115 "title": "Example usage:",
31116 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31120 "name": "ShowPrefixes",
31121 "group": "Voice_Prefixes",
31122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31123 "version": "0.0.0",
31124 "filename": "server/api/voicePrefix/index.js",
31125 "groupTitle": "Voice_Prefixes"
31129 "url": "/api/voice/prefixes/{id}",
31130 "title": "Update an existing prefix",
31133 "title": "Example usage:",
31134 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31139 "group": "Voice_Prefixes",
31140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31141 "version": "0.0.0",
31142 "filename": "server/api/voicePrefix/index.js",
31143 "groupTitle": "Voice_Prefixes"
31147 "url": "/api/voice/prefixes",
31148 "title": "Create a prefix",
31151 "title": "Example usage:",
31152 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31157 "group": "Voice_Prefixes",
31158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31159 "version": "0.0.0",
31160 "filename": "server/api/voicePrefix/index.js",
31161 "groupTitle": "Voice_Prefixes"
31165 "url": "/api/voice/queues/reports/describe",
31166 "title": "Gets table info about Queue Reports",
31169 "title": "Example usage:",
31170 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31174 "name": "DescribeQueue_Reports",
31175 "group": "Voice_Queue_Reports",
31176 "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>",
31177 "version": "0.0.0",
31178 "filename": "server/api/voiceQueueReport/index.js",
31179 "groupTitle": "Voice_Queue_Reports"
31183 "url": "/api/voice/queues/reports",
31184 "title": "Gets a list of Queue Reports",
31187 "title": "Example usage:",
31188 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31192 "name": "GetQueue_Reports",
31193 "group": "Voice_Queue_Reports",
31194 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31195 "version": "0.0.0",
31196 "filename": "server/api/voiceQueueReport/index.js",
31197 "groupTitle": "Voice_Queue_Reports"
31201 "url": "/api/voice/queues/reports/{id}",
31202 "title": "Gets a single Queue Report",
31205 "title": "Example usage:",
31206 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31210 "name": "ShowQueue_Reports",
31211 "group": "Voice_Queue_Reports",
31212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31213 "version": "0.0.0",
31214 "filename": "server/api/voiceQueueReport/index.js",
31215 "groupTitle": "Voice_Queue_Reports"
31219 "url": "/api/voice/queues/reports/index",
31220 "title": "Get Voice Queues Report",
31223 "title": "Example usage:",
31224 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31228 "name": "getVoiceQueuesReport",
31229 "group": "Voice_Queue_Reports",
31230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31231 "version": "0.0.0",
31232 "filename": "server/api/voiceQueueReport/index.js",
31233 "groupTitle": "Voice_Queue_Reports"
31237 "url": "/api/voice/queues/{id}/users",
31238 "title": "Add agents to queue",
31241 "title": "Example usage:",
31242 "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",
31246 "name": "AddAgents",
31247 "group": "Voice_Queues",
31248 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31249 "version": "0.0.0",
31250 "filename": "server/api/voiceQueue/index.js",
31251 "groupTitle": "Voice_Queues"
31255 "url": "/api/voice/queues/{id}/blacklists",
31256 "title": "Add blacklists to a queue",
31259 "title": "Example usage:",
31260 "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",
31264 "name": "AddBlackLists",
31265 "group": "Voice_Queues",
31266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31267 "version": "0.0.0",
31268 "filename": "server/api/voiceQueue/index.js",
31269 "groupTitle": "Voice_Queues"
31273 "url": "/api/voice/queues/{id}/lists",
31274 "title": "Add lists to a queue",
31277 "title": "Example usage:",
31278 "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",
31282 "name": "AddLists",
31283 "group": "Voice_Queues",
31284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31285 "version": "0.0.0",
31286 "filename": "server/api/voiceQueue/index.js",
31287 "groupTitle": "Voice_Queues"
31291 "url": "/api/voice/queues/{id}/teams",
31292 "title": "Add teams to queue",
31295 "title": "Example usage:",
31296 "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",
31300 "name": "AddTeams",
31301 "group": "Voice_Queues",
31302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31303 "version": "0.0.0",
31304 "filename": "server/api/voiceQueue/index.js",
31305 "groupTitle": "Voice_Queues"
31309 "url": "/api/voice/queues/clone",
31310 "title": "Clone an existing Queue",
31313 "title": "Example usage:",
31314 "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",
31318 "name": "CloneQueues",
31319 "group": "Voice_Queues",
31320 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31321 "version": "0.0.0",
31322 "filename": "server/api/voiceQueue/index.js",
31323 "groupTitle": "Voice_Queues"
31327 "url": "/api/voice/queues",
31328 "title": "Creates a new Queue",
31331 "title": "Example usage:",
31332 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31336 "name": "CreateQueues",
31337 "group": "Voice_Queues",
31363 "field": "musiconhold",
31370 "field": "announce",
31388 "field": "strategy",
31395 "field": "servicelevel",
31402 "field": "context",
31409 "field": "penaltymemberslimit",
31416 "field": "timeout",
31430 "field": "timeoutpriority",
31444 "field": "wrapuptime",
31455 "field": "autofill",
31467 "field": "autopause",
31474 "field": "autopausedelay",
31485 "field": "autopausebusy",
31496 "field": "autopauseunavail",
31514 "field": "setinterfacevar",
31525 "field": "setqueueentryvar",
31536 "field": "setqueuevar",
31547 "field": "eventmemberstatus",
31554 "field": "membermacro",
31561 "field": "membergosub",
31568 "field": "announce_frequency",
31575 "field": "min_announce_frequency",
31582 "field": "periodic_announce_frequency",
31593 "field": "random_periodic_announce",
31604 "field": "relative_periodic_announce",
31616 "field": "announce_holdtime",
31623 "field": "announce_position",
31634 "field": "announce_to_first_user",
31641 "field": "announce_position_limit",
31656 "field": "announce_round_seconds",
31663 "field": "monitor_format",
31670 "field": "monitor_type",
31677 "field": "queue_youarenext",
31684 "field": "queue_thereare",
31691 "field": "queue_callswaiting",
31698 "field": "queue_holdtime",
31705 "field": "queue_minute",
31712 "field": "queue_minutes",
31719 "field": "queue_seconds",
31726 "field": "queue_thankyou",
31733 "field": "queue_reporthold",
31740 "field": "queue_quantity1",
31747 "field": "queue_quantity2",
31754 "field": "queue_periodic_announce",
31761 "field": "queue_less_than",
31768 "field": "periodic_announce",
31775 "field": "joinempty",
31782 "field": "leavewhenempty",
31793 "field": "reportholdtime",
31804 "field": "ringinuse",
31811 "field": "memberdelay",
31822 "field": "timeoutrestart",
31829 "field": "defaultrule",
31836 "field": "description",
31850 "field": "acwTimeout",
31857 "field": "dialActive",
31858 "description": "<p>Active/Disactive Campaign</p>"
31871 "field": "dialMethod",
31872 "description": "<p>Dial Method.</p>"
31878 "field": "dialLimitChannel",
31879 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
31885 "field": "dialLimitQueue",
31886 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
31892 "field": "dialPowerLevel",
31893 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
31899 "\"agentBusyFactor\"",
31903 "field": "dialPredictiveOptimization",
31904 "description": "<p>Only for predictive method.</p>"
31910 "field": "dialPredictiveOptimizationPercentage",
31911 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
31917 "field": "dialPredictiveInterval",
31918 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
31924 "field": "dialOriginateCallerIdName",
31931 "field": "dialOriginateCallerIdNumber",
31938 "field": "dialOriginateTimeout",
31939 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
31945 "field": "dialQueueOptions",
31946 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
31952 "field": "dialQueueTimeout",
31953 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
31959 "field": "dialQueueProject",
31960 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
31966 "field": "dialCongestionMaxRetry",
31967 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
31973 "field": "dialCongestionRetryFrequency",
31974 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
31980 "field": "dialBusyMaxRetry",
31981 "description": "<p>#Busy Retry (min:1, max:999)</p>"
31987 "field": "dialBusyRetryFrequency",
31988 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
31994 "field": "dialNoAnswerMaxRetry",
31995 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32001 "field": "dialNoAnswerRetryFrequency",
32002 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32008 "field": "dialGlobalMaxRetry",
32009 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32015 "field": "dialTimezone",
32022 "field": "dialGlobalInterval",
32029 "field": "dialPrefix",
32041 "field": "dialCheckDuplicateType",
32048 "field": "dialAMDActive",
32049 "description": "<p>Active/Disactive AMD</p>"
32055 "field": "dialAMDInitialSilence",
32056 "description": "<p>#AMD Initial Silence</p>"
32062 "field": "dialAMDGreeting",
32063 "description": "<p>#AMD Greeting</p>"
32069 "field": "dialAMDAfterGreetingSilence",
32070 "description": "<p>#AMD After Greeting Silence</p>"
32076 "field": "dialAMDTotalAnalysisTime",
32077 "description": "<p>#AMD Total Analysis Time</p>"
32083 "field": "dialAMDMinWordLength",
32084 "description": "<p>#AMD Min Word Length</p>"
32090 "field": "dialAMDBetweenWordsSilence",
32091 "description": "<p>#AMD Between Words Silence</p>"
32097 "field": "dialAMDMaximumNumberOfWords",
32098 "description": "<p>#AMD Maximum Number Of Words</p>"
32104 "field": "dialAMDSilenceThreshold",
32105 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32111 "field": "dialAMDMaximumWordLength",
32112 "description": "<p>#AMD Maximum Word Length</p>"
32118 "field": "dialRecallMeTimeout",
32119 "description": "<p>#RecallMe Timeout (min:1)</p>"
32125 "field": "dialRecallInQueue",
32126 "description": "<p>Active/Disactive Recall In Queue</p>"
32136 "field": "dialOrderByScheduledAt",
32143 "field": "dialQueueProject2",
32144 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32150 "field": "dialAgiAfterHangupClient",
32157 "field": "dialAgiAfterHangupAgent",
32164 "field": "dialRandomLastDigitCallerIdNumber",
32165 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32171 "field": "dialCutDigit",
32172 "description": "<p>Cut Digit (min:1, max:15)</p>"
32178 "field": "dialNoSuchNumberMaxRetry",
32179 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32185 "field": "dialNoSuchNumberRetryFrequency",
32186 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32192 "field": "dialDropMaxRetry",
32193 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32199 "field": "dialDropRetryFrequency",
32200 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32206 "field": "dialAbandonedMaxRetry",
32207 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32213 "field": "dialAbandonedRetryFrequency",
32214 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32220 "field": "dialMachineMaxRetry",
32221 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32227 "field": "dialMachineRetryFrequency",
32228 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32234 "field": "dialAgentRejectMaxRetry",
32235 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32241 "field": "dialAgentRejectRetryFrequency",
32242 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32248 "field": "mandatoryDispositionPauseId",
32249 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32255 "field": "mandatoryDisposition",
32256 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32262 "field": "dialPredictiveIntervalMaxThreshold",
32269 "field": "dialPredictiveIntervalMinThreshold",
32275 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32276 "version": "0.0.0",
32277 "filename": "server/api/voiceQueue/index.js",
32278 "groupTitle": "Voice_Queues"
32282 "url": "/api/voice/queues/{id}",
32283 "title": "Deletes a Queue",
32286 "title": "Example usage:",
32287 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32291 "name": "DeleteQueues",
32292 "group": "Voice_Queues",
32293 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32294 "version": "0.0.0",
32295 "filename": "server/api/voiceQueue/index.js",
32296 "groupTitle": "Voice_Queues"
32300 "url": "/api/voice/queues/{id}/users",
32301 "title": "Gets queue agents",
32304 "title": "Example usage:",
32305 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32309 "name": "GetAgents",
32310 "group": "Voice_Queues",
32311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32312 "version": "0.0.0",
32313 "filename": "server/api/voiceQueue/index.js",
32314 "groupTitle": "Voice_Queues"
32318 "url": "/api/voice/queues/{id}/blacklists",
32319 "title": "Get queue blacklists",
32322 "title": "Example usage:",
32323 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32327 "name": "GetBlackLists",
32328 "group": "Voice_Queues",
32329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32330 "version": "0.0.0",
32331 "filename": "server/api/voiceQueue/index.js",
32332 "groupTitle": "Voice_Queues"
32336 "url": "/api/voice/queues/{id}/finals",
32337 "title": "Gets queue hopper finals",
32340 "title": "Example usage:",
32341 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32345 "name": "GetHopperFinals",
32346 "group": "Voice_Queues",
32347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32348 "version": "0.0.0",
32349 "filename": "server/api/voiceQueue/index.js",
32350 "groupTitle": "Voice_Queues"
32354 "url": "/api/voice/queues/{id}/hopper_histories",
32355 "title": "Gets queue hopper histories",
32358 "title": "Example usage:",
32359 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32363 "name": "GetHopperHistories",
32364 "group": "Voice_Queues",
32365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32366 "version": "0.0.0",
32367 "filename": "server/api/voiceQueue/index.js",
32368 "groupTitle": "Voice_Queues"
32372 "url": "/api/voice/queues/{id}/hoppers",
32373 "title": "Gets queue hoppers",
32376 "title": "Example usage:",
32377 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32381 "name": "GetHoppers",
32382 "group": "Voice_Queues",
32383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32384 "version": "0.0.0",
32385 "filename": "server/api/voiceQueue/index.js",
32386 "groupTitle": "Voice_Queues"
32390 "url": "/api/voice/queues/{id}/lists",
32391 "title": "Get queue lists",
32394 "title": "Example usage:",
32395 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32399 "name": "GetLists",
32400 "group": "Voice_Queues",
32401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32402 "version": "0.0.0",
32403 "filename": "server/api/voiceQueue/index.js",
32404 "groupTitle": "Voice_Queues"
32408 "url": "/api/voice/queues/{id}/members",
32409 "title": "Gets queue members",
32412 "title": "Example usage:",
32413 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32417 "name": "GetMembers",
32418 "group": "Voice_Queues",
32419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32420 "version": "0.0.0",
32421 "filename": "server/api/voiceQueue/index.js",
32422 "groupTitle": "Voice_Queues"
32426 "url": "/api/voice/queues",
32427 "title": "Gets a list of Queues",
32430 "title": "Example usage:",
32431 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32435 "name": "GetQueues",
32436 "group": "Voice_Queues",
32437 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32438 "version": "0.0.0",
32439 "filename": "server/api/voiceQueue/index.js",
32440 "groupTitle": "Voice_Queues"
32444 "url": "/api/voice/queues/{id}/teams",
32445 "title": "Gets queue team",
32448 "title": "Example usage:",
32449 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32453 "name": "GetTeams",
32454 "group": "Voice_Queues",
32455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32456 "version": "0.0.0",
32457 "filename": "server/api/voiceQueue/index.js",
32458 "groupTitle": "Voice_Queues"
32462 "url": "/api/voice/queues/{id}/users",
32463 "title": "Removes agents from a queue",
32466 "title": "Example usage:",
32467 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32471 "name": "RemoveAgents",
32472 "group": "Voice_Queues",
32473 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32474 "version": "0.0.0",
32475 "filename": "server/api/voiceQueue/index.js",
32476 "groupTitle": "Voice_Queues"
32480 "url": "/api/voice/queues/{id}/blacklists",
32481 "title": "Remove blacklists from a queue",
32484 "title": "Example usage:",
32485 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32489 "name": "RemoveBlackLists",
32490 "group": "Voice_Queues",
32491 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32492 "version": "0.0.0",
32493 "filename": "server/api/voiceQueue/index.js",
32494 "groupTitle": "Voice_Queues"
32498 "url": "/api/voice/queues/{id}/lists",
32499 "title": "Remove lists from a queue",
32502 "title": "Example usage:",
32503 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32507 "name": "RemoveLists",
32508 "group": "Voice_Queues",
32509 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32510 "version": "0.0.0",
32511 "filename": "server/api/voiceQueue/index.js",
32512 "groupTitle": "Voice_Queues"
32516 "url": "/api/voice/queues/{id}",
32517 "title": "Gets a single Queue",
32520 "title": "Example usage:",
32521 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32525 "name": "ShowQueues",
32526 "group": "Voice_Queues",
32527 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32528 "version": "0.0.0",
32529 "filename": "server/api/voiceQueue/index.js",
32530 "groupTitle": "Voice_Queues"
32534 "url": "/api/voice/queues/{id}/blacks",
32535 "title": "Gets queue hopper blacks",
32538 "title": "Example usage:",
32539 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
32543 "name": "getHopperBlacks",
32544 "group": "Voice_Queues",
32545 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32546 "version": "0.0.0",
32547 "filename": "server/api/voiceQueue/index.js",
32548 "groupTitle": "Voice_Queues"
32552 "url": "/api/voice/queues/{id}",
32553 "title": "Update an existing Queue",
32556 "title": "Example usage:",
32557 "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",
32561 "name": "updateQueues",
32562 "group": "Voice_Queues",
32563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32564 "version": "0.0.0",
32565 "filename": "server/api/voiceQueue/index.js",
32566 "groupTitle": "Voice_Queues"
32570 "url": "/api/voice/recordings",
32571 "title": "Creates a new Recording",
32574 "title": "Example usage:",
32575 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32579 "name": "CreateRecordings",
32580 "group": "Voice_Recordings",
32595 "field": "uniqueid",
32602 "field": "channel",
32609 "field": "membername",
32616 "field": "calleridnum",
32623 "field": "calleridname",
32630 "field": "connectedlinenum",
32637 "field": "connectedlinename",
32644 "field": "accountcode",
32651 "field": "context",
32693 "field": "userDisposition",
32700 "field": "userSecondDisposition",
32707 "field": "userThirdDisposition",
32714 "field": "location",
32721 "field": "transcribeName",
32728 "field": "transcribeStatus",
32735 "field": "fileUri",
32742 "field": "fileText",
32749 "field": "failureReason",
32756 "field": "sentiment",
32763 "field": "sPositive",
32770 "field": "sNegative",
32777 "field": "sNeutral",
32791 "field": "tempSentiment",
32798 "field": "createdAt",
32805 "field": "updatedAt",
32811 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32812 "version": "0.0.0",
32813 "filename": "server/api/voiceRecording/index.js",
32814 "groupTitle": "Voice_Recordings"
32818 "url": "/api/voice/recordings/describe",
32819 "title": "Gets table info about Recordings",
32822 "title": "Example usage:",
32823 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
32827 "name": "DescribeRecordings",
32828 "group": "Voice_Recordings",
32829 "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>",
32830 "version": "0.0.0",
32831 "filename": "server/api/voiceRecording/index.js",
32832 "groupTitle": "Voice_Recordings"
32836 "url": "/api/voice/recordings",
32837 "title": "Gets a list of Recordings",
32840 "title": "Example usage:",
32841 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
32845 "name": "GetRecordings",
32846 "group": "Voice_Recordings",
32847 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32848 "version": "0.0.0",
32849 "filename": "server/api/voiceRecording/index.js",
32850 "groupTitle": "Voice_Recordings"
32854 "url": "/api/voice/recordings/{id}",
32855 "title": "Gets a single Recording",
32858 "title": "Example usage:",
32859 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
32863 "name": "ShowRecordings",
32864 "group": "Voice_Recordings",
32865 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32866 "version": "0.0.0",
32867 "filename": "server/api/voiceRecording/index.js",
32868 "groupTitle": "Voice_Recordings"
32872 "url": "/api/voice/recordings/{id}",
32873 "title": "Delete voice recording",
32876 "title": "Example usage:",
32877 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
32882 "group": "Voice_Recordings",
32883 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32884 "version": "0.0.0",
32885 "filename": "server/api/voiceRecording/index.js",
32886 "groupTitle": "Voice_Recordings"
32890 "url": "/api/voice/recordings/{id}/download",
32891 "title": "Download Recording",
32894 "title": "Example usage:",
32895 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
32899 "name": "download",
32900 "group": "Voice_Recordings",
32901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32902 "version": "0.0.0",
32903 "filename": "server/api/voiceRecording/index.js",
32904 "groupTitle": "Voice_Recordings"
32908 "url": "/api/voice/recordings/{id}/downloads",
32909 "title": "Download Recording",
32912 "title": "Example usage:",
32913 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
32917 "name": "downloads",
32918 "group": "Voice_Recordings",
32919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32920 "version": "0.0.0",
32921 "filename": "server/api/voiceRecording/index.js",
32922 "groupTitle": "Voice_Recordings"
32926 "url": "/api/voice/recordings/{id}/transcribe",
32927 "title": "Run Transcribe Recording",
32930 "title": "Example usage:",
32931 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
32935 "name": "transcribe",
32936 "group": "Voice_Recordings",
32937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32938 "version": "0.0.0",
32939 "filename": "server/api/voiceRecording/index.js",
32940 "groupTitle": "Voice_Recordings"
32944 "url": "/api/voice/recordings/{id}/transcribe",
32945 "title": "Run Transcribe Recording",
32948 "title": "Example usage:",
32949 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
32953 "name": "transcribe",
32954 "group": "Voice_Recordings",
32955 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32956 "version": "0.0.0",
32957 "filename": "server/api/voiceRecording/index.js",
32958 "groupTitle": "Voice_Recordings"
32962 "url": "/api/voice/recordings/{id}",
32963 "title": "Update an existing Recording",
32966 "title": "Example usage:",
32967 "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",
32971 "name": "updateRecordings",
32972 "group": "Voice_Recordings",
32973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32974 "version": "0.0.0",
32975 "filename": "server/api/voiceRecording/index.js",
32976 "groupTitle": "Voice_Recordings"
32980 "url": "/api/voice/transfers/reports",
32981 "title": "Creates a new Transfer Report",
32984 "title": "Example usage:",
32985 "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",
32989 "name": "CreateTransfer_Reports",
32990 "group": "Voice_Transfer_Reports",
33016 "field": "transfererchannel",
33023 "field": "transferercalleridnum",
33030 "field": "transferercalleridname",
33037 "field": "transfererconnectedlinenum",
33044 "field": "transfererconnectedlinename",
33051 "field": "transfereraccountcode",
33058 "field": "transferercontext",
33065 "field": "transfererexten",
33072 "field": "transfererlinkedid",
33079 "field": "transfereechannel",
33086 "field": "transfereecalleridnum",
33093 "field": "transfereecalleridname",
33100 "field": "transfereeconnectedlinenum",
33107 "field": "transfereeconnectedlinename",
33114 "field": "transfereeaccountcode",
33121 "field": "transfereecontext",
33128 "field": "transfereeexten",
33135 "field": "transfereelinkedid",
33146 "field": "isexternal",
33153 "field": "context",
33160 "field": "extension",
33166 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33167 "version": "0.0.0",
33168 "filename": "server/api/voiceTransferReport/index.js",
33169 "groupTitle": "Voice_Transfer_Reports"
33173 "url": "/api/voice/transfers/reports/{id}",
33174 "title": "Deletes a Transfer Report",
33177 "title": "Example usage:",
33178 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33182 "name": "DeleteTransfer_Reports",
33183 "group": "Voice_Transfer_Reports",
33184 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33185 "version": "0.0.0",
33186 "filename": "server/api/voiceTransferReport/index.js",
33187 "groupTitle": "Voice_Transfer_Reports"
33191 "url": "/api/voice/transfers/reports",
33192 "title": "Gets a list of Transfer Reports",
33195 "title": "Example usage:",
33196 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33200 "name": "GetTransfer_Reports",
33201 "group": "Voice_Transfer_Reports",
33202 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33203 "version": "0.0.0",
33204 "filename": "server/api/voiceTransferReport/index.js",
33205 "groupTitle": "Voice_Transfer_Reports"
33209 "url": "/api/voice/transfers/reports/{id}",
33210 "title": "Gets a single Transfer Report",
33213 "title": "Example usage:",
33214 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33218 "name": "ShowTransfer_Reports",
33219 "group": "Voice_Transfer_Reports",
33220 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33221 "version": "0.0.0",
33222 "filename": "server/api/voiceTransferReport/index.js",
33223 "groupTitle": "Voice_Transfer_Reports"
33227 "url": "/api/voice/transfers/reports/{id}",
33228 "title": "Update an existing Transfer Report",
33231 "title": "Example usage:",
33232 "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",
33236 "name": "updateTransfer_Reports",
33237 "group": "Voice_Transfer_Reports",
33238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33239 "version": "0.0.0",
33240 "filename": "server/api/voiceTransferReport/index.js",
33241 "groupTitle": "Voice_Transfer_Reports"
33245 "url": "/api/integrations/vtiger/accounts",
33246 "title": "Creates a new Vtiger Account",
33249 "title": "Example usage:",
33250 "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",
33254 "name": "CreateVtiger_Accounts",
33255 "group": "Vtiger_Accounts",
33270 "field": "description",
33277 "field": "username",
33284 "field": "moduleName",
33291 "field": "remoteUri",
33298 "field": "serverUrl",
33305 "field": "accessKey",
33311 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33312 "version": "0.0.0",
33313 "filename": "server/api/intVtigerAccount/index.js",
33314 "groupTitle": "Vtiger_Accounts"
33318 "url": "/api/integrations/vtiger/accounts/{id}",
33319 "title": "Deletes a Vtiger Account",
33322 "title": "Example usage:",
33323 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33327 "name": "DeleteVtiger_Accounts",
33328 "group": "Vtiger_Accounts",
33329 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33330 "version": "0.0.0",
33331 "filename": "server/api/intVtigerAccount/index.js",
33332 "groupTitle": "Vtiger_Accounts"
33336 "url": "/api/integrations/vtiger/accounts",
33337 "title": "Gets a list of Vtiger Accounts",
33340 "title": "Example usage:",
33341 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33345 "name": "GetVtiger_Accounts",
33346 "group": "Vtiger_Accounts",
33347 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33348 "version": "0.0.0",
33349 "filename": "server/api/intVtigerAccount/index.js",
33350 "groupTitle": "Vtiger_Accounts"
33354 "url": "/api/integrations/vtiger/accounts/{id}",
33355 "title": "Gets a single Vtiger Account",
33358 "title": "Example usage:",
33359 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33363 "name": "ShowVtiger_Accounts",
33364 "group": "Vtiger_Accounts",
33365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33366 "version": "0.0.0",
33367 "filename": "server/api/intVtigerAccount/index.js",
33368 "groupTitle": "Vtiger_Accounts"
33372 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33373 "title": "Creates new configuration",
33376 "title": "Example usage:",
33377 "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",
33381 "name": "addConfiguration",
33382 "group": "Vtiger_Accounts",
33383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33384 "version": "0.0.0",
33385 "filename": "server/api/intVtigerAccount/index.js",
33386 "groupTitle": "Vtiger_Accounts"
33390 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33391 "title": "Gets account configurations",
33394 "title": "Example usage:",
33395 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33399 "name": "getConfigurations",
33400 "group": "Vtiger_Accounts",
33401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33402 "version": "0.0.0",
33403 "filename": "server/api/intVtigerAccount/index.js",
33404 "groupTitle": "Vtiger_Accounts"
33408 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33409 "title": "Gets account fields",
33412 "title": "Example usage:",
33413 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33417 "name": "getFields",
33418 "group": "Vtiger_Accounts",
33419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33420 "version": "0.0.0",
33421 "filename": "server/api/intVtigerAccount/index.js",
33422 "groupTitle": "Vtiger_Accounts"
33426 "url": "/api/integrations/vtiger/accounts/{id}",
33427 "title": "Update an existing Vtiger Account",
33430 "title": "Example usage:",
33431 "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",
33435 "name": "updateVtiger_Accounts",
33436 "group": "Vtiger_Accounts",
33437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33438 "version": "0.0.0",
33439 "filename": "server/api/intVtigerAccount/index.js",
33440 "groupTitle": "Vtiger_Accounts"
33444 "url": "/api/integrations/vtiger/configurations",
33445 "title": "Creates a new Vtiger Configuration",
33448 "title": "Example usage:",
33449 "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",
33453 "name": "CreateVtiger_Configurations",
33454 "group": "Vtiger_Configurations",
33469 "field": "description",
33475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33476 "version": "0.0.0",
33477 "filename": "server/api/intVtigerConfiguration/index.js",
33478 "groupTitle": "Vtiger_Configurations"
33482 "url": "/api/integrations/vtiger/configurations/{id}",
33483 "title": "Deletes a Vtiger Configuration",
33486 "title": "Example usage:",
33487 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33491 "name": "DeleteVtiger_Configurations",
33492 "group": "Vtiger_Configurations",
33493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33494 "version": "0.0.0",
33495 "filename": "server/api/intVtigerConfiguration/index.js",
33496 "groupTitle": "Vtiger_Configurations"
33500 "url": "/api/integrations/vtiger/configurations",
33501 "title": "Gets a list of Vtiger Configurations",
33504 "title": "Example usage:",
33505 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33509 "name": "GetVtiger_Configurations",
33510 "group": "Vtiger_Configurations",
33511 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33512 "version": "0.0.0",
33513 "filename": "server/api/intVtigerConfiguration/index.js",
33514 "groupTitle": "Vtiger_Configurations"
33518 "url": "/api/integrations/vtiger/configurations/{id}",
33519 "title": "Gets a single Vtiger Configuration",
33522 "title": "Example usage:",
33523 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33527 "name": "ShowVtiger_Configurations",
33528 "group": "Vtiger_Configurations",
33529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33530 "version": "0.0.0",
33531 "filename": "server/api/intVtigerConfiguration/index.js",
33532 "groupTitle": "Vtiger_Configurations"
33536 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33537 "title": "Gets configurations descriptions",
33540 "title": "Example usage:",
33541 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33545 "name": "getDescriptions",
33546 "group": "Vtiger_Configurations",
33547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33548 "version": "0.0.0",
33549 "filename": "server/api/intVtigerConfiguration/index.js",
33550 "groupTitle": "Vtiger_Configurations"
33554 "url": "/api/integrations/vtiger/configurations/{id}/fields",
33555 "title": "Gets configurations fields",
33558 "title": "Example usage:",
33559 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33563 "name": "getFields",
33564 "group": "Vtiger_Configurations",
33565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33566 "version": "0.0.0",
33567 "filename": "server/api/intVtigerConfiguration/index.js",
33568 "groupTitle": "Vtiger_Configurations"
33572 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33573 "title": "Gets configurations subjects",
33576 "title": "Example usage:",
33577 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33581 "name": "getSubjects",
33582 "group": "Vtiger_Configurations",
33583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33584 "version": "0.0.0",
33585 "filename": "server/api/intVtigerConfiguration/index.js",
33586 "groupTitle": "Vtiger_Configurations"
33590 "url": "/api/integrations/vtiger/configurations/{id}",
33591 "title": "Update an existing Vtiger Configuration",
33594 "title": "Example usage:",
33595 "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",
33599 "name": "updateVtiger_Configurations",
33600 "group": "Vtiger_Configurations",
33601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33602 "version": "0.0.0",
33603 "filename": "server/api/intVtigerConfiguration/index.js",
33604 "groupTitle": "Vtiger_Configurations"
33608 "url": "/api/integrations/vtiger/fields",
33609 "title": "Creates a new Vtiger Field",
33612 "title": "Example usage:",
33613 "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",
33617 "name": "CreateVtiger_Fields",
33618 "group": "Vtiger_Fields",
33628 "\"customVariable\"",
33639 "field": "content",
33655 "\"customVariable\""
33658 "field": "keyType",
33665 "field": "keyContent",
33672 "field": "idField",
33679 "field": "nameField",
33686 "field": "customField",
33693 "field": "variableName",
33699 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33700 "version": "0.0.0",
33701 "filename": "server/api/intVtigerField/index.js",
33702 "groupTitle": "Vtiger_Fields"
33706 "url": "/api/integrations/vtiger/fields/{id}",
33707 "title": "Deletes a Vtiger Field",
33710 "title": "Example usage:",
33711 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33715 "name": "DeleteVtiger_Fields",
33716 "group": "Vtiger_Fields",
33717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33718 "version": "0.0.0",
33719 "filename": "server/api/intVtigerField/index.js",
33720 "groupTitle": "Vtiger_Fields"
33724 "url": "/api/integrations/vtiger/fields",
33725 "title": "Gets a list of Vtiger Fields",
33728 "title": "Example usage:",
33729 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33733 "name": "GetVtiger_Fields",
33734 "group": "Vtiger_Fields",
33735 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33736 "version": "0.0.0",
33737 "filename": "server/api/intVtigerField/index.js",
33738 "groupTitle": "Vtiger_Fields"
33742 "url": "/api/integrations/vtiger/fields/{id}",
33743 "title": "Gets a single Vtiger Field",
33746 "title": "Example usage:",
33747 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33751 "name": "ShowVtiger_Fields",
33752 "group": "Vtiger_Fields",
33753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33754 "version": "0.0.0",
33755 "filename": "server/api/intVtigerField/index.js",
33756 "groupTitle": "Vtiger_Fields"
33760 "url": "/api/integrations/vtiger/fields/{id}",
33761 "title": "Update an existing Vtiger Field",
33764 "title": "Example usage:",
33765 "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",
33769 "name": "updateVtiger_Fields",
33770 "group": "Vtiger_Fields",
33771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33772 "version": "0.0.0",
33773 "filename": "server/api/intVtigerField/index.js",
33774 "groupTitle": "Vtiger_Fields"
33778 "url": "/api/webbar/answer",
33779 "title": "answer webrtc call",
33782 "title": "Example usage:",
33783 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33787 "name": "Web_Bar_answer",
33796 "field": "sessionId",
33809 "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>",
33810 "version": "0.0.0",
33811 "filename": "server/api/webbar/index.js",
33812 "groupTitle": "WebBar"
33816 "url": "/api/webbar/calls",
33817 "title": "webrtc call list",
33820 "title": "Example usage:",
33821 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33825 "name": "Web_Bar_calls",
33840 "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>",
33841 "version": "0.0.0",
33842 "filename": "server/api/webbar/index.js",
33843 "groupTitle": "WebBar"
33847 "url": "/api/webbar/hangup",
33848 "title": "hangup webrtc call",
33851 "title": "Example usage:",
33852 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33856 "name": "Web_Bar_hangup",
33865 "field": "sessionId",
33878 "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>",
33879 "version": "0.0.0",
33880 "filename": "server/api/webbar/index.js",
33881 "groupTitle": "WebBar"
33885 "url": "/api/webbar/unhold",
33886 "title": "unhold webrtc call",
33889 "title": "Example usage:",
33890 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33894 "name": "Web_Bar_hold",
33903 "field": "sessionId",
33916 "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>",
33917 "version": "0.0.0",
33918 "filename": "server/api/webbar/index.js",
33919 "groupTitle": "WebBar"
33923 "url": "/api/webbar/hold",
33924 "title": "hold webrtc call",
33927 "title": "Example usage:",
33928 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33932 "name": "Web_Bar_hold",
33941 "field": "sessionId",
33954 "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>",
33955 "version": "0.0.0",
33956 "filename": "server/api/webbar/index.js",
33957 "groupTitle": "WebBar"
33961 "url": "/api/webbar/originate",
33962 "title": "Originate new webrtc call",
33965 "title": "Example usage:",
33966 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33970 "name": "Web_Bar_originate",
33979 "field": "callNumber",
33993 "field": "callerId",
34000 "field": "callbackUrl",
34006 "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>",
34007 "version": "0.0.0",
34008 "filename": "server/api/webbar/index.js",
34009 "groupTitle": "WebBar"
34013 "url": "/api/webbar/transfer",
34014 "title": "blind transfer webrtc call",
34017 "title": "Example usage:",
34018 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34022 "name": "Web_Bar_transfer",
34038 "field": "sessionId",
34045 "field": "transferNumber",
34051 "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>",
34052 "version": "0.0.0",
34053 "filename": "server/api/webbar/index.js",
34054 "groupTitle": "WebBar"
34058 "url": "/api/whatsapp/accounts/{id}/users",
34059 "title": "Add agents to a whatsapp account",
34062 "title": "Example usage:",
34063 "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",
34067 "name": "AddAgents",
34068 "group": "Whatsapp_Accounts",
34069 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34070 "version": "0.0.0",
34071 "filename": "server/api/whatsappAccount/index.js",
34072 "groupTitle": "Whatsapp_Accounts"
34076 "url": "/api/whatsapp/accounts",
34077 "title": "Creates a new Account",
34080 "title": "Example usage:",
34081 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34085 "name": "CreateAccounts",
34086 "group": "Whatsapp_Accounts",
34139 "field": "accountSid",
34146 "field": "authToken",
34153 "field": "notificationTemplate",
34160 "field": "notificationSound",
34167 "field": "notificationShake",
34174 "field": "waitForTheAssignedAgent",
34181 "field": "queueTransfer",
34188 "field": "queueTransferTimeout",
34195 "field": "agentTransfer",
34202 "field": "agentTransferTimeout",
34209 "field": "mandatoryDispositionPauseId",
34210 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34216 "field": "mandatoryDisposition",
34217 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34223 "field": "description",
34229 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34230 "version": "0.0.0",
34231 "filename": "server/api/whatsappAccount/index.js",
34232 "groupTitle": "Whatsapp_Accounts"
34236 "url": "/api/whatsapp/accounts/{id}",
34237 "title": "Deletes a Account",
34240 "title": "Example usage:",
34241 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34245 "name": "DeleteAccounts",
34246 "group": "Whatsapp_Accounts",
34247 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34248 "version": "0.0.0",
34249 "filename": "server/api/whatsappAccount/index.js",
34250 "groupTitle": "Whatsapp_Accounts"
34254 "url": "/api/whatsapp/accounts/describe",
34255 "title": "Gets table info about Accounts",
34258 "title": "Example usage:",
34259 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34263 "name": "DescribeAccounts",
34264 "group": "Whatsapp_Accounts",
34265 "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>",
34266 "version": "0.0.0",
34267 "filename": "server/api/whatsappAccount/index.js",
34268 "groupTitle": "Whatsapp_Accounts"
34272 "url": "/api/whatsapp/accounts",
34273 "title": "Gets a list of Accounts",
34276 "title": "Example usage:",
34277 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34281 "name": "GetAccounts",
34282 "group": "Whatsapp_Accounts",
34283 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34284 "version": "0.0.0",
34285 "filename": "server/api/whatsappAccount/index.js",
34286 "groupTitle": "Whatsapp_Accounts"
34290 "url": "/api/whatsapp/accounts/{id}/users",
34291 "title": "Gets agents from whatsapp account",
34294 "title": "Example usage:",
34295 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34299 "name": "GetAgents",
34300 "group": "Whatsapp_Accounts",
34301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34302 "version": "0.0.0",
34303 "filename": "server/api/whatsappAccount/index.js",
34304 "groupTitle": "Whatsapp_Accounts"
34308 "url": "/api/whatsapp/accounts/{id}/users",
34309 "title": "Removes agents from a whatsapp account",
34312 "title": "Example usage:",
34313 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34317 "name": "RemoveAgents",
34318 "group": "Whatsapp_Accounts",
34319 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34320 "version": "0.0.0",
34321 "filename": "server/api/whatsappAccount/index.js",
34322 "groupTitle": "Whatsapp_Accounts"
34326 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34327 "title": "Removes canned answers from account",
34330 "title": "Example usage:",
34331 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34335 "name": "RemoveAnswers",
34336 "group": "Whatsapp_Accounts",
34337 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34338 "version": "0.0.0",
34339 "filename": "server/api/whatsappAccount/index.js",
34340 "groupTitle": "Whatsapp_Accounts"
34344 "url": "/api/whatsapp/accounts/{id}/dispositions",
34345 "title": "Removes dispositions from account",
34348 "title": "Example usage:",
34349 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34353 "name": "RemoveDispositions",
34354 "group": "Whatsapp_Accounts",
34355 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34356 "version": "0.0.0",
34357 "filename": "server/api/whatsappAccount/index.js",
34358 "groupTitle": "Whatsapp_Accounts"
34362 "url": "/api/whatsapp/accounts/{id}",
34363 "title": "Gets a single Account",
34366 "title": "Example usage:",
34367 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34371 "name": "ShowAccounts",
34372 "group": "Whatsapp_Accounts",
34373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34374 "version": "0.0.0",
34375 "filename": "server/api/whatsappAccount/index.js",
34376 "groupTitle": "Whatsapp_Accounts"
34380 "url": "/api/whatsapp/messages/{id}/accept",
34381 "title": "Accepts message",
34384 "title": "Example usage:",
34385 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34389 "name": "acceptMessage",
34390 "group": "Whatsapp_Accounts",
34391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34392 "version": "0.0.0",
34393 "filename": "server/api/whatsappMessage/index.js",
34394 "groupTitle": "Whatsapp_Accounts"
34398 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34399 "title": "Creates new canned answer",
34402 "title": "Example usage:",
34403 "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",
34407 "name": "addAnswer",
34408 "group": "Whatsapp_Accounts",
34430 "field": "description",
34443 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34444 "version": "0.0.0",
34445 "filename": "server/api/whatsappAccount/index.js",
34446 "groupTitle": "Whatsapp_Accounts"
34450 "url": "/api/whatsapp/accounts/{id}/applications",
34451 "title": "Creates new applications",
34454 "title": "Example usage:",
34455 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34459 "name": "addApplications",
34460 "group": "Whatsapp_Accounts",
34468 "field": "priority",
34482 "field": "appdata",
34489 "field": "description",
34496 "field": "interval",
34502 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34503 "version": "0.0.0",
34504 "filename": "server/api/whatsappAccount/index.js",
34505 "groupTitle": "Whatsapp_Accounts"
34509 "url": "/api/whatsapp/accounts/{id}/dispositions",
34510 "title": "Creates new disposition",
34513 "title": "Example usage:",
34514 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34518 "name": "addDisposition",
34519 "group": "Whatsapp_Accounts",
34546 "field": "description",
34552 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34553 "version": "0.0.0",
34554 "filename": "server/api/whatsappAccount/index.js",
34555 "groupTitle": "Whatsapp_Accounts"
34559 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34560 "title": "Gets account canned answers",
34563 "title": "Example usage:",
34564 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34568 "name": "getAnswers",
34569 "group": "Whatsapp_Accounts",
34570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34571 "version": "0.0.0",
34572 "filename": "server/api/whatsappAccount/index.js",
34573 "groupTitle": "Whatsapp_Accounts"
34577 "url": "/api/whatsapp/accounts/{id}/applications",
34578 "title": "Gets account applications",
34581 "title": "Example usage:",
34582 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34586 "name": "getApplications",
34587 "group": "Whatsapp_Accounts",
34588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34589 "version": "0.0.0",
34590 "filename": "server/api/whatsappAccount/index.js",
34591 "groupTitle": "Whatsapp_Accounts"
34595 "url": "/api/whatsapp/accounts/{id}/dispositions",
34596 "title": "Gets account dispositions",
34599 "title": "Example usage:",
34600 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34604 "name": "getDispositions",
34605 "group": "Whatsapp_Accounts",
34606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34607 "version": "0.0.0",
34608 "filename": "server/api/whatsappAccount/index.js",
34609 "groupTitle": "Whatsapp_Accounts"
34613 "url": "/api/whatsapp/accounts/{id}/notify",
34614 "title": "Notify new message",
34617 "title": "Example usage:",
34618 "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",
34623 "group": "Whatsapp_Accounts",
34624 "description": "<p>Motion 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>",
34625 "version": "0.0.0",
34626 "filename": "server/api/whatsappAccount/index.js",
34627 "groupTitle": "Whatsapp_Accounts"
34631 "url": "/api/whatsapp/messages/{id}/reject",
34632 "title": "Rejects message",
34635 "title": "Example usage:",
34636 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34640 "name": "rejectMessage",
34641 "group": "Whatsapp_Accounts",
34642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34643 "version": "0.0.0",
34644 "filename": "server/api/whatsappMessage/index.js",
34645 "groupTitle": "Whatsapp_Accounts"
34649 "url": "/api/whatsapp/accounts/{id}/send",
34650 "title": "Send new whatsapp message",
34653 "title": "Example usage:",
34654 "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",
34658 "name": "sendWhatsapp",
34659 "group": "Whatsapp_Accounts",
34660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34661 "version": "0.0.0",
34662 "filename": "server/api/whatsappAccount/index.js",
34663 "groupTitle": "Whatsapp_Accounts"
34667 "url": "/api/whatsapp/messages/{id}/status",
34668 "title": "Receive message status",
34671 "title": "Example usage:",
34672 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34676 "name": "statusMessage",
34677 "group": "Whatsapp_Accounts",
34678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34679 "version": "0.0.0",
34680 "filename": "server/api/whatsappMessage/index.js",
34681 "groupTitle": "Whatsapp_Accounts"
34685 "url": "/api/whatsapp/accounts/{id}",
34686 "title": "Update an existing Account",
34689 "title": "Example usage:",
34690 "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",
34694 "name": "updateAccounts",
34695 "group": "Whatsapp_Accounts",
34696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34697 "version": "0.0.0",
34698 "filename": "server/api/whatsappAccount/index.js",
34699 "groupTitle": "Whatsapp_Accounts"
34703 "url": "/api/whatsapp/applications",
34704 "title": "Creates a new Application",
34707 "title": "Example usage:",
34708 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34712 "name": "CreateApplications",
34713 "group": "Whatsapp_Applications",
34721 "field": "priority",
34735 "field": "appdata",
34742 "field": "description",
34749 "field": "interval",
34755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34756 "version": "0.0.0",
34757 "filename": "server/api/whatsappApplication/index.js",
34758 "groupTitle": "Whatsapp_Applications"
34762 "url": "/api/whatsapp/applications/{id}",
34763 "title": "Deletes a Application",
34766 "title": "Example usage:",
34767 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34771 "name": "DeleteApplications",
34772 "group": "Whatsapp_Applications",
34773 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34774 "version": "0.0.0",
34775 "filename": "server/api/whatsappApplication/index.js",
34776 "groupTitle": "Whatsapp_Applications"
34780 "url": "/api/whatsapp/applications",
34781 "title": "Gets a list of Applications",
34784 "title": "Example usage:",
34785 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
34789 "name": "GetApplications",
34790 "group": "Whatsapp_Applications",
34791 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34792 "version": "0.0.0",
34793 "filename": "server/api/whatsappApplication/index.js",
34794 "groupTitle": "Whatsapp_Applications"
34798 "url": "/api/whatsapp/applications/{id}",
34799 "title": "Gets a single Application",
34802 "title": "Example usage:",
34803 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
34807 "name": "ShowApplications",
34808 "group": "Whatsapp_Applications",
34809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34810 "version": "0.0.0",
34811 "filename": "server/api/whatsappApplication/index.js",
34812 "groupTitle": "Whatsapp_Applications"
34816 "url": "/api/whatsapp/applications/{id}",
34817 "title": "Update an existing Application",
34820 "title": "Example usage:",
34821 "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",
34825 "name": "updateApplications",
34826 "group": "Whatsapp_Applications",
34827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34828 "version": "0.0.0",
34829 "filename": "server/api/whatsappApplication/index.js",
34830 "groupTitle": "Whatsapp_Applications"
34834 "url": "/api/whatsapp/interactions/{id}/tags",
34835 "title": "Add tags to the interaction",
34838 "title": "Example usage:",
34839 "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",
34844 "group": "Whatsapp_Interactions",
34845 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34846 "version": "0.0.0",
34847 "filename": "server/api/whatsappInteraction/index.js",
34848 "groupTitle": "Whatsapp_Interactions"
34852 "url": "/api/whatsapp/interactions",
34853 "title": "Creates a new Interaction",
34856 "title": "Example usage:",
34857 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34861 "name": "CreateInteractions",
34862 "group": "Whatsapp_Interactions",
34877 "field": "closedAt",
34884 "field": "disposition",
34891 "field": "secondDisposition",
34898 "field": "thirdDisposition",
34919 "field": "read1stAt",
34930 "field": "firstMsgDirection",
34937 "field": "lastMsgAt",
34948 "field": "lastMsgDirection",
34954 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34955 "version": "0.0.0",
34956 "filename": "server/api/whatsappInteraction/index.js",
34957 "groupTitle": "Whatsapp_Interactions"
34961 "url": "/api/whatsapp/interactions/{id}",
34962 "title": "Deletes a Interaction",
34965 "title": "Example usage:",
34966 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
34970 "name": "DeleteInteractions",
34971 "group": "Whatsapp_Interactions",
34972 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34973 "version": "0.0.0",
34974 "filename": "server/api/whatsappInteraction/index.js",
34975 "groupTitle": "Whatsapp_Interactions"
34979 "url": "/api/whatsapp/interactions/describe",
34980 "title": "Gets table info about Interactions",
34983 "title": "Example usage:",
34984 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
34988 "name": "DescribeInteractions",
34989 "group": "Whatsapp_Interactions",
34990 "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>",
34991 "version": "0.0.0",
34992 "filename": "server/api/whatsappInteraction/index.js",
34993 "groupTitle": "Whatsapp_Interactions"
34997 "url": "/api/whatsapp/interactions",
34998 "title": "Gets a list of Interactions",
35001 "title": "Example usage:",
35002 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35006 "name": "GetInteractions",
35007 "group": "Whatsapp_Interactions",
35008 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35009 "version": "0.0.0",
35010 "filename": "server/api/whatsappInteraction/index.js",
35011 "groupTitle": "Whatsapp_Interactions"
35015 "url": "/api/whatsapp/interactions/{id}/tags",
35016 "title": "Removes tags from interaction",
35019 "title": "Example usage:",
35020 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35024 "name": "RemoveTags",
35025 "group": "Whatsapp_Interactions",
35026 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35027 "version": "0.0.0",
35028 "filename": "server/api/whatsappInteraction/index.js",
35029 "groupTitle": "Whatsapp_Interactions"
35033 "url": "/api/whatsapp/interactions/{id}",
35034 "title": "Gets a single Interaction",
35037 "title": "Example usage:",
35038 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35042 "name": "ShowInteractions",
35043 "group": "Whatsapp_Interactions",
35044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35045 "version": "0.0.0",
35046 "filename": "server/api/whatsappInteraction/index.js",
35047 "groupTitle": "Whatsapp_Interactions"
35051 "url": "/api/whatsapp/interactions/{id}/messages",
35052 "title": "Creates new messages",
35055 "title": "Example usage:",
35056 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35060 "name": "addMessage",
35061 "group": "Whatsapp_Interactions",
35087 "field": "direction",
35094 "field": "messageId",
35121 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35122 "version": "0.0.0",
35123 "filename": "server/api/whatsappInteraction/index.js",
35124 "groupTitle": "Whatsapp_Interactions"
35128 "url": "/api/whatsapp/interactions/{id}/download",
35129 "title": "Gets interaction",
35132 "title": "Example usage:",
35133 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35137 "name": "download",
35138 "group": "Whatsapp_Interactions",
35139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35140 "version": "0.0.0",
35141 "filename": "server/api/whatsappInteraction/index.js",
35142 "groupTitle": "Whatsapp_Interactions"
35146 "url": "/api/whatsapp/interactions/{id}/messages",
35147 "title": "Gets interaction messages",
35150 "title": "Example usage:",
35151 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35155 "name": "getMessages",
35156 "group": "Whatsapp_Interactions",
35157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35158 "version": "0.0.0",
35159 "filename": "server/api/whatsappInteraction/index.js",
35160 "groupTitle": "Whatsapp_Interactions"
35164 "url": "/api/whatsapp/interactions/{id}",
35165 "title": "Update an existing Interaction",
35168 "title": "Example usage:",
35169 "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",
35173 "name": "updateInteractions",
35174 "group": "Whatsapp_Interactions",
35175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35176 "version": "0.0.0",
35177 "filename": "server/api/whatsappInteraction/index.js",
35178 "groupTitle": "Whatsapp_Interactions"
35182 "url": "/api/whatsapp/messages",
35183 "title": "Creates a new Message",
35186 "title": "Example usage:",
35187 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35191 "name": "CreateMessages",
35192 "group": "Whatsapp_Messages",
35218 "field": "direction",
35225 "field": "messageId",
35252 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35253 "version": "0.0.0",
35254 "filename": "server/api/whatsappMessage/index.js",
35255 "groupTitle": "Whatsapp_Messages"
35259 "url": "/api/whatsapp/messages/{id}",
35260 "title": "Deletes a Message",
35263 "title": "Example usage:",
35264 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35268 "name": "DeleteMessages",
35269 "group": "Whatsapp_Messages",
35270 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35271 "version": "0.0.0",
35272 "filename": "server/api/whatsappMessage/index.js",
35273 "groupTitle": "Whatsapp_Messages"
35277 "url": "/api/whatsapp/messages/describe",
35278 "title": "Gets table info about Messages",
35281 "title": "Example usage:",
35282 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35286 "name": "DescribeMessages",
35287 "group": "Whatsapp_Messages",
35288 "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>",
35289 "version": "0.0.0",
35290 "filename": "server/api/whatsappMessage/index.js",
35291 "groupTitle": "Whatsapp_Messages"
35295 "url": "/api/whatsapp/messages",
35296 "title": "Gets a list of Messages",
35299 "title": "Example usage:",
35300 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35304 "name": "GetMessages",
35305 "group": "Whatsapp_Messages",
35306 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35307 "version": "0.0.0",
35308 "filename": "server/api/whatsappMessage/index.js",
35309 "groupTitle": "Whatsapp_Messages"
35313 "url": "/api/whatsapp/messages/{id}",
35314 "title": "Gets a single Message",
35317 "title": "Example usage:",
35318 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35322 "name": "ShowMessages",
35323 "group": "Whatsapp_Messages",
35324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35325 "version": "0.0.0",
35326 "filename": "server/api/whatsappMessage/index.js",
35327 "groupTitle": "Whatsapp_Messages"
35331 "url": "/api/whatsapp/messages/{id}",
35332 "title": "Update an existing Message",
35335 "title": "Example usage:",
35336 "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",
35340 "name": "updateMessages",
35341 "group": "Whatsapp_Messages",
35342 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35343 "version": "0.0.0",
35344 "filename": "server/api/whatsappMessage/index.js",
35345 "groupTitle": "Whatsapp_Messages"
35349 "url": "/api/whatsapp/reports/queue",
35350 "title": "Creates a new Whatsapp Queue Report",
35353 "title": "Example usage:",
35354 "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",
35358 "name": "CreateWhatsapp_Queue_Reports",
35359 "group": "Whatsapp_Queue_Reports",
35367 "field": "uniqueid",
35388 "field": "leaveAt",
35395 "field": "acceptAt",
35415 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35416 "version": "0.0.0",
35417 "filename": "server/api/whatsappQueueReport/index.js",
35418 "groupTitle": "Whatsapp_Queue_Reports"
35422 "url": "/api/whatsapp/reports/queue/{id}",
35423 "title": "Deletes a Whatsapp Queue Report",
35426 "title": "Example usage:",
35427 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35431 "name": "DeleteWhatsapp_Queue_Reports",
35432 "group": "Whatsapp_Queue_Reports",
35433 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35434 "version": "0.0.0",
35435 "filename": "server/api/whatsappQueueReport/index.js",
35436 "groupTitle": "Whatsapp_Queue_Reports"
35440 "url": "/api/whatsapp/reports/queue/describe",
35441 "title": "Gets table info about Whatsapp Queue Reports",
35444 "title": "Example usage:",
35445 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35449 "name": "DescribeWhatsapp_Queue_Reports",
35450 "group": "Whatsapp_Queue_Reports",
35451 "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>",
35452 "version": "0.0.0",
35453 "filename": "server/api/whatsappQueueReport/index.js",
35454 "groupTitle": "Whatsapp_Queue_Reports"
35458 "url": "/api/whatsapp/reports/queue",
35459 "title": "Gets a list of Whatsapp Queue Reports",
35462 "title": "Example usage:",
35463 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35467 "name": "GetWhatsapp_Queue_Reports",
35468 "group": "Whatsapp_Queue_Reports",
35469 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35470 "version": "0.0.0",
35471 "filename": "server/api/whatsappQueueReport/index.js",
35472 "groupTitle": "Whatsapp_Queue_Reports"
35476 "url": "/api/whatsapp/reports/queue/{id}",
35477 "title": "Gets a single Whatsapp Queue Report",
35480 "title": "Example usage:",
35481 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35485 "name": "ShowWhatsapp_Queue_Reports",
35486 "group": "Whatsapp_Queue_Reports",
35487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35488 "version": "0.0.0",
35489 "filename": "server/api/whatsappQueueReport/index.js",
35490 "groupTitle": "Whatsapp_Queue_Reports"
35494 "url": "/api/whatsapp/reports/queue/{id}",
35495 "title": "Update an existing Whatsapp Queue Report",
35498 "title": "Example usage:",
35499 "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",
35503 "name": "updateWhatsapp_Queue_Reports",
35504 "group": "Whatsapp_Queue_Reports",
35505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35506 "version": "0.0.0",
35507 "filename": "server/api/whatsappQueueReport/index.js",
35508 "groupTitle": "Whatsapp_Queue_Reports"
35512 "url": "/api/whatsapp/queues/{id}/users",
35513 "title": "Add agents to a queue",
35516 "title": "Example usage:",
35517 "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",
35521 "name": "AddAgents",
35522 "group": "Whatsapp_Queues",
35523 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35524 "version": "0.0.0",
35525 "filename": "server/api/whatsappQueue/index.js",
35526 "groupTitle": "Whatsapp_Queues"
35530 "url": "/api/whatsapp/queues/{id}/teams",
35531 "title": "Add teams to a queue",
35534 "title": "Example usage:",
35535 "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",
35539 "name": "AddTeams",
35540 "group": "Whatsapp_Queues",
35541 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35542 "version": "0.0.0",
35543 "filename": "server/api/whatsappQueue/index.js",
35544 "groupTitle": "Whatsapp_Queues"
35548 "url": "/api/whatsapp/queues",
35549 "title": "Creates a new Queue",
35552 "title": "Example usage:",
35553 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35557 "name": "CreateQueues",
35558 "group": "Whatsapp_Queues",
35573 "field": "timeout",
35585 "field": "strategy",
35592 "field": "description",
35598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35599 "version": "0.0.0",
35600 "filename": "server/api/whatsappQueue/index.js",
35601 "groupTitle": "Whatsapp_Queues"
35605 "url": "/api/whatsapp/queues/{id}",
35606 "title": "Deletes a Queue",
35609 "title": "Example usage:",
35610 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35614 "name": "DeleteQueues",
35615 "group": "Whatsapp_Queues",
35616 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35617 "version": "0.0.0",
35618 "filename": "server/api/whatsappQueue/index.js",
35619 "groupTitle": "Whatsapp_Queues"
35623 "url": "/api/whatsapp/queues/describe",
35624 "title": "Gets table info about Queues",
35627 "title": "Example usage:",
35628 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35632 "name": "DescribeQueues",
35633 "group": "Whatsapp_Queues",
35634 "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>",
35635 "version": "0.0.0",
35636 "filename": "server/api/whatsappQueue/index.js",
35637 "groupTitle": "Whatsapp_Queues"
35641 "url": "/api/whatsapp/queues/{id}/users",
35642 "title": "Gets queue agents",
35645 "title": "Example usage:",
35646 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35650 "name": "GetAgents",
35651 "group": "Whatsapp_Queues",
35652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35653 "version": "0.0.0",
35654 "filename": "server/api/whatsappQueue/index.js",
35655 "groupTitle": "Whatsapp_Queues"
35659 "url": "/api/whatsapp/queues/{id}/members",
35660 "title": "GetMembers",
35663 "title": "Example usage:",
35664 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
35668 "name": "GetMembers",
35669 "group": "Whatsapp_Queues",
35670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35671 "version": "0.0.0",
35672 "filename": "server/api/whatsappQueue/index.js",
35673 "groupTitle": "Whatsapp_Queues"
35677 "url": "/api/whatsapp/queues",
35678 "title": "Gets a list of Queues",
35681 "title": "Example usage:",
35682 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35686 "name": "GetQueues",
35687 "group": "Whatsapp_Queues",
35688 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35689 "version": "0.0.0",
35690 "filename": "server/api/whatsappQueue/index.js",
35691 "groupTitle": "Whatsapp_Queues"
35695 "url": "/api/whatsapp/queues/{id}/teams",
35696 "title": "Gets queues list",
35699 "title": "Example usage:",
35700 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35704 "name": "GetTeams",
35705 "group": "Whatsapp_Queues",
35706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35707 "version": "0.0.0",
35708 "filename": "server/api/whatsappQueue/index.js",
35709 "groupTitle": "Whatsapp_Queues"
35713 "url": "/api/whatsapp/queues/{id}/users",
35714 "title": "Removes agents from a queue",
35717 "title": "Example usage:",
35718 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35722 "name": "RemoveAgents",
35723 "group": "Whatsapp_Queues",
35724 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35725 "version": "0.0.0",
35726 "filename": "server/api/whatsappQueue/index.js",
35727 "groupTitle": "Whatsapp_Queues"
35731 "url": "/api/whatsapp/queues/{id}",
35732 "title": "Gets a single Queue",
35735 "title": "Example usage:",
35736 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35740 "name": "ShowQueues",
35741 "group": "Whatsapp_Queues",
35742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35743 "version": "0.0.0",
35744 "filename": "server/api/whatsappQueue/index.js",
35745 "groupTitle": "Whatsapp_Queues"
35749 "url": "/api/whatsapp/queues/{id}",
35750 "title": "Update an existing Queue",
35753 "title": "Example usage:",
35754 "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",
35758 "name": "updateQueues",
35759 "group": "Whatsapp_Queues",
35760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35761 "version": "0.0.0",
35762 "filename": "server/api/whatsappQueue/index.js",
35763 "groupTitle": "Whatsapp_Queues"
35767 "url": "/api/whatsapp/reports/transfer",
35768 "title": "Creates a new Whatsapp Transfer Report",
35771 "title": "Example usage:",
35772 "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",
35776 "name": "CreateWhatsapp_Transfer_Reports",
35777 "group": "Whatsapp_Transfer_Reports",
35785 "field": "uniqueid",
35804 "field": "transferredAt",
35810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35811 "version": "0.0.0",
35812 "filename": "server/api/whatsappTransferReport/index.js",
35813 "groupTitle": "Whatsapp_Transfer_Reports"
35817 "url": "/api/whatsapp/reports/transfer/{id}",
35818 "title": "Deletes a Whatsapp Transfer Report",
35821 "title": "Example usage:",
35822 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
35826 "name": "DeleteWhatsapp_Transfer_Reports",
35827 "group": "Whatsapp_Transfer_Reports",
35828 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35829 "version": "0.0.0",
35830 "filename": "server/api/whatsappTransferReport/index.js",
35831 "groupTitle": "Whatsapp_Transfer_Reports"
35835 "url": "/api/whatsapp/reports/transfer/describe",
35836 "title": "Gets table info about Whatsapp Transfer Reports",
35839 "title": "Example usage:",
35840 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
35844 "name": "DescribeWhatsapp_Transfer_Reports",
35845 "group": "Whatsapp_Transfer_Reports",
35846 "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>",
35847 "version": "0.0.0",
35848 "filename": "server/api/whatsappTransferReport/index.js",
35849 "groupTitle": "Whatsapp_Transfer_Reports"
35853 "url": "/api/whatsapp/reports/transfer",
35854 "title": "Gets a list of Whatsapp Transfer Reports",
35857 "title": "Example usage:",
35858 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
35862 "name": "GetWhatsapp_Transfer_Reports",
35863 "group": "Whatsapp_Transfer_Reports",
35864 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35865 "version": "0.0.0",
35866 "filename": "server/api/whatsappTransferReport/index.js",
35867 "groupTitle": "Whatsapp_Transfer_Reports"
35871 "url": "/api/whatsapp/reports/transfer/{id}",
35872 "title": "Gets a single Whatsapp Transfer Report",
35875 "title": "Example usage:",
35876 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
35880 "name": "ShowWhatsapp_Transfer_Reports",
35881 "group": "Whatsapp_Transfer_Reports",
35882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35883 "version": "0.0.0",
35884 "filename": "server/api/whatsappTransferReport/index.js",
35885 "groupTitle": "Whatsapp_Transfer_Reports"
35889 "url": "/api/whatsapp/reports/transfer/{id}",
35890 "title": "Update an existing Whatsapp Transfer Report",
35893 "title": "Example usage:",
35894 "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",
35898 "name": "updateWhatsapp_Transfer_Reports",
35899 "group": "Whatsapp_Transfer_Reports",
35900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35901 "version": "0.0.0",
35902 "filename": "server/api/whatsappTransferReport/index.js",
35903 "groupTitle": "Whatsapp_Transfer_Reports"
35907 "url": "/api/integrations/zendesk/accounts",
35908 "title": "Creates a new Zendesk Account",
35911 "title": "Example usage:",
35912 "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",
35916 "name": "CreateZendesk_Accounts",
35917 "group": "Zendesk_Accounts",
35932 "field": "description",
35939 "field": "username",
35946 "field": "password",
35960 "field": "remoteUri",
35971 "field": "authType",
35978 "field": "serverUrl",
35985 "\"integrationTab\"",
35995 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35996 "version": "0.0.0",
35997 "filename": "server/api/intZendeskAccount/index.js",
35998 "groupTitle": "Zendesk_Accounts"
36002 "url": "/api/integrations/zendesk/accounts/{id}",
36003 "title": "Deletes a Zendesk Account",
36006 "title": "Example usage:",
36007 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36011 "name": "DeleteZendesk_Accounts",
36012 "group": "Zendesk_Accounts",
36013 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36014 "version": "0.0.0",
36015 "filename": "server/api/intZendeskAccount/index.js",
36016 "groupTitle": "Zendesk_Accounts"
36020 "url": "/api/integrations/zendesk/accounts",
36021 "title": "Gets a list of Zendesk Accounts",
36024 "title": "Example usage:",
36025 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36029 "name": "GetZendesk_Accounts",
36030 "group": "Zendesk_Accounts",
36031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36032 "version": "0.0.0",
36033 "filename": "server/api/intZendeskAccount/index.js",
36034 "groupTitle": "Zendesk_Accounts"
36038 "url": "/api/integrations/zendesk/accounts/{id}",
36039 "title": "Gets a single Zendesk Account",
36042 "title": "Example usage:",
36043 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36047 "name": "ShowZendesk_Accounts",
36048 "group": "Zendesk_Accounts",
36049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36050 "version": "0.0.0",
36051 "filename": "server/api/intZendeskAccount/index.js",
36052 "groupTitle": "Zendesk_Accounts"
36056 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36057 "title": "Creates new configuration",
36060 "title": "Example usage:",
36061 "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",
36065 "name": "addConfiguration",
36066 "group": "Zendesk_Accounts",
36067 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36068 "version": "0.0.0",
36069 "filename": "server/api/intZendeskAccount/index.js",
36070 "groupTitle": "Zendesk_Accounts"
36074 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36075 "title": "Gets account configurations",
36078 "title": "Example usage:",
36079 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36083 "name": "getConfigurations",
36084 "group": "Zendesk_Accounts",
36085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36086 "version": "0.0.0",
36087 "filename": "server/api/intZendeskAccount/index.js",
36088 "groupTitle": "Zendesk_Accounts"
36092 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36093 "title": "Gets account fields",
36096 "title": "Example usage:",
36097 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36101 "name": "getFields",
36102 "group": "Zendesk_Accounts",
36103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36104 "version": "0.0.0",
36105 "filename": "server/api/intZendeskAccount/index.js",
36106 "groupTitle": "Zendesk_Accounts"
36110 "url": "/api/integrations/zendesk/accounts/{id}",
36111 "title": "Update an existing Zendesk Account",
36114 "title": "Example usage:",
36115 "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",
36119 "name": "updateZendesk_Accounts",
36120 "group": "Zendesk_Accounts",
36121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36122 "version": "0.0.0",
36123 "filename": "server/api/intZendeskAccount/index.js",
36124 "groupTitle": "Zendesk_Accounts"
36128 "url": "/api/integrations/zendesk/configurations",
36129 "title": "Creates a new Zendesk Configuration",
36132 "title": "Example usage:",
36133 "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",
36137 "name": "CreateZendesk_Configurations",
36138 "group": "Zendesk_Configurations",
36153 "field": "description",
36159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36160 "version": "0.0.0",
36161 "filename": "server/api/intZendeskConfiguration/index.js",
36162 "groupTitle": "Zendesk_Configurations"
36166 "url": "/api/integrations/zendesk/configurations/{id}",
36167 "title": "Deletes a Zendesk Configuration",
36170 "title": "Example usage:",
36171 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36175 "name": "DeleteZendesk_Configurations",
36176 "group": "Zendesk_Configurations",
36177 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36178 "version": "0.0.0",
36179 "filename": "server/api/intZendeskConfiguration/index.js",
36180 "groupTitle": "Zendesk_Configurations"
36184 "url": "/api/integrations/zendesk/configurations",
36185 "title": "Gets a list of Zendesk Configurations",
36188 "title": "Example usage:",
36189 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36193 "name": "GetZendesk_Configurations",
36194 "group": "Zendesk_Configurations",
36195 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36196 "version": "0.0.0",
36197 "filename": "server/api/intZendeskConfiguration/index.js",
36198 "groupTitle": "Zendesk_Configurations"
36202 "url": "/api/integrations/zendesk/configurations/{id}",
36203 "title": "Gets a single Zendesk Configuration",
36206 "title": "Example usage:",
36207 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36211 "name": "ShowZendesk_Configurations",
36212 "group": "Zendesk_Configurations",
36213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36214 "version": "0.0.0",
36215 "filename": "server/api/intZendeskConfiguration/index.js",
36216 "groupTitle": "Zendesk_Configurations"
36220 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36221 "title": "Gets configurations descriptions",
36224 "title": "Example usage:",
36225 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36229 "name": "getDescriptions",
36230 "group": "Zendesk_Configurations",
36231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36232 "version": "0.0.0",
36233 "filename": "server/api/intZendeskConfiguration/index.js",
36234 "groupTitle": "Zendesk_Configurations"
36238 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36239 "title": "Gets configurations fields",
36242 "title": "Example usage:",
36243 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36247 "name": "getFields",
36248 "group": "Zendesk_Configurations",
36249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36250 "version": "0.0.0",
36251 "filename": "server/api/intZendeskConfiguration/index.js",
36252 "groupTitle": "Zendesk_Configurations"
36256 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36257 "title": "Gets configurations subjects",
36260 "title": "Example usage:",
36261 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36265 "name": "getSubjects",
36266 "group": "Zendesk_Configurations",
36267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36268 "version": "0.0.0",
36269 "filename": "server/api/intZendeskConfiguration/index.js",
36270 "groupTitle": "Zendesk_Configurations"
36274 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36275 "title": "Gets configurations tags",
36278 "title": "Example usage:",
36279 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36284 "group": "Zendesk_Configurations",
36285 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36286 "version": "0.0.0",
36287 "filename": "server/api/intZendeskConfiguration/index.js",
36288 "groupTitle": "Zendesk_Configurations"
36292 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36293 "title": "Sets new tags",
36296 "title": "Example usage:",
36297 "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",
36302 "group": "Zendesk_Configurations",
36303 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36304 "version": "0.0.0",
36305 "filename": "server/api/intZendeskConfiguration/index.js",
36306 "groupTitle": "Zendesk_Configurations"
36310 "url": "/api/integrations/zendesk/configurations/{id}",
36311 "title": "Update an existing Zendesk Configuration",
36314 "title": "Example usage:",
36315 "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",
36319 "name": "updateZendesk_Configurations",
36320 "group": "Zendesk_Configurations",
36321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36322 "version": "0.0.0",
36323 "filename": "server/api/intZendeskConfiguration/index.js",
36324 "groupTitle": "Zendesk_Configurations"
36328 "url": "/api/integrations/zendesk/fields",
36329 "title": "Creates a new Zendesk Field",
36332 "title": "Example usage:",
36333 "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",
36337 "name": "CreateZendesk_Fields",
36338 "group": "Zendesk_Fields",
36348 "\"customVariable\"",
36359 "field": "content",
36375 "\"customVariable\""
36378 "field": "keyType",
36385 "field": "keyContent",
36392 "field": "idField",
36399 "field": "nameField",
36406 "field": "customField",
36413 "field": "variableName",
36419 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36420 "version": "0.0.0",
36421 "filename": "server/api/intZendeskField/index.js",
36422 "groupTitle": "Zendesk_Fields"
36426 "url": "/api/integrations/zendesk/fields/{id}",
36427 "title": "Deletes a Zendesk Field",
36430 "title": "Example usage:",
36431 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36435 "name": "DeleteZendesk_Fields",
36436 "group": "Zendesk_Fields",
36437 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36438 "version": "0.0.0",
36439 "filename": "server/api/intZendeskField/index.js",
36440 "groupTitle": "Zendesk_Fields"
36444 "url": "/api/integrations/zendesk/fields",
36445 "title": "Gets a list of Zendesk Fields",
36448 "title": "Example usage:",
36449 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36453 "name": "GetZendesk_Fields",
36454 "group": "Zendesk_Fields",
36455 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36456 "version": "0.0.0",
36457 "filename": "server/api/intZendeskField/index.js",
36458 "groupTitle": "Zendesk_Fields"
36462 "url": "/api/integrations/zendesk/fields/{id}",
36463 "title": "Gets a single Zendesk Field",
36466 "title": "Example usage:",
36467 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36471 "name": "ShowZendesk_Fields",
36472 "group": "Zendesk_Fields",
36473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36474 "version": "0.0.0",
36475 "filename": "server/api/intZendeskField/index.js",
36476 "groupTitle": "Zendesk_Fields"
36480 "url": "/api/integrations/zendesk/fields/{id}",
36481 "title": "Update an existing Zendesk Field",
36484 "title": "Example usage:",
36485 "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",
36489 "name": "updateZendesk_Fields",
36490 "group": "Zendesk_Fields",
36491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36492 "version": "0.0.0",
36493 "filename": "server/api/intZendeskField/index.js",
36494 "groupTitle": "Zendesk_Fields"
36498 "url": "/api/integrations/zoho/accounts",
36499 "title": "Creates a new Zoho Account",
36502 "title": "Example usage:",
36503 "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",
36507 "name": "CreateZoho_Accounts",
36508 "group": "Zoho_Accounts",
36523 "field": "description",
36544 "field": "clientId",
36551 "field": "clientSecret",
36558 "field": "serverUrl",
36572 "field": "refreshToken",
36578 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36579 "version": "0.0.0",
36580 "filename": "server/api/intZohoAccount/index.js",
36581 "groupTitle": "Zoho_Accounts"
36585 "url": "/api/integrations/zoho/accounts/{id}",
36586 "title": "Deletes a Zoho Account",
36589 "title": "Example usage:",
36590 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36594 "name": "DeleteZoho_Accounts",
36595 "group": "Zoho_Accounts",
36596 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36597 "version": "0.0.0",
36598 "filename": "server/api/intZohoAccount/index.js",
36599 "groupTitle": "Zoho_Accounts"
36603 "url": "/api/integrations/zoho/accounts",
36604 "title": "Gets a list of Zoho Accounts",
36607 "title": "Example usage:",
36608 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36612 "name": "GetZoho_Accounts",
36613 "group": "Zoho_Accounts",
36614 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36615 "version": "0.0.0",
36616 "filename": "server/api/intZohoAccount/index.js",
36617 "groupTitle": "Zoho_Accounts"
36621 "url": "/api/integrations/zoho/accounts/{id}",
36622 "title": "Gets a single Zoho Account",
36625 "title": "Example usage:",
36626 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36630 "name": "ShowZoho_Accounts",
36631 "group": "Zoho_Accounts",
36632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36633 "version": "0.0.0",
36634 "filename": "server/api/intZohoAccount/index.js",
36635 "groupTitle": "Zoho_Accounts"
36639 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36640 "title": "Creates new configuration",
36643 "title": "Example usage:",
36644 "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",
36648 "name": "addConfiguration",
36649 "group": "Zoho_Accounts",
36650 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36651 "version": "0.0.0",
36652 "filename": "server/api/intZohoAccount/index.js",
36653 "groupTitle": "Zoho_Accounts"
36657 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36658 "title": "Gets account configurations",
36661 "title": "Example usage:",
36662 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36666 "name": "getConfigurations",
36667 "group": "Zoho_Accounts",
36668 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36669 "version": "0.0.0",
36670 "filename": "server/api/intZohoAccount/index.js",
36671 "groupTitle": "Zoho_Accounts"
36675 "url": "/api/integrations/zoho/accounts/{id}/fields",
36676 "title": "Gets account fields",
36679 "title": "Example usage:",
36680 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36684 "name": "getFields",
36685 "group": "Zoho_Accounts",
36686 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36687 "version": "0.0.0",
36688 "filename": "server/api/intZohoAccount/index.js",
36689 "groupTitle": "Zoho_Accounts"
36693 "url": "/api/integrations/zoho/accounts/{id}",
36694 "title": "Update an existing Zoho Account",
36697 "title": "Example usage:",
36698 "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",
36702 "name": "updateZoho_Accounts",
36703 "group": "Zoho_Accounts",
36704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36705 "version": "0.0.0",
36706 "filename": "server/api/intZohoAccount/index.js",
36707 "groupTitle": "Zoho_Accounts"
36711 "url": "/api/integrations/zoho/configurations",
36712 "title": "Creates a new Zoho Configuration",
36715 "title": "Example usage:",
36716 "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",
36720 "name": "CreateZoho_Configurations",
36721 "group": "Zoho_Configurations",
36741 "field": "moduleCreate",
36748 "\"contact_lead\"",
36753 "field": "moduleSearch",
36760 "field": "description",
36766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36767 "version": "0.0.0",
36768 "filename": "server/api/intZohoConfiguration/index.js",
36769 "groupTitle": "Zoho_Configurations"
36773 "url": "/api/integrations/zoho/configurations/{id}",
36774 "title": "Deletes a Zoho Configuration",
36777 "title": "Example usage:",
36778 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
36782 "name": "DeleteZoho_Configurations",
36783 "group": "Zoho_Configurations",
36784 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36785 "version": "0.0.0",
36786 "filename": "server/api/intZohoConfiguration/index.js",
36787 "groupTitle": "Zoho_Configurations"
36791 "url": "/api/integrations/zoho/configurations",
36792 "title": "Gets a list of Zoho Configurations",
36795 "title": "Example usage:",
36796 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
36800 "name": "GetZoho_Configurations",
36801 "group": "Zoho_Configurations",
36802 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36803 "version": "0.0.0",
36804 "filename": "server/api/intZohoConfiguration/index.js",
36805 "groupTitle": "Zoho_Configurations"
36809 "url": "/api/integrations/zoho/configurations/{id}",
36810 "title": "Gets a single Zoho Configuration",
36813 "title": "Example usage:",
36814 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
36818 "name": "ShowZoho_Configurations",
36819 "group": "Zoho_Configurations",
36820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36821 "version": "0.0.0",
36822 "filename": "server/api/intZohoConfiguration/index.js",
36823 "groupTitle": "Zoho_Configurations"
36827 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
36828 "title": "Gets configurations descriptions",
36831 "title": "Example usage:",
36832 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36836 "name": "getDescriptions",
36837 "group": "Zoho_Configurations",
36838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36839 "version": "0.0.0",
36840 "filename": "server/api/intZohoConfiguration/index.js",
36841 "groupTitle": "Zoho_Configurations"
36845 "url": "/api/integrations/zoho/configurations/{id}/fields",
36846 "title": "Gets configurations fields",
36849 "title": "Example usage:",
36850 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
36854 "name": "getFields",
36855 "group": "Zoho_Configurations",
36856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36857 "version": "0.0.0",
36858 "filename": "server/api/intZohoConfiguration/index.js",
36859 "groupTitle": "Zoho_Configurations"
36863 "url": "/api/integrations/zoho/configurations/{id}/subjects",
36864 "title": "Gets configurations subjects",
36867 "title": "Example usage:",
36868 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36872 "name": "getSubjects",
36873 "group": "Zoho_Configurations",
36874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36875 "version": "0.0.0",
36876 "filename": "server/api/intZohoConfiguration/index.js",
36877 "groupTitle": "Zoho_Configurations"
36881 "url": "/api/integrations/zoho/configurations/{id}",
36882 "title": "Update an existing Zoho Configuration",
36885 "title": "Example usage:",
36886 "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",
36890 "name": "updateZoho_Configurations",
36891 "group": "Zoho_Configurations",
36892 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36893 "version": "0.0.0",
36894 "filename": "server/api/intZohoConfiguration/index.js",
36895 "groupTitle": "Zoho_Configurations"
36899 "url": "/api/integrations/zoho/fields",
36900 "title": "Creates a new Zoho Field",
36903 "title": "Example usage:",
36904 "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",
36908 "name": "CreateZoho_Fields",
36909 "group": "Zoho_Fields",
36919 "\"customVariable\"",
36930 "field": "content",
36946 "\"customVariable\""
36949 "field": "keyType",
36956 "field": "keyContent",
36963 "field": "idField",
36970 "field": "nameField",
36977 "field": "customField",
36984 "field": "variableName",
36990 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36991 "version": "0.0.0",
36992 "filename": "server/api/intZohoField/index.js",
36993 "groupTitle": "Zoho_Fields"
36997 "url": "/api/integrations/zoho/fields/{id}",
36998 "title": "Deletes a Zoho Field",
37001 "title": "Example usage:",
37002 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37006 "name": "DeleteZoho_Fields",
37007 "group": "Zoho_Fields",
37008 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37009 "version": "0.0.0",
37010 "filename": "server/api/intZohoField/index.js",
37011 "groupTitle": "Zoho_Fields"
37015 "url": "/api/integrations/zoho/fields",
37016 "title": "Gets a list of Zoho Fields",
37019 "title": "Example usage:",
37020 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37024 "name": "GetZoho_Fields",
37025 "group": "Zoho_Fields",
37026 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37027 "version": "0.0.0",
37028 "filename": "server/api/intZohoField/index.js",
37029 "groupTitle": "Zoho_Fields"
37033 "url": "/api/integrations/zoho/fields/{id}",
37034 "title": "Gets a single Zoho Field",
37037 "title": "Example usage:",
37038 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37042 "name": "ShowZoho_Fields",
37043 "group": "Zoho_Fields",
37044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37045 "version": "0.0.0",
37046 "filename": "server/api/intZohoField/index.js",
37047 "groupTitle": "Zoho_Fields"
37051 "url": "/api/integrations/zoho/fields/{id}",
37052 "title": "Update an existing Zoho Field",
37055 "title": "Example usage:",
37056 "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",
37060 "name": "updateZoho_Fields",
37061 "group": "Zoho_Fields",
37062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37063 "version": "0.0.0",
37064 "filename": "server/api/intZohoField/index.js",
37065 "groupTitle": "Zoho_Fields"
37070 "title": "Creates a new Cdr",
37073 "title": "Example usage:",
37074 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37078 "name": "CreateCdrs",
37087 "field": "calldate",
37115 "field": "dcontext",
37122 "field": "channel",
37129 "field": "dstchannel",
37136 "field": "lastapp",
37143 "field": "lastdata",
37150 "field": "duration",
37157 "field": "billsec",
37164 "field": "disposition",
37171 "field": "amaflags",
37178 "field": "accountcode",
37185 "field": "userfield",
37192 "field": "uniqueid",
37199 "field": "linkedid",
37206 "field": "sequence",
37213 "field": "peeraccount",
37233 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37234 "version": "0.0.0",
37235 "filename": "server/api/cdr/index.js",
37236 "groupTitle": "cdr"
37240 "url": "/api/cdr/{id}",
37241 "title": "Deletes a Cdr",
37244 "title": "Example usage:",
37245 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37249 "name": "DeleteCdrs",
37251 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37252 "version": "0.0.0",
37253 "filename": "server/api/cdr/index.js",
37254 "groupTitle": "cdr"
37258 "url": "/api/cdr/describe",
37259 "title": "Gets table info about Cdrs",
37262 "title": "Example usage:",
37263 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37267 "name": "DescribeCdrs",
37269 "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>",
37270 "version": "0.0.0",
37271 "filename": "server/api/cdr/index.js",
37272 "groupTitle": "cdr"
37277 "title": "Gets a list of Cdrs",
37280 "title": "Example usage:",
37281 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37287 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37288 "version": "0.0.0",
37289 "filename": "server/api/cdr/index.js",
37290 "groupTitle": "cdr"
37294 "url": "/api/cdr/{id}",
37295 "title": "Gets a single Cdr",
37298 "title": "Example usage:",
37299 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37303 "name": "ShowCdrs",
37305 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37306 "version": "0.0.0",
37307 "filename": "server/api/cdr/index.js",
37308 "groupTitle": "cdr"
37312 "url": "/api/cdr/{id}",
37313 "title": "Update an existing Cdr",
37316 "title": "Example usage:",
37317 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37321 "name": "updateCdrs",
37323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37324 "version": "0.0.0",
37325 "filename": "server/api/cdr/index.js",
37326 "groupTitle": "cdr"
37330 "url": "/api/voiceQueuesLog",
37331 "title": "Creates a new VoiceQueuesLog",
37334 "title": "Example usage:",
37335 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37339 "name": "CreateVoiceQueuesLogs",
37340 "group": "voiceQueuesLog",
37362 "field": "queuename",
37431 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37432 "version": "0.0.0",
37433 "filename": "server/api/voiceQueuesLog/index.js",
37434 "groupTitle": "voiceQueuesLog"
37438 "url": "/api/voiceQueuesLog/{id}",
37439 "title": "Deletes a VoiceQueuesLog",
37442 "title": "Example usage:",
37443 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37447 "name": "DeleteVoiceQueuesLogs",
37448 "group": "voiceQueuesLog",
37449 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37450 "version": "0.0.0",
37451 "filename": "server/api/voiceQueuesLog/index.js",
37452 "groupTitle": "voiceQueuesLog"
37456 "url": "/api/voiceQueuesLog",
37457 "title": "Gets a list of VoiceQueuesLogs",
37460 "title": "Example usage:",
37461 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37465 "name": "GetVoiceQueuesLogs",
37466 "group": "voiceQueuesLog",
37467 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37468 "version": "0.0.0",
37469 "filename": "server/api/voiceQueuesLog/index.js",
37470 "groupTitle": "voiceQueuesLog"
37474 "url": "/api/voiceQueuesLog/{id}",
37475 "title": "Gets a single VoiceQueuesLog",
37478 "title": "Example usage:",
37479 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37483 "name": "ShowVoiceQueuesLogs",
37484 "group": "voiceQueuesLog",
37485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37486 "version": "0.0.0",
37487 "filename": "server/api/voiceQueuesLog/index.js",
37488 "groupTitle": "voiceQueuesLog"
37492 "url": "/api/voiceQueuesLog/{id}",
37493 "title": "Update an existing VoiceQueuesLog",
37496 "title": "Example usage:",
37497 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37501 "name": "updateVoiceQueuesLogs",
37502 "group": "voiceQueuesLog",
37503 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37504 "version": "0.0.0",
37505 "filename": "server/api/voiceQueuesLog/index.js",
37506 "groupTitle": "voiceQueuesLog"