4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/google",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authGoogle/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/local",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authLocal/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/automations",
1381 "title": "Creates a new Automation",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1389 "name": "CreateAutomations",
1390 "group": "Automations",
1412 "field": "description",
1432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1434 "filename": "server/api/automation/index.js",
1435 "groupTitle": "Automations"
1439 "url": "/api/automations/{id}",
1440 "title": "Deletes a Automation",
1443 "title": "Example usage:",
1444 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1448 "name": "DeleteAutomations",
1449 "group": "Automations",
1450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1452 "filename": "server/api/automation/index.js",
1453 "groupTitle": "Automations"
1457 "url": "/api/automations",
1458 "title": "Gets a list of Automations",
1461 "title": "Example usage:",
1462 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1466 "name": "GetAutomations",
1467 "group": "Automations",
1468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1470 "filename": "server/api/automation/index.js",
1471 "groupTitle": "Automations"
1475 "url": "/api/automations/{id}",
1476 "title": "Gets a single Automation",
1479 "title": "Example usage:",
1480 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1484 "name": "ShowAutomations",
1485 "group": "Automations",
1486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488 "filename": "server/api/automation/index.js",
1489 "groupTitle": "Automations"
1493 "url": "/api/automations/{id}/actions",
1494 "title": "Creates new actions",
1497 "title": "Example usage:",
1498 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1502 "name": "addActions",
1503 "group": "Automations",
1519 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1526 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1533 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1540 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1575 "filename": "server/api/automation/index.js",
1576 "groupTitle": "Automations"
1580 "url": "/api/automations/{id}/conditions",
1581 "title": "Creates new conditions",
1584 "title": "Example usage:",
1585 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1589 "name": "addConditions",
1590 "group": "Automations",
1612 "field": "operator",
1625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1627 "filename": "server/api/automation/index.js",
1628 "groupTitle": "Automations"
1632 "url": "/api/automations/{id}/actions",
1633 "title": "Gets Automation Actions",
1636 "title": "Example usage:",
1637 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1641 "name": "getActions",
1642 "group": "Automations",
1643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1645 "filename": "server/api/automation/index.js",
1646 "groupTitle": "Automations"
1650 "url": "/api/automations/{id}/conditions",
1651 "title": "Gets Automation Conditions",
1654 "title": "Example usage:",
1655 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1659 "name": "getConditions",
1660 "group": "Automations",
1661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1663 "filename": "server/api/automation/index.js",
1664 "groupTitle": "Automations"
1668 "url": "/api/automations/{id}",
1669 "title": "Update an existing Automation",
1672 "title": "Example usage:",
1673 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1677 "name": "updateAutomations",
1678 "group": "Automations",
1679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/canned_answers",
1687 "title": "Create a new canned answer",
1690 "title": "Example usage:",
1691 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1696 "group": "Canned_Answers",
1697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699 "filename": "server/api/cannedAnswer/index.js",
1700 "groupTitle": "Canned_Answers"
1704 "url": "/api/canned_answers/{id}",
1705 "title": "Deletes a Canned Answer",
1708 "title": "Example usage:",
1709 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1713 "name": "DeleteCanned_Answers",
1714 "group": "Canned_Answers",
1715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1717 "filename": "server/api/cannedAnswer/index.js",
1718 "groupTitle": "Canned_Answers"
1722 "url": "/api/canned_answers",
1723 "title": "Gets a list of Canned Answers",
1726 "title": "Example usage:",
1727 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1731 "name": "GetCanned_Answers",
1732 "group": "Canned_Answers",
1733 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1735 "filename": "server/api/cannedAnswer/index.js",
1736 "groupTitle": "Canned_Answers"
1740 "url": "/api/canned_answers/{id}",
1741 "title": "Gets a single Canned Answer",
1744 "title": "Example usage:",
1745 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1749 "name": "ShowCanned_Answers",
1750 "group": "Canned_Answers",
1751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753 "filename": "server/api/cannedAnswer/index.js",
1754 "groupTitle": "Canned_Answers"
1758 "url": "/api/canned_answers/{id}",
1759 "title": "Update an existing Canned Answer",
1762 "title": "Example usage:",
1763 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1767 "name": "updateCanned_Answers",
1768 "group": "Canned_Answers",
1769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771 "filename": "server/api/cannedAnswer/index.js",
1772 "groupTitle": "Canned_Answers"
1776 "url": "/chat/internal/users",
1777 "title": "Gets Users Last Messages",
1780 "title": "Example usage:",
1781 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1785 "name": "getLastUsersMessages",
1786 "group": "ChatInternalMessage",
1787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1789 "filename": "server/api/chatInternalMessage/index.js",
1790 "groupTitle": "ChatInternalMessage"
1794 "url": "/api/chat/applications/{id}",
1795 "title": "Deletes a Application",
1798 "title": "Example usage:",
1799 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1803 "name": "DeleteApplications",
1804 "group": "Chat_Applications",
1805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1807 "filename": "server/api/chatApplication/index.js",
1808 "groupTitle": "Chat_Applications"
1812 "url": "/api/chat/applications/{id}",
1813 "title": "Gets a single Application",
1816 "title": "Example usage:",
1817 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1821 "name": "ShowApplications",
1822 "group": "Chat_Applications",
1823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825 "filename": "server/api/chatApplication/index.js",
1826 "groupTitle": "Chat_Applications"
1830 "url": "/api/chat/applications/{id}",
1831 "title": "Update an existing Application",
1834 "title": "Example usage:",
1835 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1839 "name": "updateApplications",
1840 "group": "Chat_Applications",
1841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843 "filename": "server/api/chatApplication/index.js",
1844 "groupTitle": "Chat_Applications"
1848 "url": "/api/chat/groups",
1849 "title": "Creates a new Group",
1852 "title": "Example usage:",
1853 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1857 "name": "CreateGroups",
1858 "group": "Chat_Groups",
1873 "field": "description",
1886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1888 "filename": "server/api/chatGroup/index.js",
1889 "groupTitle": "Chat_Groups"
1893 "url": "/api/chat/groups/{id}",
1894 "title": "Deletes a Group",
1897 "title": "Example usage:",
1898 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1902 "name": "DeleteGroups",
1903 "group": "Chat_Groups",
1904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1906 "filename": "server/api/chatGroup/index.js",
1907 "groupTitle": "Chat_Groups"
1911 "url": "/api/chat/groups/describe",
1912 "title": "Gets table info about Groups",
1915 "title": "Example usage:",
1916 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1920 "name": "DescribeGroups",
1921 "group": "Chat_Groups",
1922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1924 "filename": "server/api/chatGroup/index.js",
1925 "groupTitle": "Chat_Groups"
1929 "url": "/api/chat/groups",
1930 "title": "Gets a list of Groups",
1933 "title": "Example usage:",
1934 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1938 "name": "GetGroups",
1939 "group": "Chat_Groups",
1940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1942 "filename": "server/api/chatGroup/index.js",
1943 "groupTitle": "Chat_Groups"
1947 "url": "/api/chat/groups/{id}/members",
1948 "title": "Removes members from a group",
1951 "title": "Example usage:",
1952 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1956 "name": "RemoveMembers",
1957 "group": "Chat_Groups",
1958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1960 "filename": "server/api/chatGroup/index.js",
1961 "groupTitle": "Chat_Groups"
1965 "url": "/api/chat/groups/{id}",
1966 "title": "Gets a single Group",
1969 "title": "Example usage:",
1970 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1974 "name": "ShowGroups",
1975 "group": "Chat_Groups",
1976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978 "filename": "server/api/chatGroup/index.js",
1979 "groupTitle": "Chat_Groups"
1983 "url": "/api/chat/groups/{id}/members",
1984 "title": "Add members to chat group",
1987 "title": "Example usage:",
1988 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1992 "name": "addMembers",
1993 "group": "Chat_Groups",
1994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1996 "filename": "server/api/chatGroup/index.js",
1997 "groupTitle": "Chat_Groups"
2001 "url": "/api/chat/groups/{id}/messages",
2002 "title": "Creates a new group message",
2005 "title": "Example usage:",
2006 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2010 "name": "addMessage",
2011 "group": "Chat_Groups",
2012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014 "filename": "server/api/chatGroup/index.js",
2015 "groupTitle": "Chat_Groups"
2019 "url": "/api/chat/groups/{id}/members",
2020 "title": "Gets Members",
2023 "title": "Example usage:",
2024 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2028 "name": "getMembers",
2029 "group": "Chat_Groups",
2030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032 "filename": "server/api/chatGroup/index.js",
2033 "groupTitle": "Chat_Groups"
2037 "url": "/api/chat/groups/{id}/messages",
2038 "title": "Gets Messages",
2041 "title": "Example usage:",
2042 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2046 "name": "getMessages",
2047 "group": "Chat_Groups",
2048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050 "filename": "server/api/chatGroup/index.js",
2051 "groupTitle": "Chat_Groups"
2055 "url": "/api/chat/groups/{id}/unread",
2056 "title": "Get unread chat group messages",
2059 "title": "Example usage:",
2060 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2065 "group": "Chat_Groups",
2066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068 "filename": "server/api/chatGroup/index.js",
2069 "groupTitle": "Chat_Groups"
2073 "url": "/api/chat/groups/{id}",
2074 "title": "Update an existing Group",
2077 "title": "Example usage:",
2078 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2082 "name": "updateGroups",
2083 "group": "Chat_Groups",
2084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086 "filename": "server/api/chatGroup/index.js",
2087 "groupTitle": "Chat_Groups"
2091 "url": "/api/chat/interactions/{id}/tags",
2092 "title": "Add tags to the interaction",
2095 "title": "Example usage:",
2096 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2101 "group": "Chat_Interactions",
2102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104 "filename": "server/api/chatInteraction/index.js",
2105 "groupTitle": "Chat_Interactions"
2109 "url": "/api/chat/interactions",
2110 "title": "Creates a new Interaction",
2113 "title": "Example usage:",
2114 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2118 "name": "CreateInteractions",
2119 "group": "Chat_Interactions",
2134 "field": "ratingValue",
2145 "field": "ratingType",
2152 "field": "ratingMessage",
2159 "field": "pathTranscript",
2166 "field": "mailTranscript",
2173 "field": "closedAt",
2180 "field": "disposition",
2194 "field": "browserName",
2201 "field": "browserVersion",
2215 "field": "osVersion",
2222 "field": "deviceModel",
2229 "field": "deviceVendor",
2236 "field": "deviceType",
2250 "field": "customerIp",
2257 "field": "formData",
2264 "field": "read1stAt",
2271 "field": "lastMsgAt",
2282 "field": "lastMsgDirection",
2289 "field": "closeReason",
2296 "field": "customerPort",
2303 "field": "vidaooSessionId",
2309 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2311 "filename": "server/api/chatInteraction/index.js",
2312 "groupTitle": "Chat_Interactions"
2316 "url": "/api/chat/interactions/{id}",
2317 "title": "Deletes a Interaction",
2320 "title": "Example usage:",
2321 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2325 "name": "DeleteInteractions",
2326 "group": "Chat_Interactions",
2327 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2329 "filename": "server/api/chatInteraction/index.js",
2330 "groupTitle": "Chat_Interactions"
2334 "url": "/api/chat/interactions/describe",
2335 "title": "Gets table info about Interactions",
2338 "title": "Example usage:",
2339 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2343 "name": "DescribeInteractions",
2344 "group": "Chat_Interactions",
2345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2347 "filename": "server/api/chatInteraction/index.js",
2348 "groupTitle": "Chat_Interactions"
2352 "url": "/api/chat/interactions",
2353 "title": "Gets a list of Interactions",
2356 "title": "Example usage:",
2357 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2361 "name": "GetInteractions",
2362 "group": "Chat_Interactions",
2363 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2365 "filename": "server/api/chatInteraction/index.js",
2366 "groupTitle": "Chat_Interactions"
2370 "url": "/api/chat/interactions/{id}/tags",
2371 "title": "Removes tags from interaction",
2374 "title": "Example usage:",
2375 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2379 "name": "RemoveTags",
2380 "group": "Chat_Interactions",
2381 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2383 "filename": "server/api/chatInteraction/index.js",
2384 "groupTitle": "Chat_Interactions"
2388 "url": "/api/chat/interactions/{id}",
2389 "title": "Gets a single Interaction",
2392 "title": "Example usage:",
2393 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2397 "name": "ShowInteractions",
2398 "group": "Chat_Interactions",
2399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2401 "filename": "server/api/chatInteraction/index.js",
2402 "groupTitle": "Chat_Interactions"
2406 "url": "/api/chat/interactions/{id}/abandon",
2407 "title": "Abandon interaction",
2410 "title": "Example usage:",
2411 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2416 "group": "Chat_Interactions",
2417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2419 "filename": "server/api/chatInteraction/index.js",
2420 "groupTitle": "Chat_Interactions"
2424 "url": "/api/chat/interactions/{id}/close",
2425 "title": "Close Interaction",
2428 "title": "Example usage:",
2429 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2433 "name": "addMessage",
2434 "group": "Chat_Interactions",
2435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2437 "filename": "server/api/chatInteraction/index.js",
2438 "groupTitle": "Chat_Interactions"
2442 "url": "/api/chat/interactions/{id}/messages",
2443 "title": "Creates new messages",
2446 "title": "Example usage:",
2447 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2451 "name": "addMessage",
2452 "group": "Chat_Interactions",
2485 "field": "direction",
2498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2500 "filename": "server/api/chatInteraction/index.js",
2501 "groupTitle": "Chat_Interactions"
2505 "url": "/api/chat/interactions/{id}/attachment_upload",
2506 "title": "Add attachment",
2509 "title": "Example usage:",
2510 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2514 "name": "attachmentUpload",
2515 "group": "Chat_Interactions",
2516 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2518 "filename": "server/api/chatInteraction/index.js",
2519 "groupTitle": "Chat_Interactions"
2523 "url": "/api/chat/interactions/{id}/vidaoo",
2524 "title": "Create Vidaoo Session",
2527 "title": "Example usage:",
2528 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2532 "name": "createVidaooSession",
2533 "group": "Chat_Interactions",
2534 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2536 "filename": "server/api/chatInteraction/index.js",
2537 "groupTitle": "Chat_Interactions"
2541 "url": "/api/chat/interactions/{id}/custom_update",
2542 "title": "Update interaction",
2545 "title": "Example usage:",
2546 "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2550 "name": "customUpdate",
2551 "group": "Chat_Interactions",
2552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2554 "filename": "server/api/chatInteraction/index.js",
2555 "groupTitle": "Chat_Interactions"
2559 "url": "/api/chat/interactions/{id}/download",
2560 "title": "Gets interaction",
2563 "title": "Example usage:",
2564 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2569 "group": "Chat_Interactions",
2570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2572 "filename": "server/api/chatInteraction/index.js",
2573 "groupTitle": "Chat_Interactions"
2577 "url": "/api/chat/interactions/{id}/messages",
2578 "title": "Gets interaction messages",
2581 "title": "Example usage:",
2582 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2586 "name": "getMessages",
2587 "group": "Chat_Interactions",
2588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2590 "filename": "server/api/chatInteraction/index.js",
2591 "groupTitle": "Chat_Interactions"
2595 "url": "/api/chat/interactions/{id}/my_messages",
2596 "title": "Gets interaction messages",
2599 "title": "Example usage:",
2600 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2604 "name": "getMyMessages",
2605 "group": "Chat_Interactions",
2606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2608 "filename": "server/api/chatInteraction/index.js",
2609 "groupTitle": "Chat_Interactions"
2613 "url": "/api/chat/interactions/{id}",
2614 "title": "Update an existing Interaction",
2617 "title": "Example usage:",
2618 "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2622 "name": "updateInteractions",
2623 "group": "Chat_Interactions",
2624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2626 "filename": "server/api/chatInteraction/index.js",
2627 "groupTitle": "Chat_Interactions"
2631 "url": "/api/chat/internal/messages",
2632 "title": "Creates a new Message",
2635 "title": "Example usage:",
2636 "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2640 "name": "CreateMessages",
2641 "group": "Chat_Internal_Messages",
2663 "field": "ChatInternalMessageId",
2669 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2671 "filename": "server/api/chatInternalMessage/index.js",
2672 "groupTitle": "Chat_Internal_Messages"
2676 "url": "/api/chat/internal/messages/{id}",
2677 "title": "Deletes a Message",
2680 "title": "Example usage:",
2681 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2685 "name": "DeleteMessages",
2686 "group": "Chat_Internal_Messages",
2687 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2689 "filename": "server/api/chatInternalMessage/index.js",
2690 "groupTitle": "Chat_Internal_Messages"
2694 "url": "/api/chat/internal/messages/describe",
2695 "title": "Gets table info about Messages",
2698 "title": "Example usage:",
2699 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2703 "name": "DescribeMessages",
2704 "group": "Chat_Internal_Messages",
2705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2707 "filename": "server/api/chatInternalMessage/index.js",
2708 "groupTitle": "Chat_Internal_Messages"
2712 "url": "/api/chat/internal/messages",
2713 "title": "Gets a list of Messages",
2716 "title": "Example usage:",
2717 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2721 "name": "GetMessages",
2722 "group": "Chat_Internal_Messages",
2723 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2725 "filename": "server/api/chatInternalMessage/index.js",
2726 "groupTitle": "Chat_Internal_Messages"
2730 "url": "/api/chat/internal/messages/{id}",
2731 "title": "Gets a single Message",
2734 "title": "Example usage:",
2735 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2739 "name": "ShowMessages",
2740 "group": "Chat_Internal_Messages",
2741 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2743 "filename": "server/api/chatInternalMessage/index.js",
2744 "groupTitle": "Chat_Internal_Messages"
2748 "url": "/api/chat/internal/messages/{id}",
2749 "title": "Update an existing Message",
2752 "title": "Example usage:",
2753 "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2757 "name": "updateMessages",
2758 "group": "Chat_Internal_Messages",
2759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2761 "filename": "server/api/chatInternalMessage/index.js",
2762 "groupTitle": "Chat_Internal_Messages"
2766 "url": "/api/chat/messages",
2767 "title": "Creates a new Message",
2770 "title": "Example usage:",
2771 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2775 "name": "CreateMessages",
2776 "group": "Chat_Messages",
2809 "field": "direction",
2822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2824 "filename": "server/api/chatMessage/index.js",
2825 "groupTitle": "Chat_Messages"
2829 "url": "/api/chat/messages/{id}",
2830 "title": "Deletes a Message",
2833 "title": "Example usage:",
2834 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2838 "name": "DeleteMessages",
2839 "group": "Chat_Messages",
2840 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2842 "filename": "server/api/chatMessage/index.js",
2843 "groupTitle": "Chat_Messages"
2847 "url": "/api/chat/messages/describe",
2848 "title": "Gets table info about Messages",
2851 "title": "Example usage:",
2852 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2856 "name": "DescribeMessages",
2857 "group": "Chat_Messages",
2858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2860 "filename": "server/api/chatMessage/index.js",
2861 "groupTitle": "Chat_Messages"
2865 "url": "/api/chat/messages",
2866 "title": "Gets a list of Messages",
2869 "title": "Example usage:",
2870 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2874 "name": "GetMessages",
2875 "group": "Chat_Messages",
2876 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2878 "filename": "server/api/chatMessage/index.js",
2879 "groupTitle": "Chat_Messages"
2883 "url": "/api/chat/messages/{id}",
2884 "title": "Gets a single Message",
2887 "title": "Example usage:",
2888 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2892 "name": "ShowMessages",
2893 "group": "Chat_Messages",
2894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2896 "filename": "server/api/chatMessage/index.js",
2897 "groupTitle": "Chat_Messages"
2901 "url": "/api/chat/messages/{id}",
2902 "title": "Update an existing Message",
2905 "title": "Example usage:",
2906 "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2910 "name": "updateMessages",
2911 "group": "Chat_Messages",
2912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2914 "filename": "server/api/chatMessage/index.js",
2915 "groupTitle": "Chat_Messages"
2919 "url": "/api/chat/offline_messages",
2920 "title": "Creates a new OfflineMessage",
2923 "title": "Example usage:",
2924 "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2928 "name": "CreateOfflineMessages",
2929 "group": "Chat_Offline_Messages",
2943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2945 "filename": "server/api/chatOfflineMessage/index.js",
2946 "groupTitle": "Chat_Offline_Messages"
2950 "url": "/api/chat/offline_messages/{id}",
2951 "title": "Deletes a OfflineMessage",
2954 "title": "Example usage:",
2955 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2959 "name": "DeleteOfflineMessages",
2960 "group": "Chat_Offline_Messages",
2961 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2963 "filename": "server/api/chatOfflineMessage/index.js",
2964 "groupTitle": "Chat_Offline_Messages"
2968 "url": "/api/chat/offline_messages/describe",
2969 "title": "Gets table info about OfflineMessages",
2972 "title": "Example usage:",
2973 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
2977 "name": "DescribeOfflineMessages",
2978 "group": "Chat_Offline_Messages",
2979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2981 "filename": "server/api/chatOfflineMessage/index.js",
2982 "groupTitle": "Chat_Offline_Messages"
2986 "url": "/api/chat/offline_messages",
2987 "title": "Gets a list of OfflineMessages",
2990 "title": "Example usage:",
2991 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
2995 "name": "GetOfflineMessages",
2996 "group": "Chat_Offline_Messages",
2997 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2999 "filename": "server/api/chatOfflineMessage/index.js",
3000 "groupTitle": "Chat_Offline_Messages"
3004 "url": "/api/chat/offline_messages/{id}",
3005 "title": "Gets a single OfflineMessage",
3008 "title": "Example usage:",
3009 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3013 "name": "ShowOfflineMessages",
3014 "group": "Chat_Offline_Messages",
3015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3017 "filename": "server/api/chatOfflineMessage/index.js",
3018 "groupTitle": "Chat_Offline_Messages"
3022 "url": "/api/chat/offline_messages/{id}",
3023 "title": "Update an existing OfflineMessage",
3026 "title": "Example usage:",
3027 "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3031 "name": "updateOfflineMessages",
3032 "group": "Chat_Offline_Messages",
3033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3035 "filename": "server/api/chatOfflineMessage/index.js",
3036 "groupTitle": "Chat_Offline_Messages"
3040 "url": "/api/chat/proactive_actions",
3041 "title": "Creates a new Proactive Action",
3044 "title": "Example usage:",
3045 "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3049 "name": "CreateProactive_Actions",
3050 "group": "Chat_Proactive_Actions",
3076 "field": "selector",
3089 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3091 "filename": "server/api/chatProactiveAction/index.js",
3092 "groupTitle": "Chat_Proactive_Actions"
3096 "url": "/api/chat/proactive_actions/{id}",
3097 "title": "Deletes a Proactive Action",
3100 "title": "Example usage:",
3101 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3105 "name": "DeleteProactive_Actions",
3106 "group": "Chat_Proactive_Actions",
3107 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3109 "filename": "server/api/chatProactiveAction/index.js",
3110 "groupTitle": "Chat_Proactive_Actions"
3114 "url": "/api/chat/proactive_actions/{id}",
3115 "title": "Gets a single Proactive Action",
3118 "title": "Example usage:",
3119 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3123 "name": "ShowProactive_Actions",
3124 "group": "Chat_Proactive_Actions",
3125 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3127 "filename": "server/api/chatProactiveAction/index.js",
3128 "groupTitle": "Chat_Proactive_Actions"
3132 "url": "/api/chat/proactive_actions/{id}",
3133 "title": "Update an existing Proactive Action",
3136 "title": "Example usage:",
3137 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3141 "name": "updateProactive_Actions",
3142 "group": "Chat_Proactive_Actions",
3143 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3145 "filename": "server/api/chatProactiveAction/index.js",
3146 "groupTitle": "Chat_Proactive_Actions"
3150 "url": "/api/chat/reports/queue",
3151 "title": "Creates a new Chat Queue Report",
3154 "title": "Example usage:",
3155 "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3159 "name": "CreateChat_Queue_Reports",
3160 "group": "Chat_Queue_Reports",
3168 "field": "uniqueid",
3196 "field": "acceptAt",
3216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3218 "filename": "server/api/chatQueueReport/index.js",
3219 "groupTitle": "Chat_Queue_Reports"
3223 "url": "/api/chat/reports/queue/{id}",
3224 "title": "Deletes a Chat Queue Report",
3227 "title": "Example usage:",
3228 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3232 "name": "DeleteChat_Queue_Reports",
3233 "group": "Chat_Queue_Reports",
3234 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3236 "filename": "server/api/chatQueueReport/index.js",
3237 "groupTitle": "Chat_Queue_Reports"
3241 "url": "/api/chat/reports/queue/describe",
3242 "title": "Gets table info about Chat Queue Reports",
3245 "title": "Example usage:",
3246 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3250 "name": "DescribeChat_Queue_Reports",
3251 "group": "Chat_Queue_Reports",
3252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3254 "filename": "server/api/chatQueueReport/index.js",
3255 "groupTitle": "Chat_Queue_Reports"
3259 "url": "/api/chat/reports/queue",
3260 "title": "Gets a list of Chat Queue Reports",
3263 "title": "Example usage:",
3264 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3268 "name": "GetChat_Queue_Reports",
3269 "group": "Chat_Queue_Reports",
3270 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3272 "filename": "server/api/chatQueueReport/index.js",
3273 "groupTitle": "Chat_Queue_Reports"
3277 "url": "/api/chat/reports/queue/{id}",
3278 "title": "Gets a single Chat Queue Report",
3281 "title": "Example usage:",
3282 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3286 "name": "ShowChat_Queue_Reports",
3287 "group": "Chat_Queue_Reports",
3288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3290 "filename": "server/api/chatQueueReport/index.js",
3291 "groupTitle": "Chat_Queue_Reports"
3295 "url": "/api/chat/reports/queue/{id}",
3296 "title": "Update an existing Chat Queue Report",
3299 "title": "Example usage:",
3300 "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3304 "name": "updateChat_Queue_Reports",
3305 "group": "Chat_Queue_Reports",
3306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3308 "filename": "server/api/chatQueueReport/index.js",
3309 "groupTitle": "Chat_Queue_Reports"
3313 "url": "/api/chat/queues/{id}/users",
3314 "title": "Add agents to a queue",
3317 "title": "Example usage:",
3318 "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3322 "name": "AddAgents",
3323 "group": "Chat_Queues",
3324 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3326 "filename": "server/api/chatQueue/index.js",
3327 "groupTitle": "Chat_Queues"
3331 "url": "/api/chat/queues/{id}/teams",
3332 "title": "Add teams to a queue",
3335 "title": "Example usage:",
3336 "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3341 "group": "Chat_Queues",
3342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3344 "filename": "server/api/chatQueue/index.js",
3345 "groupTitle": "Chat_Queues"
3349 "url": "/api/chat/queues",
3350 "title": "Creates a new Queue",
3353 "title": "Example usage:",
3354 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3358 "name": "CreateQueues",
3359 "group": "Chat_Queues",
3374 "field": "description",
3393 "field": "strategy",
3399 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3401 "filename": "server/api/chatQueue/index.js",
3402 "groupTitle": "Chat_Queues"
3406 "url": "/api/chat/queues/{id}",
3407 "title": "Deletes a Queue",
3410 "title": "Example usage:",
3411 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3415 "name": "DeleteQueues",
3416 "group": "Chat_Queues",
3417 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3419 "filename": "server/api/chatQueue/index.js",
3420 "groupTitle": "Chat_Queues"
3424 "url": "/api/chat/queues/describe",
3425 "title": "Gets table info about Queues",
3428 "title": "Example usage:",
3429 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3433 "name": "DescribeQueues",
3434 "group": "Chat_Queues",
3435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3437 "filename": "server/api/chatQueue/index.js",
3438 "groupTitle": "Chat_Queues"
3442 "url": "/api/chat/queues/{id}/users",
3443 "title": "Gets queue agents",
3446 "title": "Example usage:",
3447 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3451 "name": "GetAgents",
3452 "group": "Chat_Queues",
3453 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3455 "filename": "server/api/chatQueue/index.js",
3456 "groupTitle": "Chat_Queues"
3460 "url": "/api/chat/queues/{id}/members",
3461 "title": "GetMembers",
3464 "title": "Example usage:",
3465 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3469 "name": "GetMembers",
3470 "group": "Chat_Queues",
3471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3473 "filename": "server/api/chatQueue/index.js",
3474 "groupTitle": "Chat_Queues"
3478 "url": "/api/chat/queues",
3479 "title": "Gets a list of Queues",
3482 "title": "Example usage:",
3483 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3487 "name": "GetQueues",
3488 "group": "Chat_Queues",
3489 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3491 "filename": "server/api/chatQueue/index.js",
3492 "groupTitle": "Chat_Queues"
3496 "url": "/api/chat/queues/{id}/teams",
3497 "title": "Gets queues list",
3500 "title": "Example usage:",
3501 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3506 "group": "Chat_Queues",
3507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3509 "filename": "server/api/chatQueue/index.js",
3510 "groupTitle": "Chat_Queues"
3514 "url": "/api/chat/queues/{id}/users",
3515 "title": "Removes agents from a queue",
3518 "title": "Example usage:",
3519 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3523 "name": "RemoveAgents",
3524 "group": "Chat_Queues",
3525 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3527 "filename": "server/api/chatQueue/index.js",
3528 "groupTitle": "Chat_Queues"
3532 "url": "/api/chat/queues/{id}",
3533 "title": "Gets a single Queue",
3536 "title": "Example usage:",
3537 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3541 "name": "ShowQueues",
3542 "group": "Chat_Queues",
3543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3545 "filename": "server/api/chatQueue/index.js",
3546 "groupTitle": "Chat_Queues"
3550 "url": "/api/chat/queues/{id}",
3551 "title": "Update an existing Queue",
3554 "title": "Example usage:",
3555 "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3559 "name": "updateQueues",
3560 "group": "Chat_Queues",
3561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3563 "filename": "server/api/chatQueue/index.js",
3564 "groupTitle": "Chat_Queues"
3568 "url": "/api/chat/reports/transfer",
3569 "title": "Creates a new Chat Transfer Report",
3572 "title": "Example usage:",
3573 "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3577 "name": "CreateChat_Transfer_Reports",
3578 "group": "Chat_Transfer_Reports",
3586 "field": "uniqueid",
3605 "field": "transferredAt",
3611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3613 "filename": "server/api/chatTransferReport/index.js",
3614 "groupTitle": "Chat_Transfer_Reports"
3618 "url": "/api/chat/reports/transfer/{id}",
3619 "title": "Deletes a Chat Transfer Report",
3622 "title": "Example usage:",
3623 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3627 "name": "DeleteChat_Transfer_Reports",
3628 "group": "Chat_Transfer_Reports",
3629 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3631 "filename": "server/api/chatTransferReport/index.js",
3632 "groupTitle": "Chat_Transfer_Reports"
3636 "url": "/api/chat/reports/transfer/describe",
3637 "title": "Gets table info about Chat Transfer Reports",
3640 "title": "Example usage:",
3641 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3645 "name": "DescribeChat_Transfer_Reports",
3646 "group": "Chat_Transfer_Reports",
3647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3649 "filename": "server/api/chatTransferReport/index.js",
3650 "groupTitle": "Chat_Transfer_Reports"
3654 "url": "/api/chat/reports/transfer",
3655 "title": "Gets a list of Chat Transfer Reports",
3658 "title": "Example usage:",
3659 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3663 "name": "GetChat_Transfer_Reports",
3664 "group": "Chat_Transfer_Reports",
3665 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3667 "filename": "server/api/chatTransferReport/index.js",
3668 "groupTitle": "Chat_Transfer_Reports"
3672 "url": "/api/chat/reports/transfer/{id}",
3673 "title": "Gets a single Chat Transfer Report",
3676 "title": "Example usage:",
3677 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3681 "name": "ShowChat_Transfer_Reports",
3682 "group": "Chat_Transfer_Reports",
3683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3685 "filename": "server/api/chatTransferReport/index.js",
3686 "groupTitle": "Chat_Transfer_Reports"
3690 "url": "/api/chat/reports/transfer/{id}",
3691 "title": "Update an existing Chat Transfer Report",
3694 "title": "Example usage:",
3695 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3699 "name": "updateChat_Transfer_Reports",
3700 "group": "Chat_Transfer_Reports",
3701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3703 "filename": "server/api/chatTransferReport/index.js",
3704 "groupTitle": "Chat_Transfer_Reports"
3708 "url": "/api/chat/websites/{id}/users",
3709 "title": "Add agents to a website",
3712 "title": "Example usage:",
3713 "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3717 "name": "AddAgents",
3718 "group": "Chat_Websites",
3719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3721 "filename": "server/api/chatWebsite/index.js",
3722 "groupTitle": "Chat_Websites"
3726 "url": "/api/chat/websites",
3727 "title": "Creates a new Website",
3730 "title": "Example usage:",
3731 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3735 "name": "CreateWebsites",
3736 "group": "Chat_Websites",
3758 "field": "description",
3772 "field": "mapKeyOffline",
3786 "field": "agentAlias",
3793 "field": "customerAlias",
3807 "field": "color_button",
3814 "field": "textColor",
3821 "field": "fontSize",
3835 "field": "animation",
3846 "field": "header_shape",
3853 "field": "header_online",
3860 "field": "start_chat_button",
3867 "field": "offline_chat_button",
3874 "field": "header_offline",
3881 "field": "download_transcript",
3895 "field": "whiteLabel",
3902 "field": "defaultWhiteLabel",
3916 "field": "closingQuestion",
3923 "field": "formSubmitSuccessMessage",
3930 "field": "formSubmitFailureMessage",
3937 "field": "noteTitle",
3944 "field": "placeholderMessage",
3951 "field": "closingMessage",
3958 "field": "closingMessageButton",
3965 "field": "skipMessageButton",
3972 "field": "conditionAgreement",
3979 "field": "enableRating",
3986 "field": "enableFeedback",
3993 "field": "enableSendButton",
4000 "field": "feedbackTitle",
4011 "field": "ratingType",
4018 "field": "ratingStarsNumber",
4025 "field": "onlineForm",
4032 "field": "offlineForm",
4046 "field": "autoclose",
4053 "field": "enableCustomerWriting",
4060 "field": "forwardTranscript",
4067 "field": "forwardTranscriptMessage",
4074 "field": "forwardOffline",
4081 "field": "forwardOfflineAddress",
4088 "field": "waitingTitle",
4095 "field": "waitingMessage",
4102 "field": "offlineMessageSubject",
4109 "field": "offlineMessageBody",
4116 "field": "enableUnmanagedNote",
4123 "field": "unmanagedMessage",
4130 "field": "skipUnmanaged",
4137 "field": "sendUnmanaged",
4144 "field": "enableCustomerAttachment",
4151 "field": "enableCustomerCheckmarks",
4158 "field": "agentAvatar",
4165 "field": "showAgentAvatar",
4172 "field": "timezone",
4179 "field": "notificationTemplate",
4186 "field": "notificationSound",
4193 "field": "notificationShake",
4200 "field": "hideWhenOffline",
4207 "field": "agentIdentifier",
4214 "field": "waitForTheAssignedAgent",
4221 "field": "alignment",
4228 "field": "verticalAlignment",
4235 "field": "messagesAlignment",
4242 "field": "defaultTitle",
4249 "field": "customerAvatar",
4256 "field": "showCustomerAvatar",
4263 "field": "messageFontSize",
4270 "field": "backgroundColor",
4277 "field": "queueTransfer",
4284 "field": "queueTransferTimeout",
4291 "field": "agentTransfer",
4298 "field": "agentTransferTimeout",
4305 "field": "systemAlias",
4312 "field": "systemAvatar",
4319 "field": "mandatoryDispositionPauseId",
4320 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4326 "field": "mandatoryDisposition",
4327 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4333 "field": "vidaooEscalation",
4340 "field": "vidaooApiKey",
4346 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4348 "filename": "server/api/chatWebsite/index.js",
4349 "groupTitle": "Chat_Websites"
4353 "url": "/api/chat/websites/{id}",
4354 "title": "Deletes a Website",
4357 "title": "Example usage:",
4358 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4362 "name": "DeleteWebsites",
4363 "group": "Chat_Websites",
4364 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4366 "filename": "server/api/chatWebsite/index.js",
4367 "groupTitle": "Chat_Websites"
4371 "url": "/api/chat/websites/describe",
4372 "title": "Gets table info about Websites",
4375 "title": "Example usage:",
4376 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4380 "name": "DescribeWebsites",
4381 "group": "Chat_Websites",
4382 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4384 "filename": "server/api/chatWebsite/index.js",
4385 "groupTitle": "Chat_Websites"
4389 "url": "/api/chat/websites/{id}/users",
4390 "title": "Gets agents from website",
4393 "title": "Example usage:",
4394 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4398 "name": "GetAgents",
4399 "group": "Chat_Websites",
4400 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4402 "filename": "server/api/chatWebsite/index.js",
4403 "groupTitle": "Chat_Websites"
4407 "url": "/api/chat/websites",
4408 "title": "Gets a list of Websites",
4411 "title": "Example usage:",
4412 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4416 "name": "GetWebsites",
4417 "group": "Chat_Websites",
4418 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/websites?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/websites?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/websites?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/websites?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/websites?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4420 "filename": "server/api/chatWebsite/index.js",
4421 "groupTitle": "Chat_Websites"
4425 "url": "/api/chat/websites/{id}/users",
4426 "title": "Removes agents from a website",
4429 "title": "Example usage:",
4430 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4434 "name": "RemoveAgents",
4435 "group": "Chat_Websites",
4436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4438 "filename": "server/api/chatWebsite/index.js",
4439 "groupTitle": "Chat_Websites"
4443 "url": "/api/chat/websites/{id}/canned_answers",
4444 "title": "Removes canned answers from account",
4447 "title": "Example usage:",
4448 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4452 "name": "RemoveAnswers",
4453 "group": "Chat_Websites",
4454 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4456 "filename": "server/api/chatWebsite/index.js",
4457 "groupTitle": "Chat_Websites"
4461 "url": "/api/chat/websites/{id}/dispositions",
4462 "title": "Removes canned answers from account",
4465 "title": "Example usage:",
4466 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4470 "name": "RemoveDispositions",
4471 "group": "Chat_Websites",
4472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4474 "filename": "server/api/chatWebsite/index.js",
4475 "groupTitle": "Chat_Websites"
4479 "url": "/api/chat/websites/{id}",
4480 "title": "Gets a single Website",
4483 "title": "Example usage:",
4484 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4488 "name": "ShowWebsites",
4489 "group": "Chat_Websites",
4490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4492 "filename": "server/api/chatWebsite/index.js",
4493 "groupTitle": "Chat_Websites"
4497 "url": "/api/chat/messages/{id}/accept",
4498 "title": "Accepts message",
4501 "title": "Example usage:",
4502 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4506 "name": "acceptMessage",
4507 "group": "Chat_Websites",
4508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4510 "filename": "server/api/chatMessage/index.js",
4511 "groupTitle": "Chat_Websites"
4515 "url": "/api/chat/websites/{id}/canned_answers",
4516 "title": "Creates new canned answer",
4519 "title": "Example usage:",
4520 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4524 "name": "addAnswer",
4525 "group": "Chat_Websites",
4547 "field": "description",
4560 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4562 "filename": "server/api/chatWebsite/index.js",
4563 "groupTitle": "Chat_Websites"
4567 "url": "/api/chat/websites/{id}/applications",
4568 "title": "Creates new applications",
4571 "title": "Example usage:",
4572 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4576 "name": "addApplications",
4577 "group": "Chat_Websites",
4585 "field": "priority",
4606 "field": "description",
4613 "field": "interval",
4619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4621 "filename": "server/api/chatWebsite/index.js",
4622 "groupTitle": "Chat_Websites"
4626 "url": "/api/chat/websites/{id}/avatar",
4627 "title": "Add avatar",
4630 "title": "Example usage:",
4631 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4635 "name": "addAvatar",
4636 "group": "Chat_Websites",
4637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4639 "filename": "server/api/chatWebsite/index.js",
4640 "groupTitle": "Chat_Websites"
4644 "url": "/api/chat/websites/{id}/customer_avatar",
4645 "title": "Add customer avatar",
4648 "title": "Example usage:",
4649 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4653 "name": "addCustomerAvatar",
4654 "group": "Chat_Websites",
4655 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4657 "filename": "server/api/chatWebsite/index.js",
4658 "groupTitle": "Chat_Websites"
4662 "url": "/api/chat/websites/{id}/dispositions",
4663 "title": "Creates new disposition",
4666 "title": "Example usage:",
4667 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4671 "name": "addDisposition",
4672 "group": "Chat_Websites",
4686 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4688 "filename": "server/api/chatWebsite/index.js",
4689 "groupTitle": "Chat_Websites"
4693 "url": "/api/chat/accounts/{id}/interactions",
4694 "title": "Creates new interactions",
4697 "title": "Example usage:",
4698 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4702 "name": "addInteraction",
4703 "group": "Chat_Websites",
4718 "field": "ratingValue",
4729 "field": "ratingType",
4736 "field": "ratingMessage",
4743 "field": "pathTranscript",
4750 "field": "mailTranscript",
4757 "field": "closedAt",
4764 "field": "disposition",
4778 "field": "browserName",
4785 "field": "browserVersion",
4799 "field": "osVersion",
4806 "field": "deviceModel",
4813 "field": "deviceVendor",
4820 "field": "deviceType",
4834 "field": "customerIp",
4841 "field": "formData",
4848 "field": "read1stAt",
4855 "field": "lastMsgAt",
4866 "field": "lastMsgDirection",
4873 "field": "closeReason",
4880 "field": "customerPort",
4887 "field": "vidaooSessionId",
4893 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4895 "filename": "server/api/chatWebsite/index.js",
4896 "groupTitle": "Chat_Websites"
4900 "url": "/api/chat/websites/{id}/logo",
4901 "title": "Add logo",
4904 "title": "Example usage:",
4905 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4910 "group": "Chat_Websites",
4911 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4913 "filename": "server/api/chatWebsite/index.js",
4914 "groupTitle": "Chat_Websites"
4918 "url": "/api/chat/websites/{id}/proactive_actions",
4919 "title": "Creates new Proactive Actions",
4922 "title": "Example usage:",
4923 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4927 "name": "addProactiveActions",
4928 "group": "Chat_Websites",
4954 "field": "selector",
4967 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4969 "filename": "server/api/chatWebsite/index.js",
4970 "groupTitle": "Chat_Websites"
4974 "url": "/api/chat/websites/{id}/system_avatar",
4975 "title": "Add system avatar",
4978 "title": "Example usage:",
4979 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4983 "name": "addSystemAvatar",
4984 "group": "Chat_Websites",
4985 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4987 "filename": "server/api/chatWebsite/index.js",
4988 "groupTitle": "Chat_Websites"
4992 "url": "/api/chat/websites/{id}/canned_answers",
4993 "title": "Gets account canned answers",
4996 "title": "Example usage:",
4997 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5001 "name": "getAnswers",
5002 "group": "Chat_Websites",
5003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5005 "filename": "server/api/chatWebsite/index.js",
5006 "groupTitle": "Chat_Websites"
5010 "url": "/api/chat/websites/{id}/applications",
5011 "title": "Gets Website Applications",
5014 "title": "Example usage:",
5015 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5019 "name": "getApplications",
5020 "group": "Chat_Websites",
5021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5023 "filename": "server/api/chatWebsite/index.js",
5024 "groupTitle": "Chat_Websites"
5028 "url": "/api/chat/websites/{id}/avatar",
5029 "title": "Get avatar",
5032 "title": "Example usage:",
5033 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5037 "name": "getAvatar",
5038 "group": "Chat_Websites",
5039 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5041 "filename": "server/api/chatWebsite/index.js",
5042 "groupTitle": "Chat_Websites"
5046 "url": "/api/chat/websites/{id}/customer_avatar",
5047 "title": "Get Customer Avatar",
5050 "title": "Example usage:",
5051 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5055 "name": "getCustomerAvatar",
5056 "group": "Chat_Websites",
5057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5059 "filename": "server/api/chatWebsite/index.js",
5060 "groupTitle": "Chat_Websites"
5064 "url": "/api/chat/websites/{id}/dispositions",
5065 "title": "Gets account dispositions",
5068 "title": "Example usage:",
5069 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5073 "name": "getDispositions",
5074 "group": "Chat_Websites",
5075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5077 "filename": "server/api/chatWebsite/index.js",
5078 "groupTitle": "Chat_Websites"
5082 "url": "/api/chat/websites/{id}/fields",
5083 "title": "Gets Website Fields",
5086 "title": "Example usage:",
5087 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5091 "name": "getFields",
5092 "group": "Chat_Websites",
5093 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5095 "filename": "server/api/chatWebsite/index.js",
5096 "groupTitle": "Chat_Websites"
5100 "url": "/api/chat/websites/{id}/interactions",
5101 "title": "Gets Website Interactions",
5104 "title": "Example usage:",
5105 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5109 "name": "getInteraction",
5110 "group": "Chat_Websites",
5111 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5113 "filename": "server/api/chatWebsite/index.js",
5114 "groupTitle": "Chat_Websites"
5118 "url": "/api/chat/websites/{id}/logo",
5119 "title": "Get logo",
5122 "title": "Example usage:",
5123 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5128 "group": "Chat_Websites",
5129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5131 "filename": "server/api/chatWebsite/index.js",
5132 "groupTitle": "Chat_Websites"
5136 "url": "/api/chat/websites/{id}/offline_messages",
5137 "title": "Gets Website Offline Messages",
5140 "title": "Example usage:",
5141 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5145 "name": "getOfflineMessages",
5146 "group": "Chat_Websites",
5147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5149 "filename": "server/api/chatWebsite/index.js",
5150 "groupTitle": "Chat_Websites"
5154 "url": "/api/chat/websites/{id}/proactive_actions",
5155 "title": "Gets Website Proactive Actions",
5158 "title": "Example usage:",
5159 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5163 "name": "getProactiveActions",
5164 "group": "Chat_Websites",
5165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5167 "filename": "server/api/chatWebsite/index.js",
5168 "groupTitle": "Chat_Websites"
5172 "url": "/api/chat/websites/{id}/snippet",
5173 "title": "Gets Website Snippet",
5176 "title": "Example usage:",
5177 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5181 "name": "getSnippet",
5182 "group": "Chat_Websites",
5183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5185 "filename": "server/api/chatWebsite/index.js",
5186 "groupTitle": "Chat_Websites"
5190 "url": "/api/chat/websites/{id}/system_avatar",
5191 "title": "Get System Avatar",
5194 "title": "Example usage:",
5195 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5199 "name": "getSystemAvatar",
5200 "group": "Chat_Websites",
5201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5203 "filename": "server/api/chatWebsite/index.js",
5204 "groupTitle": "Chat_Websites"
5208 "url": "/api/chat/websites/{id}/notify",
5209 "title": "Notify new message",
5212 "title": "Example usage:",
5213 "content": "curl https://{domain}/api/chat/websites/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5218 "group": "Chat_Websites",
5219 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5221 "filename": "server/api/chatWebsite/index.js",
5222 "groupTitle": "Chat_Websites"
5226 "url": "/api/chat/websites/{id}/offline",
5227 "title": "Offline message",
5230 "title": "Example usage:",
5231 "content": "curl https://{domain}/api/chat/websites/{id}/offline -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5236 "group": "Chat_Websites",
5237 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5239 "filename": "server/api/chatWebsite/index.js",
5240 "groupTitle": "Chat_Websites"
5244 "url": "/api/chat/messages/{id}/reject",
5245 "title": "Rejects message",
5248 "title": "Example usage:",
5249 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5253 "name": "rejectMessage",
5254 "group": "Chat_Websites",
5255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5257 "filename": "server/api/chatMessage/index.js",
5258 "groupTitle": "Chat_Websites"
5262 "url": "/api/chat/websites/{id}",
5263 "title": "Update an existing Website",
5266 "title": "Example usage:",
5267 "content": "curl https://{domain}/api/chat/websites/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5271 "name": "updateWebsites",
5272 "group": "Chat_Websites",
5273 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5275 "filename": "server/api/chatWebsite/index.js",
5276 "groupTitle": "Chat_Websites"
5280 "url": "/api/cloudProviders",
5281 "title": "Creates a new CloudProvider",
5284 "title": "Example usage:",
5285 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5289 "name": "CreateCloudProviders",
5290 "group": "CloudProviders",
5329 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5331 "filename": "server/api/cloudProvider/index.js",
5332 "groupTitle": "CloudProviders"
5336 "url": "/api/cloudProviders/{id}",
5337 "title": "Deletes a CloudProvider",
5340 "title": "Example usage:",
5341 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5345 "name": "DeleteCloudProviders",
5346 "group": "CloudProviders",
5347 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5349 "filename": "server/api/cloudProvider/index.js",
5350 "groupTitle": "CloudProviders"
5354 "url": "/api/cloudProviders",
5355 "title": "Gets a list of CloudProviders",
5358 "title": "Example usage:",
5359 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5363 "name": "GetCloudProviders",
5364 "group": "CloudProviders",
5365 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5367 "filename": "server/api/cloudProvider/index.js",
5368 "groupTitle": "CloudProviders"
5372 "url": "/api/cloudProviders/{id}",
5373 "title": "Gets a single CloudProvider",
5376 "title": "Example usage:",
5377 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5381 "name": "ShowCloudProviders",
5382 "group": "CloudProviders",
5383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5385 "filename": "server/api/cloudProvider/index.js",
5386 "groupTitle": "CloudProviders"
5390 "url": "/api/cloudProviders/{id}",
5391 "title": "Update an existing CloudProvider",
5394 "title": "Example usage:",
5395 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5399 "name": "updateCloudProviders",
5400 "group": "CloudProviders",
5401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5403 "filename": "server/api/cloudProvider/index.js",
5404 "groupTitle": "CloudProviders"
5408 "url": "/api/cm/companies",
5409 "title": "Creates a new Company",
5412 "title": "Example usage:",
5413 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5417 "name": "CreateCompanies",
5418 "group": "Cm_Companies",
5440 "field": "companyId",
5482 "field": "postalCode",
5510 "field": "emailDomain",
5524 "field": "sPostalCode",
5538 "field": "sCountry",
5545 "field": "description",
5551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5553 "filename": "server/api/cmCompany/index.js",
5554 "groupTitle": "Cm_Companies"
5558 "url": "/api/cm/companies/{id}",
5559 "title": "Deletes a Company",
5562 "title": "Example usage:",
5563 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5567 "name": "DeleteCompanies",
5568 "group": "Cm_Companies",
5569 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5571 "filename": "server/api/cmCompany/index.js",
5572 "groupTitle": "Cm_Companies"
5576 "url": "/api/cm/companies/describe",
5577 "title": "Gets table info about Companies",
5580 "title": "Example usage:",
5581 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5585 "name": "DescribeCompanies",
5586 "group": "Cm_Companies",
5587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5589 "filename": "server/api/cmCompany/index.js",
5590 "groupTitle": "Cm_Companies"
5594 "url": "/api/cm/companies",
5595 "title": "Gets a list of Companies",
5598 "title": "Example usage:",
5599 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5603 "name": "GetCompanies",
5604 "group": "Cm_Companies",
5605 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/companies?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/companies?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/companies?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/companies?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/companies?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5607 "filename": "server/api/cmCompany/index.js",
5608 "groupTitle": "Cm_Companies"
5612 "url": "/api/cm/companies/{id}",
5613 "title": "Gets a single Company",
5616 "title": "Example usage:",
5617 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5621 "name": "ShowCompanies",
5622 "group": "Cm_Companies",
5623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5625 "filename": "server/api/cmCompany/index.js",
5626 "groupTitle": "Cm_Companies"
5630 "url": "/api/cm/companies/{id}/contacts",
5631 "title": "Creates new contacts",
5634 "title": "Example usage:",
5635 "content": "curl https://{domain}/api/cm/companies/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5639 "name": "addContacts",
5640 "group": "Cm_Companies",
5648 "field": "firstName",
5655 "field": "lastName",
5669 "field": "postalCode",
5690 "field": "dateOfBirth",
5697 "field": "description",
5739 "field": "facebook",
5795 "field": "telegram",
5809 "field": "priority",
5816 "field": "scheduledat",
5822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5824 "filename": "server/api/cmCompany/index.js",
5825 "groupTitle": "Cm_Companies"
5829 "url": "/api/cm/companies/{id}/contacts",
5830 "title": "Gets List Contacts",
5833 "title": "Example usage:",
5834 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5838 "name": "getContacts",
5839 "group": "Cm_Companies",
5840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5842 "filename": "server/api/cmCompany/index.js",
5843 "groupTitle": "Cm_Companies"
5847 "url": "/api/cm/companies/{id}",
5848 "title": "Update an existing Company",
5851 "title": "Example usage:",
5852 "content": "curl https://{domain}/api/cm/companies/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5856 "name": "updateCompanies",
5857 "group": "Cm_Companies",
5858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5860 "filename": "server/api/cmCompany/index.js",
5861 "groupTitle": "Cm_Companies"
5865 "url": "/api/cm/contacts/{id}",
5866 "title": "Deletes a Contact",
5869 "title": "Example usage:",
5870 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5874 "name": "DeleteContacts",
5875 "group": "Cm_Contacts",
5876 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5878 "filename": "server/api/cmContact/index.js",
5879 "groupTitle": "Cm_Contacts"
5883 "url": "/api/cm/contacts/describe",
5884 "title": "Gets table info about Contacts",
5887 "title": "Example usage:",
5888 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5892 "name": "DescribeContacts",
5893 "group": "Cm_Contacts",
5894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5896 "filename": "server/api/cmContact/index.js",
5897 "groupTitle": "Cm_Contacts"
5901 "url": "/api/cm/contacts",
5902 "title": "Gets a list of Contacts",
5905 "title": "Example usage:",
5906 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5910 "name": "GetContacts",
5911 "group": "Cm_Contacts",
5912 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/contacts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/contacts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/contacts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/contacts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/contacts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5914 "filename": "server/api/cmContact/index.js",
5915 "groupTitle": "Cm_Contacts"
5919 "url": "/api/cm/contacts/{id}/finals",
5920 "title": "Gets contact hopper finals",
5923 "title": "Example usage:",
5924 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
5928 "name": "GetHopperFinals",
5929 "group": "Cm_Contacts",
5930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5932 "filename": "server/api/cmContact/index.js",
5933 "groupTitle": "Cm_Contacts"
5937 "url": "/api/cm/contacts/{id}/hopper_histories",
5938 "title": "Gets contact hopper histories",
5941 "title": "Example usage:",
5942 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
5946 "name": "GetHopperHistories",
5947 "group": "Cm_Contacts",
5948 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5950 "filename": "server/api/cmContact/index.js",
5951 "groupTitle": "Cm_Contacts"
5955 "url": "/api/cm/contacts/{id}/hoppers",
5956 "title": "Gets contact hoppers",
5959 "title": "Example usage:",
5960 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
5964 "name": "GetHoppers",
5965 "group": "Cm_Contacts",
5966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5968 "filename": "server/api/cmContact/index.js",
5969 "groupTitle": "Cm_Contacts"
5973 "url": "/api/cm/contacts/create_many",
5974 "title": "Create Contacts",
5977 "title": "Example usage:",
5978 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
5982 "name": "bulkCreate",
5983 "group": "Cm_Contacts",
5984 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5986 "filename": "server/api/cmContact/index.js",
5987 "groupTitle": "Cm_Contacts"
5991 "url": "/api/cm/contacts",
5992 "title": "Create Contact",
5995 "title": "Example usage:",
5996 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6001 "group": "Cm_Contacts",
6002 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6004 "filename": "server/api/cmContact/index.js",
6005 "groupTitle": "Cm_Contacts"
6009 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6010 "title": "Gets contact hopper blacks",
6013 "title": "Example usage:",
6014 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6018 "name": "getJscriptySessions",
6019 "group": "Cm_Contacts",
6020 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6022 "filename": "server/api/cmContact/index.js",
6023 "groupTitle": "Cm_Contacts"
6027 "url": "/api/cm/contacts/{id}/tags",
6028 "title": "Gets configurations tags",
6031 "title": "Example usage:",
6032 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6037 "group": "Cm_Contacts",
6038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6040 "filename": "server/api/cmContact/index.js",
6041 "groupTitle": "Cm_Contacts"
6045 "url": "/api/cm/contacts/merge",
6046 "title": "Merge Contact",
6049 "title": "Example usage:",
6050 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6055 "group": "Cm_Contacts",
6056 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6058 "filename": "server/api/cmContact/index.js",
6059 "groupTitle": "Cm_Contacts"
6063 "url": "/api/cm/contacts/{id}/tags",
6064 "title": "Sets new tags",
6067 "title": "Example usage:",
6068 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6073 "group": "Cm_Contacts",
6074 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6076 "filename": "server/api/cmContact/index.js",
6077 "groupTitle": "Cm_Contacts"
6081 "url": "/api/cm/contacts/{id}",
6082 "title": "Gets a single Contact",
6085 "title": "Example usage:",
6086 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6091 "group": "Cm_Contacts",
6092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6094 "filename": "server/api/cmContact/index.js",
6095 "groupTitle": "Cm_Contacts"
6099 "url": "/api/cm/contacts/{id}",
6100 "title": "Update a single Contact",
6103 "title": "Example usage:",
6104 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6109 "group": "Cm_Contacts",
6110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6112 "filename": "server/api/cmContact/index.js",
6113 "groupTitle": "Cm_Contacts"
6117 "url": "/api/cm/custom_fields/{id}",
6118 "title": "Deletes a Custom Field",
6121 "title": "Example usage:",
6122 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6126 "name": "DeleteCustom_Fields",
6127 "group": "Cm_Custom_Fields",
6128 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6130 "filename": "server/api/cmCustomField/index.js",
6131 "groupTitle": "Cm_Custom_Fields"
6135 "url": "/api/cm/custom_fields",
6136 "title": "Gets a list of Custom Fields",
6139 "title": "Example usage:",
6140 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6144 "name": "GetCustom_Fields",
6145 "group": "Cm_Custom_Fields",
6146 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/custom_fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/custom_fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/custom_fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/custom_fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/custom_fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6148 "filename": "server/api/cmCustomField/index.js",
6149 "groupTitle": "Cm_Custom_Fields"
6153 "url": "/api/cm/custom_fields/{id}",
6154 "title": "Gets a single Custom Field",
6157 "title": "Example usage:",
6158 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6162 "name": "ShowCustom_Fields",
6163 "group": "Cm_Custom_Fields",
6164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6166 "filename": "server/api/cmCustomField/index.js",
6167 "groupTitle": "Cm_Custom_Fields"
6171 "url": "/api/cm/custom_fields/{id}",
6172 "title": "Update an existing Custom Field",
6175 "title": "Example usage:",
6176 "content": "curl https://{domain}/api/cm/custom_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6180 "name": "updateCustom_Fields",
6181 "group": "Cm_Custom_Fields",
6182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6184 "filename": "server/api/cmCustomField/index.js",
6185 "groupTitle": "Cm_Custom_Fields"
6189 "url": "/api/cm/hopper",
6190 "title": "Creates a new Hopper",
6193 "title": "Example usage:",
6194 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6198 "name": "CreateHopper",
6199 "group": "Cm_Hopper",
6221 "field": "scheduledat",
6228 "field": "countbusyretry",
6235 "field": "countcongestionretry",
6242 "field": "countnoanswerretry",
6249 "field": "callback",
6256 "field": "callbackuniqueid",
6263 "field": "callbackat",
6270 "field": "priority",
6277 "field": "recallme",
6284 "field": "ContactId",
6305 "field": "VoiceQueueId",
6312 "field": "CampaignId",
6319 "field": "countnosuchnumberretry",
6326 "field": "countdropretry",
6333 "field": "countabandonedretry",
6340 "field": "countmachineretry",
6347 "field": "countagentrejectretry",
6353 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6355 "filename": "server/api/cmHopper/index.js",
6356 "groupTitle": "Cm_Hopper"
6360 "url": "/api/cm/hopper/describe",
6361 "title": "Gets table info about Hopper",
6364 "title": "Example usage:",
6365 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6369 "name": "DescribeHopper",
6370 "group": "Cm_Hopper",
6371 "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>",
6373 "filename": "server/api/cmHopper/index.js",
6374 "groupTitle": "Cm_Hopper"
6378 "url": "/api/cm/hopper",
6379 "title": "Gets a list of Hopper",
6382 "title": "Example usage:",
6383 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6387 "name": "GetHopper",
6388 "group": "Cm_Hopper",
6389 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6391 "filename": "server/api/cmHopper/index.js",
6392 "groupTitle": "Cm_Hopper"
6396 "url": "/api/cm/hopper/{id}",
6397 "title": "Gets a single Hopper",
6400 "title": "Example usage:",
6401 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6405 "name": "ShowHopper",
6406 "group": "Cm_Hopper",
6407 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6409 "filename": "server/api/cmHopper/index.js",
6410 "groupTitle": "Cm_Hopper"
6414 "url": "/api/cm/hopper_black/{id}",
6415 "title": "Deletes a Hopper Black",
6418 "title": "Example usage:",
6419 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6423 "name": "DeleteHopper_Black",
6424 "group": "Cm_Hopper_Black",
6425 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6427 "filename": "server/api/cmHopperBlack/index.js",
6428 "groupTitle": "Cm_Hopper_Black"
6432 "url": "/api/cm/hopper_black/describe",
6433 "title": "Gets table info about Hopper Black",
6436 "title": "Example usage:",
6437 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6441 "name": "DescribeHopper_Black",
6442 "group": "Cm_Hopper_Black",
6443 "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>",
6445 "filename": "server/api/cmHopperBlack/index.js",
6446 "groupTitle": "Cm_Hopper_Black"
6450 "url": "/api/cm/hopper_black",
6451 "title": "Gets a list of Hopper Black",
6454 "title": "Example usage:",
6455 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6459 "name": "GetHopper_Black",
6460 "group": "Cm_Hopper_Black",
6461 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6463 "filename": "server/api/cmHopperBlack/index.js",
6464 "groupTitle": "Cm_Hopper_Black"
6468 "url": "/api/cm/hopper_black/{id}",
6469 "title": "Gets a single Hopper Black",
6472 "title": "Example usage:",
6473 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6477 "name": "ShowHopper_Black",
6478 "group": "Cm_Hopper_Black",
6479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6481 "filename": "server/api/cmHopperBlack/index.js",
6482 "groupTitle": "Cm_Hopper_Black"
6486 "url": "/api/cm/hopper_black/{id}",
6487 "title": "Update an existing Hopper Black",
6490 "title": "Example usage:",
6491 "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",
6495 "name": "updateHopper_Black",
6496 "group": "Cm_Hopper_Black",
6497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6499 "filename": "server/api/cmHopperBlack/index.js",
6500 "groupTitle": "Cm_Hopper_Black"
6504 "url": "/api/cm/hopper_final/checkContactHopper",
6505 "title": "Check if contact is in hopper",
6508 "title": "Example usage:",
6509 "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",
6513 "name": "/checkContactHopper",
6514 "group": "Cm_Hopper_Final",
6515 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6517 "filename": "server/api/cmHopperFinal/index.js",
6518 "groupTitle": "Cm_Hopper_Final"
6522 "url": "/api/cm/hopper_final/describe",
6523 "title": "Gets table info about HopperFinal",
6526 "title": "Example usage:",
6527 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6531 "name": "DescribeHopperFinal",
6532 "group": "Cm_Hopper_Final",
6533 "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>",
6535 "filename": "server/api/cmHopperFinal/index.js",
6536 "groupTitle": "Cm_Hopper_Final"
6540 "url": "/api/cm/hopper_final",
6541 "title": "Gets a list of HopperFinal",
6544 "title": "Example usage:",
6545 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6549 "name": "GetHopperFinal",
6550 "group": "Cm_Hopper_Final",
6551 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6553 "filename": "server/api/cmHopperFinal/index.js",
6554 "groupTitle": "Cm_Hopper_Final"
6558 "url": "/api/cm/hopper_final/{id}",
6559 "title": "Gets a single HopperFinal",
6562 "title": "Example usage:",
6563 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6567 "name": "ShowHopperFinal",
6568 "group": "Cm_Hopper_Final",
6569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6571 "filename": "server/api/cmHopperFinal/index.js",
6572 "groupTitle": "Cm_Hopper_Final"
6576 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6577 "title": "Return number contacts for attributes",
6580 "title": "Example usage:",
6581 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6585 "name": "countContactsIvrCampaignHopperFinal",
6586 "group": "Cm_Hopper_Final",
6587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6589 "filename": "server/api/cmHopperFinal/index.js",
6590 "groupTitle": "Cm_Hopper_Final"
6594 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6595 "title": "Return number contacts for attributes",
6598 "title": "Example usage:",
6599 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6603 "name": "countContactsQueueCampaignHopperFinal",
6604 "group": "Cm_Hopper_Final",
6605 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6607 "filename": "server/api/cmHopperFinal/index.js",
6608 "groupTitle": "Cm_Hopper_Final"
6612 "url": "/api/cm/hopper_final/campaign/{id}",
6613 "title": "Move contacts in hopper",
6616 "title": "Example usage:",
6617 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6621 "name": "moveContactsIvrCampaignHopperFinal",
6622 "group": "Cm_Hopper_Final",
6623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6625 "filename": "server/api/cmHopperFinal/index.js",
6626 "groupTitle": "Cm_Hopper_Final"
6630 "url": "/api/cm/hopper_final/voice/queue/{id}",
6631 "title": "Move contacts in hopper",
6634 "title": "Example usage:",
6635 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6639 "name": "moveContactsQueueCampaignHopperFinal",
6640 "group": "Cm_Hopper_Final",
6641 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6643 "filename": "server/api/cmHopperFinal/index.js",
6644 "groupTitle": "Cm_Hopper_Final"
6648 "url": "/api/cm/hopper_final/{id}",
6649 "title": "Update a single hopper final",
6652 "title": "Example usage:",
6653 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6658 "group": "Cm_Hopper_Final",
6659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6661 "filename": "server/api/cmHopperFinal/index.js",
6662 "groupTitle": "Cm_Hopper_Final"
6666 "url": "/api/cm/hopper_history",
6667 "title": "Creates a new HopperHistory",
6670 "title": "Example usage:",
6671 "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",
6675 "name": "CreateHopperHistory",
6676 "group": "Cm_Hopper_History",
6691 "field": "statedesc",
6698 "field": "scheduledat",
6705 "field": "countbusyretry",
6712 "field": "countcongestionretry",
6719 "field": "countnoanswerretry",
6726 "field": "countglobal",
6733 "field": "uniqueid",
6740 "field": "originatecalleridnum",
6747 "field": "originatecalleridname",
6754 "field": "calleridnum",
6761 "field": "calleridname",
6768 "field": "starttime",
6775 "field": "responsetime",
6782 "field": "answertime",
6789 "field": "droptime",
6803 "field": "ringtime",
6810 "field": "holdtime",
6817 "field": "talktime",
6824 "field": "followuptime",
6831 "field": "dropreason",
6838 "field": "campaign",
6845 "field": "campaigntype",
6852 "field": "membername",
6880 "field": "callback",
6887 "field": "callbackuniqueid",
6894 "field": "callbackat",
6901 "field": "recallme",
6908 "field": "editedat",
6922 "field": "countnosuchnumberretry",
6929 "field": "countdropretry",
6936 "field": "countabandonedretry",
6943 "field": "countmachineretry",
6950 "field": "countagentrejectretry",
6956 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6958 "filename": "server/api/cmHopperHistory/index.js",
6959 "groupTitle": "Cm_Hopper_History"
6963 "url": "/api/cm/hopper_history/describe",
6964 "title": "Gets table info about HopperHistory",
6967 "title": "Example usage:",
6968 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
6972 "name": "DescribeHopperHistory",
6973 "group": "Cm_Hopper_History",
6974 "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>",
6976 "filename": "server/api/cmHopperHistory/index.js",
6977 "groupTitle": "Cm_Hopper_History"
6981 "url": "/api/cm/hopper_history",
6982 "title": "Gets a list of HopperHistory",
6985 "title": "Example usage:",
6986 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
6990 "name": "GetHopperHistory",
6991 "group": "Cm_Hopper_History",
6992 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6994 "filename": "server/api/cmHopperHistory/index.js",
6995 "groupTitle": "Cm_Hopper_History"
6999 "url": "/api/cm/hopper_history/{id}",
7000 "title": "Gets a single HopperHistory",
7003 "title": "Example usage:",
7004 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7008 "name": "ShowHopperHistory",
7009 "group": "Cm_Hopper_History",
7010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7012 "filename": "server/api/cmHopperHistory/index.js",
7013 "groupTitle": "Cm_Hopper_History"
7017 "url": "/api/cm/hopper_history/{id}",
7018 "title": "Update a single hopper history",
7021 "title": "Example usage:",
7022 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7027 "group": "Cm_Hopper_History",
7028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7030 "filename": "server/api/cmHopperHistory/index.js",
7031 "groupTitle": "Cm_Hopper_History"
7035 "url": "/api/cm/hopper/{id}",
7036 "title": "Delete Hopper",
7039 "title": "Example usage:",
7040 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7045 "group": "Cm_Hopper",
7046 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7048 "filename": "server/api/cmHopper/index.js",
7049 "groupTitle": "Cm_Hopper"
7053 "url": "/api/cm/hopper/opencontacts",
7054 "title": "Gets Open Contacts",
7057 "title": "Example usage:",
7058 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7062 "name": "getOpenContacts",
7063 "group": "Cm_Hopper",
7064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7066 "filename": "server/api/cmHopper/index.js",
7067 "groupTitle": "Cm_Hopper"
7071 "url": "/api/cm/hopper/preview",
7072 "title": "Gets Preview Dialer Contacts",
7075 "title": "Example usage:",
7076 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7080 "name": "getPreview",
7081 "group": "Cm_Hopper",
7082 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7084 "filename": "server/api/cmHopper/index.js",
7085 "groupTitle": "Cm_Hopper"
7089 "url": "/api/cm/hopper/{id}",
7090 "title": "Update an existing Hopper",
7093 "title": "Example usage:",
7094 "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",
7098 "name": "updateHopper",
7099 "group": "Cm_Hopper",
7100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7102 "filename": "server/api/cmHopper/index.js",
7103 "groupTitle": "Cm_Hopper"
7107 "url": "/api/cm/lists",
7108 "title": "Creates a new List",
7111 "title": "Example usage:",
7112 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7116 "name": "CreateLists",
7117 "group": "Cm_Lists",
7132 "field": "description",
7139 "field": "dialPrefix",
7145 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7147 "filename": "server/api/cmList/index.js",
7148 "groupTitle": "Cm_Lists"
7152 "url": "/api/cm/lists/{id}",
7153 "title": "Deletes a List",
7156 "title": "Example usage:",
7157 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7161 "name": "DeleteLists",
7162 "group": "Cm_Lists",
7163 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7165 "filename": "server/api/cmList/index.js",
7166 "groupTitle": "Cm_Lists"
7170 "url": "/api/cm/lists/describe",
7171 "title": "Gets table info about Lists",
7174 "title": "Example usage:",
7175 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7179 "name": "DescribeLists",
7180 "group": "Cm_Lists",
7181 "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>",
7183 "filename": "server/api/cmList/index.js",
7184 "groupTitle": "Cm_Lists"
7188 "url": "/api/cm/lists/{id}/users",
7189 "title": "Gets agents from list",
7192 "title": "Example usage:",
7193 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7197 "name": "GetAgents",
7198 "group": "Cm_Lists",
7199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7201 "filename": "server/api/cmList/index.js",
7202 "groupTitle": "Cm_Lists"
7206 "url": "/api/cm/lists",
7207 "title": "Gets a list of Lists",
7210 "title": "Example usage:",
7211 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7216 "group": "Cm_Lists",
7217 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7219 "filename": "server/api/cmList/index.js",
7220 "groupTitle": "Cm_Lists"
7224 "url": "/api/cm/lists/{id}/users",
7225 "title": "Removes agents from a list",
7228 "title": "Example usage:",
7229 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7233 "name": "RemoveAgents",
7234 "group": "Cm_Lists",
7235 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7237 "filename": "server/api/cmList/index.js",
7238 "groupTitle": "Cm_Lists"
7242 "url": "/api/cm/lists/{id}/dispositions",
7243 "title": "Removes dispositions from account",
7246 "title": "Example usage:",
7247 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7251 "name": "RemoveDispositions",
7252 "group": "Cm_Lists",
7253 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7255 "filename": "server/api/cmList/index.js",
7256 "groupTitle": "Cm_Lists"
7260 "url": "/api/cm/lists/{id}",
7261 "title": "Gets a single List",
7264 "title": "Example usage:",
7265 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7269 "name": "ShowLists",
7270 "group": "Cm_Lists",
7271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7273 "filename": "server/api/cmList/index.js",
7274 "groupTitle": "Cm_Lists"
7278 "url": "/api/cm/lists/{id}/users",
7279 "title": "Adds agents to a list",
7282 "title": "Example usage:",
7283 "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",
7287 "name": "addAgents",
7288 "group": "Cm_Lists",
7289 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7291 "filename": "server/api/cmList/index.js",
7292 "groupTitle": "Cm_Lists"
7296 "url": "/api/cm/lists/{id}/contacts",
7297 "title": "Creates new contacts",
7300 "title": "Example usage:",
7301 "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",
7305 "name": "addContacts",
7306 "group": "Cm_Lists",
7314 "field": "firstName",
7321 "field": "lastName",
7335 "field": "postalCode",
7356 "field": "dateOfBirth",
7363 "field": "description",
7405 "field": "facebook",
7461 "field": "telegram",
7475 "field": "priority",
7482 "field": "scheduledat",
7488 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7490 "filename": "server/api/cmList/index.js",
7491 "groupTitle": "Cm_Lists"
7495 "url": "/api/cm/lists/{id}/fields",
7496 "title": "Creates a new custom field",
7499 "title": "Example usage:",
7500 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7504 "name": "addCustomField",
7505 "group": "Cm_Lists",
7506 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7508 "filename": "server/api/cmList/index.js",
7509 "groupTitle": "Cm_Lists"
7513 "url": "/api/cm/lists/{id}/dispositions",
7514 "title": "Creates new disposition",
7517 "title": "Example usage:",
7518 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7522 "name": "addDisposition",
7523 "group": "Cm_Lists",
7537 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7539 "filename": "server/api/cmList/index.js",
7540 "groupTitle": "Cm_Lists"
7544 "url": "/api/cm/lists/{id}/contacts",
7545 "title": "Gets List Contacts",
7548 "title": "Example usage:",
7549 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7553 "name": "getContacts",
7554 "group": "Cm_Lists",
7555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7557 "filename": "server/api/cmList/index.js",
7558 "groupTitle": "Cm_Lists"
7562 "url": "/api/cm/lists/{id}/fields",
7563 "title": "Gets Custom Fields",
7566 "title": "Example usage:",
7567 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7571 "name": "getCustomFields",
7572 "group": "Cm_Lists",
7573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7575 "filename": "server/api/cmList/index.js",
7576 "groupTitle": "Cm_Lists"
7580 "url": "/api/cm/lists/{id}/dispositions",
7581 "title": "Gets list dispositions",
7584 "title": "Example usage:",
7585 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7589 "name": "getDispositions",
7590 "group": "Cm_Lists",
7591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7593 "filename": "server/api/cmList/index.js",
7594 "groupTitle": "Cm_Lists"
7598 "url": "/api/cm/lists/{id}/contacts/csv",
7599 "title": "Gets CSV List Contacts",
7602 "title": "Example usage:",
7603 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7608 "group": "Cm_Lists",
7609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7611 "filename": "server/api/cmList/index.js",
7612 "groupTitle": "Cm_Lists"
7616 "url": "/api/cm/lists/{id}",
7617 "title": "Update an existing List",
7620 "title": "Example usage:",
7621 "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",
7625 "name": "updateLists",
7626 "group": "Cm_Lists",
7627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7629 "filename": "server/api/cmList/index.js",
7630 "groupTitle": "Cm_Lists"
7634 "url": "/api/cm/contacts/upload/:id",
7635 "title": "Import new contacts by csv",
7638 "title": "Example usage:",
7639 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7644 "group": "Cm_contacts",
7645 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7647 "filename": "server/api/cmContact/index.js",
7648 "groupTitle": "Cm_contacts"
7652 "url": "/api/cm/contacts/upload",
7653 "title": "Upload csv",
7656 "title": "Example usage:",
7657 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7662 "group": "Cm_contacts",
7663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7665 "filename": "server/api/cmContact/index.js",
7666 "groupTitle": "Cm_contacts"
7670 "url": "/api/cm/contacts/csv",
7671 "title": "Create new contacts by csv",
7674 "title": "Example usage:",
7675 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7679 "name": "uploadCsv",
7680 "group": "Cm_contacts",
7681 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7683 "filename": "server/api/cmContact/index.js",
7684 "groupTitle": "Cm_contacts"
7688 "url": "/api/conditions/{id}",
7689 "title": "Deletes a Condition",
7692 "title": "Example usage:",
7693 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7697 "name": "DeleteConditions",
7698 "group": "Conditions",
7699 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7701 "filename": "server/api/condition/index.js",
7702 "groupTitle": "Conditions"
7706 "url": "/api/conditions/{id}",
7707 "title": "Update an existing Condition",
7710 "title": "Example usage:",
7711 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7715 "name": "updateConditions",
7716 "group": "Conditions",
7717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7719 "filename": "server/api/condition/index.js",
7720 "groupTitle": "Conditions"
7724 "url": "/api/cm/custom_field",
7725 "title": "Create a new custom field",
7728 "title": "Example usage:",
7729 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7733 "name": "CreateCustomField",
7734 "group": "Custom_Fields",
7735 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7737 "filename": "server/api/cmCustomField/index.js",
7738 "groupTitle": "Custom_Fields"
7742 "url": "/api/dashboards/items",
7743 "title": "Create dasboard item",
7746 "title": "Example usage:",
7747 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7752 "group": "Dashboard_Items",
7753 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7755 "filename": "server/api/dashboardItem/index.js",
7756 "groupTitle": "Dashboard_Items"
7760 "url": "/api/dashboards/items/{id}",
7761 "title": "Deletes a Dashboard Item",
7764 "title": "Example usage:",
7765 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7769 "name": "DeleteDashboard_Items",
7770 "group": "Dashboard_Items",
7771 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7773 "filename": "server/api/dashboardItem/index.js",
7774 "groupTitle": "Dashboard_Items"
7778 "url": "/api/dashboards/items/{id}",
7779 "title": "Gets a single Dashboard Item",
7782 "title": "Example usage:",
7783 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7787 "name": "ShowDashboard_Items",
7788 "group": "Dashboard_Items",
7789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7791 "filename": "server/api/dashboardItem/index.js",
7792 "groupTitle": "Dashboard_Items"
7796 "url": "/api/dashboards/items/{id}",
7797 "title": "Update an existing item",
7800 "title": "Example usage:",
7801 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7806 "group": "Dashboard_Items",
7807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7809 "filename": "server/api/dashboardItem/index.js",
7810 "groupTitle": "Dashboard_Items"
7814 "url": "/api/dashboards/clone",
7815 "title": "Clone an existing Dashboard",
7818 "title": "Example usage:",
7819 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7823 "name": "CloneDashboards",
7824 "group": "Dashboards",
7825 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7827 "filename": "server/api/dashboard/index.js",
7828 "groupTitle": "Dashboards"
7832 "url": "/api/dashboards",
7833 "title": "Creates a new Dashboard",
7836 "title": "Example usage:",
7837 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7841 "name": "CreateDashboards",
7842 "group": "Dashboards",
7857 "field": "description",
7863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7865 "filename": "server/api/dashboard/index.js",
7866 "groupTitle": "Dashboards"
7870 "url": "/api/dashboards/{id}",
7871 "title": "Deletes a Dashboard",
7874 "title": "Example usage:",
7875 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7879 "name": "DeleteDashboards",
7880 "group": "Dashboards",
7881 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7883 "filename": "server/api/dashboard/index.js",
7884 "groupTitle": "Dashboards"
7888 "url": "/api/dashboards",
7889 "title": "Gets a list of Dashboards",
7892 "title": "Example usage:",
7893 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7897 "name": "GetDashboards",
7898 "group": "Dashboards",
7899 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7901 "filename": "server/api/dashboard/index.js",
7902 "groupTitle": "Dashboards"
7906 "url": "/api/dashboards/{id}",
7907 "title": "Gets a single Dashboard",
7910 "title": "Example usage:",
7911 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
7915 "name": "ShowDashboards",
7916 "group": "Dashboards",
7917 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7919 "filename": "server/api/dashboard/index.js",
7920 "groupTitle": "Dashboards"
7924 "url": "/api/dashboards/{id}/items",
7925 "title": "Creates new item",
7928 "title": "Example usage:",
7929 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7934 "group": "Dashboards",
7935 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7937 "filename": "server/api/dashboard/index.js",
7938 "groupTitle": "Dashboards"
7942 "url": "/api/dashboards/{id}/items",
7943 "title": "Gets items",
7946 "title": "Example usage:",
7947 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
7952 "group": "Dashboards",
7953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7955 "filename": "server/api/dashboard/index.js",
7956 "groupTitle": "Dashboards"
7960 "url": "/api/dashboards/{id}",
7961 "title": "Update an existing Dashboard",
7964 "title": "Example usage:",
7965 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7969 "name": "updateDashboards",
7970 "group": "Dashboards",
7971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7973 "filename": "server/api/dashboard/index.js",
7974 "groupTitle": "Dashboards"
7978 "url": "/api/integrations/desk/accounts",
7979 "title": "Creates a new Desk Account",
7982 "title": "Example usage:",
7983 "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",
7987 "name": "CreateDesk_Accounts",
7988 "group": "Desk_Accounts",
8003 "field": "description",
8010 "field": "username",
8017 "field": "remoteUri",
8027 "field": "authType",
8034 "field": "password",
8041 "field": "consumerKey",
8048 "field": "consumerSecret",
8062 "field": "tokenSecret",
8069 "field": "serverUrl",
8076 "\"integrationTab\"",
8086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8088 "filename": "server/api/intDeskAccount/index.js",
8089 "groupTitle": "Desk_Accounts"
8093 "url": "/api/integrations/desk/accounts/{id}",
8094 "title": "Deletes a Desk Account",
8097 "title": "Example usage:",
8098 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8102 "name": "DeleteDesk_Accounts",
8103 "group": "Desk_Accounts",
8104 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8106 "filename": "server/api/intDeskAccount/index.js",
8107 "groupTitle": "Desk_Accounts"
8111 "url": "/api/integrations/desk/accounts",
8112 "title": "Gets a list of Desk Accounts",
8115 "title": "Example usage:",
8116 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8120 "name": "GetDesk_Accounts",
8121 "group": "Desk_Accounts",
8122 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8124 "filename": "server/api/intDeskAccount/index.js",
8125 "groupTitle": "Desk_Accounts"
8129 "url": "/api/integrations/desk/accounts/{id}",
8130 "title": "Gets a single Desk Account",
8133 "title": "Example usage:",
8134 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8138 "name": "ShowDesk_Accounts",
8139 "group": "Desk_Accounts",
8140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8142 "filename": "server/api/intDeskAccount/index.js",
8143 "groupTitle": "Desk_Accounts"
8147 "url": "/api/integrations/desk/accounts/{id}/configurations",
8148 "title": "Creates new configuration",
8151 "title": "Example usage:",
8152 "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",
8156 "name": "addConfiguration",
8157 "group": "Desk_Accounts",
8158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8160 "filename": "server/api/intDeskAccount/index.js",
8161 "groupTitle": "Desk_Accounts"
8165 "url": "/api/integrations/desk/accounts/{id}/configurations",
8166 "title": "Gets account configurations",
8169 "title": "Example usage:",
8170 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8174 "name": "getConfigurations",
8175 "group": "Desk_Accounts",
8176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8178 "filename": "server/api/intDeskAccount/index.js",
8179 "groupTitle": "Desk_Accounts"
8183 "url": "/api/integrations/desk/accounts/{id}/fields",
8184 "title": "Gets account fields",
8187 "title": "Example usage:",
8188 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8192 "name": "getFields",
8193 "group": "Desk_Accounts",
8194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8196 "filename": "server/api/intDeskAccount/index.js",
8197 "groupTitle": "Desk_Accounts"
8201 "url": "/api/integrations/desk/accounts/{id}",
8202 "title": "Update an existing Desk Account",
8205 "title": "Example usage:",
8206 "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",
8210 "name": "updateDesk_Accounts",
8211 "group": "Desk_Accounts",
8212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8214 "filename": "server/api/intDeskAccount/index.js",
8215 "groupTitle": "Desk_Accounts"
8219 "url": "/api/integrations/desk/configurations",
8220 "title": "Creates a new Desk Configuration",
8223 "title": "Example usage:",
8224 "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",
8228 "name": "CreateDesk_Configurations",
8229 "group": "Desk_Configurations",
8244 "field": "description",
8250 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8252 "filename": "server/api/intDeskConfiguration/index.js",
8253 "groupTitle": "Desk_Configurations"
8257 "url": "/api/integrations/desk/configurations/{id}",
8258 "title": "Deletes a Desk Configuration",
8261 "title": "Example usage:",
8262 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8266 "name": "DeleteDesk_Configurations",
8267 "group": "Desk_Configurations",
8268 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8270 "filename": "server/api/intDeskConfiguration/index.js",
8271 "groupTitle": "Desk_Configurations"
8275 "url": "/api/integrations/desk/configurations",
8276 "title": "Gets a list of Desk Configurations",
8279 "title": "Example usage:",
8280 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8284 "name": "GetDesk_Configurations",
8285 "group": "Desk_Configurations",
8286 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8288 "filename": "server/api/intDeskConfiguration/index.js",
8289 "groupTitle": "Desk_Configurations"
8293 "url": "/api/integrations/desk/configurations/{id}",
8294 "title": "Gets a single Desk Configuration",
8297 "title": "Example usage:",
8298 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8302 "name": "ShowDesk_Configurations",
8303 "group": "Desk_Configurations",
8304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8306 "filename": "server/api/intDeskConfiguration/index.js",
8307 "groupTitle": "Desk_Configurations"
8311 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8312 "title": "Gets configurations descriptions",
8315 "title": "Example usage:",
8316 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8320 "name": "getDescriptions",
8321 "group": "Desk_Configurations",
8322 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8324 "filename": "server/api/intDeskConfiguration/index.js",
8325 "groupTitle": "Desk_Configurations"
8329 "url": "/api/integrations/desk/configurations/{id}/fields",
8330 "title": "Gets configurations fields",
8333 "title": "Example usage:",
8334 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8338 "name": "getFields",
8339 "group": "Desk_Configurations",
8340 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8342 "filename": "server/api/intDeskConfiguration/index.js",
8343 "groupTitle": "Desk_Configurations"
8347 "url": "/api/integrations/desk/configurations/{id}/subjects",
8348 "title": "Gets configurations subjects",
8351 "title": "Example usage:",
8352 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8356 "name": "getSubjects",
8357 "group": "Desk_Configurations",
8358 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8360 "filename": "server/api/intDeskConfiguration/index.js",
8361 "groupTitle": "Desk_Configurations"
8365 "url": "/api/integrations/desk/configurations/{id}/tags",
8366 "title": "Gets configurations tags",
8369 "title": "Example usage:",
8370 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8375 "group": "Desk_Configurations",
8376 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8378 "filename": "server/api/intDeskConfiguration/index.js",
8379 "groupTitle": "Desk_Configurations"
8383 "url": "/api/integrations/desk/configurations/{id}/tags",
8384 "title": "Sets new tags",
8387 "title": "Example usage:",
8388 "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",
8393 "group": "Desk_Configurations",
8394 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8396 "filename": "server/api/intDeskConfiguration/index.js",
8397 "groupTitle": "Desk_Configurations"
8401 "url": "/api/integrations/desk/configurations/{id}",
8402 "title": "Update an existing Desk Configuration",
8405 "title": "Example usage:",
8406 "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",
8410 "name": "updateDesk_Configurations",
8411 "group": "Desk_Configurations",
8412 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8414 "filename": "server/api/intDeskConfiguration/index.js",
8415 "groupTitle": "Desk_Configurations"
8419 "url": "/api/integrations/desk/fields",
8420 "title": "Creates a new Desk Field",
8423 "title": "Example usage:",
8424 "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",
8428 "name": "CreateDesk_Fields",
8429 "group": "Desk_Fields",
8439 "\"customVariable\"",
8466 "\"customVariable\""
8476 "field": "keyContent",
8490 "field": "nameField",
8497 "field": "customField",
8504 "field": "variableName",
8510 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8512 "filename": "server/api/intDeskField/index.js",
8513 "groupTitle": "Desk_Fields"
8517 "url": "/api/integrations/desk/fields/{id}",
8518 "title": "Deletes a Desk Field",
8521 "title": "Example usage:",
8522 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8526 "name": "DeleteDesk_Fields",
8527 "group": "Desk_Fields",
8528 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8530 "filename": "server/api/intDeskField/index.js",
8531 "groupTitle": "Desk_Fields"
8535 "url": "/api/integrations/desk/fields",
8536 "title": "Gets a list of Desk Fields",
8539 "title": "Example usage:",
8540 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8544 "name": "GetDesk_Fields",
8545 "group": "Desk_Fields",
8546 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8548 "filename": "server/api/intDeskField/index.js",
8549 "groupTitle": "Desk_Fields"
8553 "url": "/api/integrations/desk/fields/{id}",
8554 "title": "Gets a single Desk Field",
8557 "title": "Example usage:",
8558 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8562 "name": "ShowDesk_Fields",
8563 "group": "Desk_Fields",
8564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8566 "filename": "server/api/intDeskField/index.js",
8567 "groupTitle": "Desk_Fields"
8571 "url": "/api/integrations/desk/fields/{id}",
8572 "title": "Update an existing Desk Field",
8575 "title": "Example usage:",
8576 "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",
8580 "name": "updateDesk_Fields",
8581 "group": "Desk_Fields",
8582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8584 "filename": "server/api/intDeskField/index.js",
8585 "groupTitle": "Desk_Fields"
8589 "url": "/api/dispositions",
8590 "title": "Creates a new Disposition",
8593 "title": "Example usage:",
8594 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8598 "name": "CreateDispositions",
8599 "group": "Dispositions",
8613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8615 "filename": "server/api/disposition/index.js",
8616 "groupTitle": "Dispositions"
8620 "url": "/api/dispositions/{id}",
8621 "title": "Deletes a Disposition",
8624 "title": "Example usage:",
8625 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8629 "name": "DeleteDispositions",
8630 "group": "Dispositions",
8631 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8633 "filename": "server/api/disposition/index.js",
8634 "groupTitle": "Dispositions"
8638 "url": "/api/dispositions",
8639 "title": "Gets a list of Dispositions",
8642 "title": "Example usage:",
8643 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8647 "name": "GetDispositions",
8648 "group": "Dispositions",
8649 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8651 "filename": "server/api/disposition/index.js",
8652 "groupTitle": "Dispositions"
8656 "url": "/api/dispositions/{id}",
8657 "title": "Gets a single Disposition",
8660 "title": "Example usage:",
8661 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8665 "name": "ShowDispositions",
8666 "group": "Dispositions",
8667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8669 "filename": "server/api/disposition/index.js",
8670 "groupTitle": "Dispositions"
8674 "url": "/api/dispositions/{id}",
8675 "title": "Update an existing Disposition",
8678 "title": "Example usage:",
8679 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8683 "name": "updateDispositions",
8684 "group": "Dispositions",
8685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8687 "filename": "server/api/disposition/index.js",
8688 "groupTitle": "Dispositions"
8692 "url": "/api/integrations/dynamics365/accounts",
8693 "title": "Creates a new Dynamics365 Account",
8696 "title": "Example usage:",
8697 "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",
8701 "name": "CreateDynamics365_Accounts",
8702 "group": "Dynamics365_Accounts",
8717 "field": "username",
8724 "field": "password",
8731 "field": "remoteUri",
8738 "field": "tenantId",
8745 "field": "clientId",
8752 "field": "clientSecret",
8759 "field": "serverUrl",
8766 "field": "description",
8772 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8774 "filename": "server/api/intDynamics365Account/index.js",
8775 "groupTitle": "Dynamics365_Accounts"
8779 "url": "/api/integrations/dynamics365/accounts/{id}",
8780 "title": "Deletes a Dynamics365 Account",
8783 "title": "Example usage:",
8784 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8788 "name": "DeleteDynamics365_Accounts",
8789 "group": "Dynamics365_Accounts",
8790 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8792 "filename": "server/api/intDynamics365Account/index.js",
8793 "groupTitle": "Dynamics365_Accounts"
8797 "url": "/api/integrations/dynamics365/accounts",
8798 "title": "Gets a list of Dynamics365 Accounts",
8801 "title": "Example usage:",
8802 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8806 "name": "GetDynamics365_Accounts",
8807 "group": "Dynamics365_Accounts",
8808 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8810 "filename": "server/api/intDynamics365Account/index.js",
8811 "groupTitle": "Dynamics365_Accounts"
8815 "url": "/api/integrations/dynamics365/accounts/{id}",
8816 "title": "Gets a single Dynamics365 Account",
8819 "title": "Example usage:",
8820 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8824 "name": "ShowDynamics365_Accounts",
8825 "group": "Dynamics365_Accounts",
8826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8828 "filename": "server/api/intDynamics365Account/index.js",
8829 "groupTitle": "Dynamics365_Accounts"
8833 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8834 "title": "Creates new configuration",
8837 "title": "Example usage:",
8838 "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",
8842 "name": "addConfiguration",
8843 "group": "Dynamics365_Accounts",
8844 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8846 "filename": "server/api/intDynamics365Account/index.js",
8847 "groupTitle": "Dynamics365_Accounts"
8851 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8852 "title": "Gets account configurations",
8855 "title": "Example usage:",
8856 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8860 "name": "getConfigurations",
8861 "group": "Dynamics365_Accounts",
8862 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8864 "filename": "server/api/intDynamics365Account/index.js",
8865 "groupTitle": "Dynamics365_Accounts"
8869 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8870 "title": "Gets account fields",
8873 "title": "Example usage:",
8874 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8878 "name": "getFields",
8879 "group": "Dynamics365_Accounts",
8880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8882 "filename": "server/api/intDynamics365Account/index.js",
8883 "groupTitle": "Dynamics365_Accounts"
8887 "url": "/api/integrations/dynamics365/accounts/{id}",
8888 "title": "Update an existing Dynamics365 Account",
8891 "title": "Example usage:",
8892 "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",
8896 "name": "updateDynamics365_Accounts",
8897 "group": "Dynamics365_Accounts",
8898 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8900 "filename": "server/api/intDynamics365Account/index.js",
8901 "groupTitle": "Dynamics365_Accounts"
8905 "url": "/api/integrations/dynamics365/configurations",
8906 "title": "Creates a new Dynamics365 Configuration",
8909 "title": "Example usage:",
8910 "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",
8914 "name": "CreateDynamics365_Configurations",
8915 "group": "Dynamics365_Configurations",
8930 "field": "description",
8941 "field": "ticketType",
8947 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8949 "filename": "server/api/intDynamics365Configuration/index.js",
8950 "groupTitle": "Dynamics365_Configurations"
8954 "url": "/api/integrations/dynamics365/configurations/{id}",
8955 "title": "Deletes a Dynamics365 Configuration",
8958 "title": "Example usage:",
8959 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
8963 "name": "DeleteDynamics365_Configurations",
8964 "group": "Dynamics365_Configurations",
8965 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intDynamics365Configuration/index.js",
8968 "groupTitle": "Dynamics365_Configurations"
8972 "url": "/api/integrations/dynamics365/configurations",
8973 "title": "Gets a list of Dynamics365 Configurations",
8976 "title": "Example usage:",
8977 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
8981 "name": "GetDynamics365_Configurations",
8982 "group": "Dynamics365_Configurations",
8983 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8985 "filename": "server/api/intDynamics365Configuration/index.js",
8986 "groupTitle": "Dynamics365_Configurations"
8990 "url": "/api/integrations/dynamics365/configurations/{id}",
8991 "title": "Gets a single Dynamics365 Configuration",
8994 "title": "Example usage:",
8995 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
8999 "name": "ShowDynamics365_Configurations",
9000 "group": "Dynamics365_Configurations",
9001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9003 "filename": "server/api/intDynamics365Configuration/index.js",
9004 "groupTitle": "Dynamics365_Configurations"
9008 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9009 "title": "Gets configurations descriptions",
9012 "title": "Example usage:",
9013 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9017 "name": "getDescriptions",
9018 "group": "Dynamics365_Configurations",
9019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9021 "filename": "server/api/intDynamics365Configuration/index.js",
9022 "groupTitle": "Dynamics365_Configurations"
9026 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9027 "title": "Gets configurations fields",
9030 "title": "Example usage:",
9031 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9035 "name": "getFields",
9036 "group": "Dynamics365_Configurations",
9037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9039 "filename": "server/api/intDynamics365Configuration/index.js",
9040 "groupTitle": "Dynamics365_Configurations"
9044 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9045 "title": "Gets configurations subjects",
9048 "title": "Example usage:",
9049 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9053 "name": "getSubjects",
9054 "group": "Dynamics365_Configurations",
9055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9057 "filename": "server/api/intDynamics365Configuration/index.js",
9058 "groupTitle": "Dynamics365_Configurations"
9062 "url": "/api/integrations/dynamics365/configurations/{id}",
9063 "title": "Update an existing Dynamics365 Configuration",
9066 "title": "Example usage:",
9067 "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",
9071 "name": "updateDynamics365_Configurations",
9072 "group": "Dynamics365_Configurations",
9073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9075 "filename": "server/api/intDynamics365Configuration/index.js",
9076 "groupTitle": "Dynamics365_Configurations"
9080 "url": "/api/integrations/dynamics365/fields",
9081 "title": "Creates a new Dynamics365 Field",
9084 "title": "Example usage:",
9085 "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",
9089 "name": "CreateDynamics365_Fields",
9090 "group": "Dynamics365_Fields",
9100 "\"customVariable\"",
9127 "\"customVariable\""
9137 "field": "keyContent",
9151 "field": "nameField",
9158 "field": "customField",
9165 "field": "variableName",
9171 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9173 "filename": "server/api/intDynamics365Field/index.js",
9174 "groupTitle": "Dynamics365_Fields"
9178 "url": "/api/integrations/dynamics365/fields/{id}",
9179 "title": "Deletes a Dynamics365 Field",
9182 "title": "Example usage:",
9183 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9187 "name": "DeleteDynamics365_Fields",
9188 "group": "Dynamics365_Fields",
9189 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9191 "filename": "server/api/intDynamics365Field/index.js",
9192 "groupTitle": "Dynamics365_Fields"
9196 "url": "/api/integrations/dynamics365/fields",
9197 "title": "Gets a list of Dynamics365 Fields",
9200 "title": "Example usage:",
9201 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9205 "name": "GetDynamics365_Fields",
9206 "group": "Dynamics365_Fields",
9207 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9209 "filename": "server/api/intDynamics365Field/index.js",
9210 "groupTitle": "Dynamics365_Fields"
9214 "url": "/api/integrations/dynamics365/fields/{id}",
9215 "title": "Gets a single Dynamics365 Field",
9218 "title": "Example usage:",
9219 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9223 "name": "ShowDynamics365_Fields",
9224 "group": "Dynamics365_Fields",
9225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9227 "filename": "server/api/intDynamics365Field/index.js",
9228 "groupTitle": "Dynamics365_Fields"
9232 "url": "/api/integrations/dynamics365/fields/{id}",
9233 "title": "Update an existing Dynamics365 Field",
9236 "title": "Example usage:",
9237 "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",
9241 "name": "updateDynamics365_Fields",
9242 "group": "Dynamics365_Fields",
9243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9245 "filename": "server/api/intDynamics365Field/index.js",
9246 "groupTitle": "Dynamics365_Fields"
9250 "url": "/api/fax/accounts/{id}/users",
9251 "title": "Add agents to a fax account",
9254 "title": "Example usage:",
9255 "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",
9259 "name": "AddAgents",
9260 "group": "Fax_Accounts",
9261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9263 "filename": "server/api/faxAccount/index.js",
9264 "groupTitle": "Fax_Accounts"
9268 "url": "/api/fax/accounts",
9269 "title": "Creates a new Account",
9272 "title": "Example usage:",
9273 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9277 "name": "CreateAccounts",
9278 "group": "Fax_Accounts",
9293 "field": "description",
9311 "field": "headerinfo",
9318 "field": "localstationid",
9369 "field": "faxdetect",
9376 "field": "t38timeout",
9403 "field": "notificationTemplate",
9410 "field": "notificationSound",
9417 "field": "notificationShake",
9424 "field": "waitForTheAssignedAgent",
9431 "field": "queueTransfer",
9438 "field": "queueTransferTimeout",
9445 "field": "agentTransfer",
9452 "field": "agentTransferTimeout",
9459 "field": "mandatoryDispositionPauseId",
9460 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9466 "field": "mandatoryDisposition",
9467 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9474 "filename": "server/api/faxAccount/index.js",
9475 "groupTitle": "Fax_Accounts"
9479 "url": "/api/fax/accounts/{id}",
9480 "title": "Deletes a Account",
9483 "title": "Example usage:",
9484 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9488 "name": "DeleteAccounts",
9489 "group": "Fax_Accounts",
9490 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9492 "filename": "server/api/faxAccount/index.js",
9493 "groupTitle": "Fax_Accounts"
9497 "url": "/api/fax/accounts/describe",
9498 "title": "Gets table info about Accounts",
9501 "title": "Example usage:",
9502 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9506 "name": "DescribeAccounts",
9507 "group": "Fax_Accounts",
9508 "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>",
9510 "filename": "server/api/faxAccount/index.js",
9511 "groupTitle": "Fax_Accounts"
9515 "url": "/api/fax/accounts",
9516 "title": "Gets a list of Accounts",
9519 "title": "Example usage:",
9520 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9524 "name": "GetAccounts",
9525 "group": "Fax_Accounts",
9526 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9528 "filename": "server/api/faxAccount/index.js",
9529 "groupTitle": "Fax_Accounts"
9533 "url": "/api/fax/accounts/{id}/users",
9534 "title": "Gets agents from fax account",
9537 "title": "Example usage:",
9538 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9542 "name": "GetAgents",
9543 "group": "Fax_Accounts",
9544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9546 "filename": "server/api/faxAccount/index.js",
9547 "groupTitle": "Fax_Accounts"
9551 "url": "/api/fax/accounts/{id}/users",
9552 "title": "Removes agents from a fax account",
9555 "title": "Example usage:",
9556 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9560 "name": "RemoveAgents",
9561 "group": "Fax_Accounts",
9562 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9564 "filename": "server/api/faxAccount/index.js",
9565 "groupTitle": "Fax_Accounts"
9569 "url": "/api/fax/accounts/{id}/canned_answers",
9570 "title": "Removes canned answers from account",
9573 "title": "Example usage:",
9574 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9578 "name": "RemoveAnswers",
9579 "group": "Fax_Accounts",
9580 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9582 "filename": "server/api/faxAccount/index.js",
9583 "groupTitle": "Fax_Accounts"
9587 "url": "/api/fax/accounts/{id}/dispositions",
9588 "title": "Removes dispositions from account",
9591 "title": "Example usage:",
9592 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9596 "name": "RemoveDispositions",
9597 "group": "Fax_Accounts",
9598 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9600 "filename": "server/api/faxAccount/index.js",
9601 "groupTitle": "Fax_Accounts"
9605 "url": "/api/fax/accounts/{id}",
9606 "title": "Gets a single Account",
9609 "title": "Example usage:",
9610 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9614 "name": "ShowAccounts",
9615 "group": "Fax_Accounts",
9616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9618 "filename": "server/api/faxAccount/index.js",
9619 "groupTitle": "Fax_Accounts"
9623 "url": "/api/fax/accounts/{id}/canned_answers",
9624 "title": "Creates new canned answer",
9627 "title": "Example usage:",
9628 "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",
9632 "name": "addAnswer",
9633 "group": "Fax_Accounts",
9655 "field": "description",
9668 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9670 "filename": "server/api/faxAccount/index.js",
9671 "groupTitle": "Fax_Accounts"
9675 "url": "/api/fax/accounts/addaccountapplications",
9676 "title": "Creates new account and applications",
9679 "title": "Example usage:",
9680 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9684 "name": "addApplications",
9685 "group": "Fax_Accounts",
9693 "field": "priority",
9714 "field": "description",
9721 "field": "interval",
9727 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9729 "filename": "server/api/faxAccount/index.js",
9730 "groupTitle": "Fax_Accounts"
9734 "url": "/api/fax/accounts/{id}/applications",
9735 "title": "Creates new applications",
9738 "title": "Example usage:",
9739 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9743 "name": "addApplications",
9744 "group": "Fax_Accounts",
9752 "field": "priority",
9773 "field": "description",
9780 "field": "interval",
9786 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9788 "filename": "server/api/faxAccount/index.js",
9789 "groupTitle": "Fax_Accounts"
9793 "url": "/api/fax/accounts/{id}/dispositions",
9794 "title": "Creates new disposition",
9797 "title": "Example usage:",
9798 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9802 "name": "addDisposition",
9803 "group": "Fax_Accounts",
9817 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9819 "filename": "server/api/faxAccount/index.js",
9820 "groupTitle": "Fax_Accounts"
9824 "url": "/api/fax/accounts/{id}/interactions",
9825 "title": "Creates new interactions",
9828 "title": "Example usage:",
9829 "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",
9833 "name": "addInteraction",
9834 "group": "Fax_Accounts",
9849 "field": "closedAt",
9856 "field": "disposition",
9870 "field": "read1stAt",
9888 "field": "firstMsgDirection",
9895 "field": "lastMsgAt",
9906 "field": "lastMsgDirection",
9912 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9914 "filename": "server/api/faxAccount/index.js",
9915 "groupTitle": "Fax_Accounts"
9919 "url": "/api/fax/accounts/{id}/canned_answers",
9920 "title": "Gets account canned answers",
9923 "title": "Example usage:",
9924 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
9928 "name": "getAnswers",
9929 "group": "Fax_Accounts",
9930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9932 "filename": "server/api/faxAccount/index.js",
9933 "groupTitle": "Fax_Accounts"
9937 "url": "/api/fax/accounts/{id}/applications",
9938 "title": "Gets account pplications",
9941 "title": "Example usage:",
9942 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
9946 "name": "getApplications",
9947 "group": "Fax_Accounts",
9948 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9950 "filename": "server/api/faxAccount/index.js",
9951 "groupTitle": "Fax_Accounts"
9955 "url": "/api/fax/accounts/{id}/dispositions",
9956 "title": "Gets account dispositions",
9959 "title": "Example usage:",
9960 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
9964 "name": "getDispositions",
9965 "group": "Fax_Accounts",
9966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9968 "filename": "server/api/faxAccount/index.js",
9969 "groupTitle": "Fax_Accounts"
9973 "url": "/api/fax/accounts/{id}/interactions",
9974 "title": "Gets account interactions",
9977 "title": "Example usage:",
9978 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
9982 "name": "getInteraction",
9983 "group": "Fax_Accounts",
9984 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9986 "filename": "server/api/faxAccount/index.js",
9987 "groupTitle": "Fax_Accounts"
9991 "url": "/api/fax/accounts/{id}/messages",
9992 "title": "Gets account messages",
9995 "title": "Example usage:",
9996 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10000 "name": "getMessages",
10001 "group": "Fax_Accounts",
10002 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10003 "version": "0.0.0",
10004 "filename": "server/api/faxAccount/index.js",
10005 "groupTitle": "Fax_Accounts"
10009 "url": "/api/fax/accounts/{id}/send",
10010 "title": "Send new fax",
10013 "title": "Example usage:",
10014 "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",
10019 "group": "Fax_Accounts",
10020 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10021 "version": "0.0.0",
10022 "filename": "server/api/faxAccount/index.js",
10023 "groupTitle": "Fax_Accounts"
10027 "url": "/api/fax/accounts/{id}",
10028 "title": "Update an existing Account",
10031 "title": "Example usage:",
10032 "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",
10036 "name": "updateAccounts",
10037 "group": "Fax_Accounts",
10038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10039 "version": "0.0.0",
10040 "filename": "server/api/faxAccount/index.js",
10041 "groupTitle": "Fax_Accounts"
10045 "url": "/api/fax/accounts/updateaccountapplications",
10046 "title": "Update account and applications",
10049 "title": "Example usage:",
10050 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10054 "name": "updateApplications",
10055 "group": "Fax_Accounts",
10063 "field": "priority",
10077 "field": "appdata",
10084 "field": "description",
10091 "field": "interval",
10097 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10098 "version": "0.0.0",
10099 "filename": "server/api/faxAccount/index.js",
10100 "groupTitle": "Fax_Accounts"
10104 "url": "/api/fax/applications",
10105 "title": "Creates a new Application",
10108 "title": "Example usage:",
10109 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10113 "name": "CreateApplications",
10114 "group": "Fax_Applications",
10122 "field": "priority",
10136 "field": "appdata",
10143 "field": "description",
10150 "field": "interval",
10156 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10157 "version": "0.0.0",
10158 "filename": "server/api/faxApplication/index.js",
10159 "groupTitle": "Fax_Applications"
10163 "url": "/api/fax/applications/{id}",
10164 "title": "Deletes a Application",
10167 "title": "Example usage:",
10168 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10172 "name": "DeleteApplications",
10173 "group": "Fax_Applications",
10174 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10175 "version": "0.0.0",
10176 "filename": "server/api/faxApplication/index.js",
10177 "groupTitle": "Fax_Applications"
10181 "url": "/api/fax/applications",
10182 "title": "Gets a list of Applications",
10185 "title": "Example usage:",
10186 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10190 "name": "GetApplications",
10191 "group": "Fax_Applications",
10192 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10193 "version": "0.0.0",
10194 "filename": "server/api/faxApplication/index.js",
10195 "groupTitle": "Fax_Applications"
10199 "url": "/api/fax/applications/{id}",
10200 "title": "Gets a single Application",
10203 "title": "Example usage:",
10204 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10208 "name": "ShowApplications",
10209 "group": "Fax_Applications",
10210 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10211 "version": "0.0.0",
10212 "filename": "server/api/faxApplication/index.js",
10213 "groupTitle": "Fax_Applications"
10217 "url": "/api/fax/applications/{id}",
10218 "title": "Update an existing Application",
10221 "title": "Example usage:",
10222 "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",
10226 "name": "updateApplications",
10227 "group": "Fax_Applications",
10228 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10229 "version": "0.0.0",
10230 "filename": "server/api/faxApplication/index.js",
10231 "groupTitle": "Fax_Applications"
10235 "url": "/api/fax/interactions/{id}/tags",
10236 "title": "Add tags to the interaction",
10239 "title": "Example usage:",
10240 "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",
10245 "group": "Fax_Interactions",
10246 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10247 "version": "0.0.0",
10248 "filename": "server/api/faxInteraction/index.js",
10249 "groupTitle": "Fax_Interactions"
10253 "url": "/api/fax/interactions",
10254 "title": "Creates a new Interaction",
10257 "title": "Example usage:",
10258 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10262 "name": "CreateInteractions",
10263 "group": "Fax_Interactions",
10278 "field": "closedAt",
10285 "field": "disposition",
10299 "field": "read1stAt",
10317 "field": "firstMsgDirection",
10324 "field": "lastMsgAt",
10335 "field": "lastMsgDirection",
10341 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10342 "version": "0.0.0",
10343 "filename": "server/api/faxInteraction/index.js",
10344 "groupTitle": "Fax_Interactions"
10348 "url": "/api/fax/interactions/{id}",
10349 "title": "Deletes a Interaction",
10352 "title": "Example usage:",
10353 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10357 "name": "DeleteInteractions",
10358 "group": "Fax_Interactions",
10359 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10360 "version": "0.0.0",
10361 "filename": "server/api/faxInteraction/index.js",
10362 "groupTitle": "Fax_Interactions"
10366 "url": "/api/fax/interactions/describe",
10367 "title": "Gets table info about Interactions",
10370 "title": "Example usage:",
10371 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10375 "name": "DescribeInteractions",
10376 "group": "Fax_Interactions",
10377 "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>",
10378 "version": "0.0.0",
10379 "filename": "server/api/faxInteraction/index.js",
10380 "groupTitle": "Fax_Interactions"
10384 "url": "/api/fax/interactions",
10385 "title": "Gets a list of Interactions",
10388 "title": "Example usage:",
10389 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10393 "name": "GetInteractions",
10394 "group": "Fax_Interactions",
10395 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10396 "version": "0.0.0",
10397 "filename": "server/api/faxInteraction/index.js",
10398 "groupTitle": "Fax_Interactions"
10402 "url": "/api/fax/interactions/{id}/tags",
10403 "title": "Removes tags from interaction",
10406 "title": "Example usage:",
10407 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10411 "name": "RemoveTags",
10412 "group": "Fax_Interactions",
10413 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10414 "version": "0.0.0",
10415 "filename": "server/api/faxInteraction/index.js",
10416 "groupTitle": "Fax_Interactions"
10420 "url": "/api/fax/interactions/{id}",
10421 "title": "Gets a single Interaction",
10424 "title": "Example usage:",
10425 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10429 "name": "ShowInteractions",
10430 "group": "Fax_Interactions",
10431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10432 "version": "0.0.0",
10433 "filename": "server/api/faxInteraction/index.js",
10434 "groupTitle": "Fax_Interactions"
10438 "url": "/api/fax/interactions/{id}/messages",
10439 "title": "Creates new messages",
10442 "title": "Example usage:",
10443 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10447 "name": "addMessage",
10448 "group": "Fax_Interactions",
10474 "field": "direction",
10481 "field": "failMessage",
10494 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10495 "version": "0.0.0",
10496 "filename": "server/api/faxInteraction/index.js",
10497 "groupTitle": "Fax_Interactions"
10501 "url": "/api/fax/interactions/{id}/download",
10502 "title": "Get interactions",
10505 "title": "Example usage:",
10506 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10510 "name": "download",
10511 "group": "Fax_Interactions",
10512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10513 "version": "0.0.0",
10514 "filename": "server/api/faxInteraction/index.js",
10515 "groupTitle": "Fax_Interactions"
10519 "url": "/api/fax/interactions/{id}/messages",
10520 "title": "Gets interaction messages",
10523 "title": "Example usage:",
10524 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10528 "name": "getMessages",
10529 "group": "Fax_Interactions",
10530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10531 "version": "0.0.0",
10532 "filename": "server/api/faxInteraction/index.js",
10533 "groupTitle": "Fax_Interactions"
10537 "url": "/api/fax/interactions/{id}",
10538 "title": "Update an existing Interaction",
10541 "title": "Example usage:",
10542 "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",
10546 "name": "updateInteractions",
10547 "group": "Fax_Interactions",
10548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10549 "version": "0.0.0",
10550 "filename": "server/api/faxInteraction/index.js",
10551 "groupTitle": "Fax_Interactions"
10555 "url": "/api/fax/messages/{id}/download",
10556 "title": "Get message",
10559 "title": "Example usage:",
10560 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10564 "name": "download",
10565 "group": "Fax_Message",
10566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10567 "version": "0.0.0",
10568 "filename": "server/api/faxMessage/index.js",
10569 "groupTitle": "Fax_Message"
10573 "url": "/api/fax/messages/{id}",
10574 "title": "Deletes a Message",
10577 "title": "Example usage:",
10578 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10582 "name": "DeleteMessages",
10583 "group": "Fax_Messages",
10584 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10585 "version": "0.0.0",
10586 "filename": "server/api/faxMessage/index.js",
10587 "groupTitle": "Fax_Messages"
10591 "url": "/api/fax/messages/describe",
10592 "title": "Gets table info about Messages",
10595 "title": "Example usage:",
10596 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10600 "name": "DescribeMessages",
10601 "group": "Fax_Messages",
10602 "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>",
10603 "version": "0.0.0",
10604 "filename": "server/api/faxMessage/index.js",
10605 "groupTitle": "Fax_Messages"
10609 "url": "/api/fax/messages",
10610 "title": "Gets a list of Messages",
10613 "title": "Example usage:",
10614 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10618 "name": "GetMessages",
10619 "group": "Fax_Messages",
10620 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10621 "version": "0.0.0",
10622 "filename": "server/api/faxMessage/index.js",
10623 "groupTitle": "Fax_Messages"
10627 "url": "/api/fax/messages/{id}",
10628 "title": "Gets a single Message",
10631 "title": "Example usage:",
10632 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10636 "name": "ShowMessages",
10637 "group": "Fax_Messages",
10638 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10639 "version": "0.0.0",
10640 "filename": "server/api/faxMessage/index.js",
10641 "groupTitle": "Fax_Messages"
10645 "url": "/api/fax/messages/{id}/accept",
10646 "title": "Accepts message",
10649 "title": "Example usage:",
10650 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10654 "name": "acceptMessage",
10655 "group": "Fax_Messages",
10656 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10657 "version": "0.0.0",
10658 "filename": "server/api/faxMessage/index.js",
10659 "groupTitle": "Fax_Messages"
10663 "url": "/api/fax/messages/{id}/reject",
10664 "title": "Rejects message",
10667 "title": "Example usage:",
10668 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10672 "name": "rejectMessage",
10673 "group": "Fax_Messages",
10674 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10675 "version": "0.0.0",
10676 "filename": "server/api/faxMessage/index.js",
10677 "groupTitle": "Fax_Messages"
10681 "url": "/api/fax/messages",
10682 "title": "Create message and send Fax",
10685 "title": "Example usage:",
10686 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10690 "name": "rejectMessage",
10691 "group": "Fax_Messages",
10692 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10693 "version": "0.0.0",
10694 "filename": "server/api/faxMessage/index.js",
10695 "groupTitle": "Fax_Messages"
10699 "url": "/api/fax/messages/{id}",
10700 "title": "Update an existing Message",
10703 "title": "Example usage:",
10704 "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",
10708 "name": "updateMessages",
10709 "group": "Fax_Messages",
10710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10711 "version": "0.0.0",
10712 "filename": "server/api/faxMessage/index.js",
10713 "groupTitle": "Fax_Messages"
10717 "url": "/api/fax/reports/queue",
10718 "title": "Creates a new Fax Queue Report",
10721 "title": "Example usage:",
10722 "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",
10726 "name": "CreateFax_Queue_Reports",
10727 "group": "Fax_Queue_Reports",
10735 "field": "uniqueid",
10756 "field": "leaveAt",
10763 "field": "acceptAt",
10783 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10784 "version": "0.0.0",
10785 "filename": "server/api/faxQueueReport/index.js",
10786 "groupTitle": "Fax_Queue_Reports"
10790 "url": "/api/fax/reports/queue/{id}",
10791 "title": "Deletes a Fax Queue Report",
10794 "title": "Example usage:",
10795 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10799 "name": "DeleteFax_Queue_Reports",
10800 "group": "Fax_Queue_Reports",
10801 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10802 "version": "0.0.0",
10803 "filename": "server/api/faxQueueReport/index.js",
10804 "groupTitle": "Fax_Queue_Reports"
10808 "url": "/api/fax/reports/queue/describe",
10809 "title": "Gets table info about Fax Queue Reports",
10812 "title": "Example usage:",
10813 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10817 "name": "DescribeFax_Queue_Reports",
10818 "group": "Fax_Queue_Reports",
10819 "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>",
10820 "version": "0.0.0",
10821 "filename": "server/api/faxQueueReport/index.js",
10822 "groupTitle": "Fax_Queue_Reports"
10826 "url": "/api/fax/reports/queue",
10827 "title": "Gets a list of Fax Queue Reports",
10830 "title": "Example usage:",
10831 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10835 "name": "GetFax_Queue_Reports",
10836 "group": "Fax_Queue_Reports",
10837 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10838 "version": "0.0.0",
10839 "filename": "server/api/faxQueueReport/index.js",
10840 "groupTitle": "Fax_Queue_Reports"
10844 "url": "/api/fax/reports/queue/{id}",
10845 "title": "Gets a single Fax Queue Report",
10848 "title": "Example usage:",
10849 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
10853 "name": "ShowFax_Queue_Reports",
10854 "group": "Fax_Queue_Reports",
10855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10856 "version": "0.0.0",
10857 "filename": "server/api/faxQueueReport/index.js",
10858 "groupTitle": "Fax_Queue_Reports"
10862 "url": "/api/fax/reports/queue/{id}",
10863 "title": "Update an existing Fax Queue Report",
10866 "title": "Example usage:",
10867 "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",
10871 "name": "updateFax_Queue_Reports",
10872 "group": "Fax_Queue_Reports",
10873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10874 "version": "0.0.0",
10875 "filename": "server/api/faxQueueReport/index.js",
10876 "groupTitle": "Fax_Queue_Reports"
10880 "url": "/api/fax/queues/{id}/users",
10881 "title": "Add agents to a queue",
10884 "title": "Example usage:",
10885 "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",
10889 "name": "AddAgents",
10890 "group": "Fax_Queues",
10891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10892 "version": "0.0.0",
10893 "filename": "server/api/faxQueue/index.js",
10894 "groupTitle": "Fax_Queues"
10898 "url": "/api/fax/queues/{id}/teams",
10899 "title": "Add teams to a queue",
10902 "title": "Example usage:",
10903 "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",
10907 "name": "AddTeams",
10908 "group": "Fax_Queues",
10909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10910 "version": "0.0.0",
10911 "filename": "server/api/faxQueue/index.js",
10912 "groupTitle": "Fax_Queues"
10916 "url": "/api/fax/queues",
10917 "title": "Creates a new Queue",
10920 "title": "Example usage:",
10921 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10925 "name": "CreateQueues",
10926 "group": "Fax_Queues",
10941 "field": "description",
10948 "field": "timeout",
10960 "field": "strategy",
10967 "field": "lastAgent",
10973 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10974 "version": "0.0.0",
10975 "filename": "server/api/faxQueue/index.js",
10976 "groupTitle": "Fax_Queues"
10980 "url": "/api/fax/queues/{id}",
10981 "title": "Deletes a Queue",
10984 "title": "Example usage:",
10985 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
10989 "name": "DeleteQueues",
10990 "group": "Fax_Queues",
10991 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10992 "version": "0.0.0",
10993 "filename": "server/api/faxQueue/index.js",
10994 "groupTitle": "Fax_Queues"
10998 "url": "/api/fax/queues/describe",
10999 "title": "Gets table info about Queues",
11002 "title": "Example usage:",
11003 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11007 "name": "DescribeQueues",
11008 "group": "Fax_Queues",
11009 "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>",
11010 "version": "0.0.0",
11011 "filename": "server/api/faxQueue/index.js",
11012 "groupTitle": "Fax_Queues"
11016 "url": "/api/fax/queues/{id}/users",
11017 "title": "Gets queue agents",
11020 "title": "Example usage:",
11021 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11025 "name": "GetAgents",
11026 "group": "Fax_Queues",
11027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11028 "version": "0.0.0",
11029 "filename": "server/api/faxQueue/index.js",
11030 "groupTitle": "Fax_Queues"
11034 "url": "/api/fax/queues/{id}/members",
11035 "title": "GetMembers",
11038 "title": "Example usage:",
11039 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11043 "name": "GetMembers",
11044 "group": "Fax_Queues",
11045 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11046 "version": "0.0.0",
11047 "filename": "server/api/faxQueue/index.js",
11048 "groupTitle": "Fax_Queues"
11052 "url": "/api/fax/queues",
11053 "title": "Gets a list of Queues",
11056 "title": "Example usage:",
11057 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11061 "name": "GetQueues",
11062 "group": "Fax_Queues",
11063 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11064 "version": "0.0.0",
11065 "filename": "server/api/faxQueue/index.js",
11066 "groupTitle": "Fax_Queues"
11070 "url": "/api/fax/queues/{id}/teams",
11071 "title": "Gets queues list",
11074 "title": "Example usage:",
11075 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11079 "name": "GetTeams",
11080 "group": "Fax_Queues",
11081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11082 "version": "0.0.0",
11083 "filename": "server/api/faxQueue/index.js",
11084 "groupTitle": "Fax_Queues"
11088 "url": "/api/fax/queues/{id}/users",
11089 "title": "Removes agents from a queue",
11092 "title": "Example usage:",
11093 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11097 "name": "RemoveAgents",
11098 "group": "Fax_Queues",
11099 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11100 "version": "0.0.0",
11101 "filename": "server/api/faxQueue/index.js",
11102 "groupTitle": "Fax_Queues"
11106 "url": "/api/fax/queues/{id}",
11107 "title": "Gets a single Queue",
11110 "title": "Example usage:",
11111 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11115 "name": "ShowQueues",
11116 "group": "Fax_Queues",
11117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11118 "version": "0.0.0",
11119 "filename": "server/api/faxQueue/index.js",
11120 "groupTitle": "Fax_Queues"
11124 "url": "/api/fax/queues/{id}",
11125 "title": "Update an existing Queue",
11128 "title": "Example usage:",
11129 "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",
11133 "name": "updateQueues",
11134 "group": "Fax_Queues",
11135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11136 "version": "0.0.0",
11137 "filename": "server/api/faxQueue/index.js",
11138 "groupTitle": "Fax_Queues"
11142 "url": "/api/fax/reports/transfer",
11143 "title": "Creates a new Fax Transfer Report",
11146 "title": "Example usage:",
11147 "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",
11151 "name": "CreateFax_Transfer_Reports",
11152 "group": "Fax_Transfer_Reports",
11160 "field": "uniqueid",
11179 "field": "transferredAt",
11185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11186 "version": "0.0.0",
11187 "filename": "server/api/faxTransferReport/index.js",
11188 "groupTitle": "Fax_Transfer_Reports"
11192 "url": "/api/fax/reports/transfer/{id}",
11193 "title": "Deletes a Fax Transfer Report",
11196 "title": "Example usage:",
11197 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11201 "name": "DeleteFax_Transfer_Reports",
11202 "group": "Fax_Transfer_Reports",
11203 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11204 "version": "0.0.0",
11205 "filename": "server/api/faxTransferReport/index.js",
11206 "groupTitle": "Fax_Transfer_Reports"
11210 "url": "/api/fax/reports/transfer/describe",
11211 "title": "Gets table info about Fax Transfer Reports",
11214 "title": "Example usage:",
11215 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11219 "name": "DescribeFax_Transfer_Reports",
11220 "group": "Fax_Transfer_Reports",
11221 "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>",
11222 "version": "0.0.0",
11223 "filename": "server/api/faxTransferReport/index.js",
11224 "groupTitle": "Fax_Transfer_Reports"
11228 "url": "/api/fax/reports/transfer",
11229 "title": "Gets a list of Fax Transfer Reports",
11232 "title": "Example usage:",
11233 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11237 "name": "GetFax_Transfer_Reports",
11238 "group": "Fax_Transfer_Reports",
11239 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11240 "version": "0.0.0",
11241 "filename": "server/api/faxTransferReport/index.js",
11242 "groupTitle": "Fax_Transfer_Reports"
11246 "url": "/api/fax/reports/transfer/{id}",
11247 "title": "Gets a single Fax Transfer Report",
11250 "title": "Example usage:",
11251 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11255 "name": "ShowFax_Transfer_Reports",
11256 "group": "Fax_Transfer_Reports",
11257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11258 "version": "0.0.0",
11259 "filename": "server/api/faxTransferReport/index.js",
11260 "groupTitle": "Fax_Transfer_Reports"
11264 "url": "/api/fax/reports/transfer/{id}",
11265 "title": "Update an existing Fax Transfer Report",
11268 "title": "Example usage:",
11269 "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",
11273 "name": "updateFax_Transfer_Reports",
11274 "group": "Fax_Transfer_Reports",
11275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11276 "version": "0.0.0",
11277 "filename": "server/api/faxTransferReport/index.js",
11278 "groupTitle": "Fax_Transfer_Reports"
11282 "url": "/api/integrations/freshdesk/accounts",
11283 "title": "Creates a new Freshdesk Account",
11286 "title": "Example usage:",
11287 "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",
11291 "name": "CreateFreshdesk_Accounts",
11292 "group": "Freshdesk_Accounts",
11307 "field": "description",
11314 "field": "username",
11328 "field": "remoteUri",
11335 "field": "serverUrl",
11341 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11342 "version": "0.0.0",
11343 "filename": "server/api/intFreshdeskAccount/index.js",
11344 "groupTitle": "Freshdesk_Accounts"
11348 "url": "/api/integrations/freshdesk/accounts/{id}",
11349 "title": "Deletes a Freshdesk Account",
11352 "title": "Example usage:",
11353 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11357 "name": "DeleteFreshdesk_Accounts",
11358 "group": "Freshdesk_Accounts",
11359 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11360 "version": "0.0.0",
11361 "filename": "server/api/intFreshdeskAccount/index.js",
11362 "groupTitle": "Freshdesk_Accounts"
11366 "url": "/api/integrations/freshdesk/accounts",
11367 "title": "Gets a list of Freshdesk Accounts",
11370 "title": "Example usage:",
11371 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11375 "name": "GetFreshdesk_Accounts",
11376 "group": "Freshdesk_Accounts",
11377 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11378 "version": "0.0.0",
11379 "filename": "server/api/intFreshdeskAccount/index.js",
11380 "groupTitle": "Freshdesk_Accounts"
11384 "url": "/api/integrations/freshdesk/accounts/{id}",
11385 "title": "Gets a single Freshdesk Account",
11388 "title": "Example usage:",
11389 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11393 "name": "ShowFreshdesk_Accounts",
11394 "group": "Freshdesk_Accounts",
11395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11396 "version": "0.0.0",
11397 "filename": "server/api/intFreshdeskAccount/index.js",
11398 "groupTitle": "Freshdesk_Accounts"
11402 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11403 "title": "Creates new configuration",
11406 "title": "Example usage:",
11407 "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",
11411 "name": "addConfiguration",
11412 "group": "Freshdesk_Accounts",
11413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11414 "version": "0.0.0",
11415 "filename": "server/api/intFreshdeskAccount/index.js",
11416 "groupTitle": "Freshdesk_Accounts"
11420 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11421 "title": "Gets account configurations",
11424 "title": "Example usage:",
11425 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11429 "name": "getConfigurations",
11430 "group": "Freshdesk_Accounts",
11431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11432 "version": "0.0.0",
11433 "filename": "server/api/intFreshdeskAccount/index.js",
11434 "groupTitle": "Freshdesk_Accounts"
11438 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11439 "title": "Gets account fields",
11442 "title": "Example usage:",
11443 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11447 "name": "getFields",
11448 "group": "Freshdesk_Accounts",
11449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11450 "version": "0.0.0",
11451 "filename": "server/api/intFreshdeskAccount/index.js",
11452 "groupTitle": "Freshdesk_Accounts"
11456 "url": "/api/integrations/freshdesk/accounts/{id}",
11457 "title": "Update an existing Freshdesk Account",
11460 "title": "Example usage:",
11461 "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",
11465 "name": "updateFreshdesk_Accounts",
11466 "group": "Freshdesk_Accounts",
11467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11468 "version": "0.0.0",
11469 "filename": "server/api/intFreshdeskAccount/index.js",
11470 "groupTitle": "Freshdesk_Accounts"
11474 "url": "/api/integrations/freshdesk/configurations",
11475 "title": "Creates a new Freshdesk Configuration",
11478 "title": "Example usage:",
11479 "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",
11483 "name": "CreateFreshdesk_Configurations",
11484 "group": "Freshdesk_Configurations",
11499 "field": "description",
11505 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11506 "version": "0.0.0",
11507 "filename": "server/api/intFreshdeskConfiguration/index.js",
11508 "groupTitle": "Freshdesk_Configurations"
11512 "url": "/api/integrations/freshdesk/configurations/{id}",
11513 "title": "Deletes a Freshdesk Configuration",
11516 "title": "Example usage:",
11517 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11521 "name": "DeleteFreshdesk_Configurations",
11522 "group": "Freshdesk_Configurations",
11523 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11524 "version": "0.0.0",
11525 "filename": "server/api/intFreshdeskConfiguration/index.js",
11526 "groupTitle": "Freshdesk_Configurations"
11530 "url": "/api/integrations/freshdesk/configurations",
11531 "title": "Gets a list of Freshdesk Configurations",
11534 "title": "Example usage:",
11535 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11539 "name": "GetFreshdesk_Configurations",
11540 "group": "Freshdesk_Configurations",
11541 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11542 "version": "0.0.0",
11543 "filename": "server/api/intFreshdeskConfiguration/index.js",
11544 "groupTitle": "Freshdesk_Configurations"
11548 "url": "/api/integrations/freshdesk/configurations/{id}",
11549 "title": "Gets a single Freshdesk Configuration",
11552 "title": "Example usage:",
11553 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11557 "name": "ShowFreshdesk_Configurations",
11558 "group": "Freshdesk_Configurations",
11559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11560 "version": "0.0.0",
11561 "filename": "server/api/intFreshdeskConfiguration/index.js",
11562 "groupTitle": "Freshdesk_Configurations"
11566 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11567 "title": "Gets configurations descriptions",
11570 "title": "Example usage:",
11571 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11575 "name": "getDescriptions",
11576 "group": "Freshdesk_Configurations",
11577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11578 "version": "0.0.0",
11579 "filename": "server/api/intFreshdeskConfiguration/index.js",
11580 "groupTitle": "Freshdesk_Configurations"
11584 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11585 "title": "Gets configurations fields",
11588 "title": "Example usage:",
11589 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11593 "name": "getFields",
11594 "group": "Freshdesk_Configurations",
11595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11596 "version": "0.0.0",
11597 "filename": "server/api/intFreshdeskConfiguration/index.js",
11598 "groupTitle": "Freshdesk_Configurations"
11602 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11603 "title": "Gets configurations subjects",
11606 "title": "Example usage:",
11607 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11611 "name": "getSubjects",
11612 "group": "Freshdesk_Configurations",
11613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11614 "version": "0.0.0",
11615 "filename": "server/api/intFreshdeskConfiguration/index.js",
11616 "groupTitle": "Freshdesk_Configurations"
11620 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11621 "title": "Gets configurations tags",
11624 "title": "Example usage:",
11625 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11630 "group": "Freshdesk_Configurations",
11631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11632 "version": "0.0.0",
11633 "filename": "server/api/intFreshdeskConfiguration/index.js",
11634 "groupTitle": "Freshdesk_Configurations"
11638 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11639 "title": "Sets new tags",
11642 "title": "Example usage:",
11643 "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",
11648 "group": "Freshdesk_Configurations",
11649 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11650 "version": "0.0.0",
11651 "filename": "server/api/intFreshdeskConfiguration/index.js",
11652 "groupTitle": "Freshdesk_Configurations"
11656 "url": "/api/integrations/freshdesk/configurations/{id}",
11657 "title": "Update an existing Freshdesk Configuration",
11660 "title": "Example usage:",
11661 "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",
11665 "name": "updateFreshdesk_Configurations",
11666 "group": "Freshdesk_Configurations",
11667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11668 "version": "0.0.0",
11669 "filename": "server/api/intFreshdeskConfiguration/index.js",
11670 "groupTitle": "Freshdesk_Configurations"
11674 "url": "/api/integrations/freshdesk/fields",
11675 "title": "Creates a new Freshdesk Field",
11678 "title": "Example usage:",
11679 "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",
11683 "name": "CreateFreshdesk_Fields",
11684 "group": "Freshdesk_Fields",
11694 "\"customVariable\"",
11705 "field": "content",
11721 "\"customVariable\""
11724 "field": "keyType",
11731 "field": "keyContent",
11738 "field": "idField",
11745 "field": "nameField",
11752 "field": "customField",
11759 "field": "variableName",
11765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11766 "version": "0.0.0",
11767 "filename": "server/api/intFreshdeskField/index.js",
11768 "groupTitle": "Freshdesk_Fields"
11772 "url": "/api/integrations/freshdesk/fields/{id}",
11773 "title": "Deletes a Freshdesk Field",
11776 "title": "Example usage:",
11777 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11781 "name": "DeleteFreshdesk_Fields",
11782 "group": "Freshdesk_Fields",
11783 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11784 "version": "0.0.0",
11785 "filename": "server/api/intFreshdeskField/index.js",
11786 "groupTitle": "Freshdesk_Fields"
11790 "url": "/api/integrations/freshdesk/fields",
11791 "title": "Gets a list of Freshdesk Fields",
11794 "title": "Example usage:",
11795 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11799 "name": "GetFreshdesk_Fields",
11800 "group": "Freshdesk_Fields",
11801 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11802 "version": "0.0.0",
11803 "filename": "server/api/intFreshdeskField/index.js",
11804 "groupTitle": "Freshdesk_Fields"
11808 "url": "/api/integrations/freshdesk/fields/{id}",
11809 "title": "Gets a single Freshdesk Field",
11812 "title": "Example usage:",
11813 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11817 "name": "ShowFreshdesk_Fields",
11818 "group": "Freshdesk_Fields",
11819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11820 "version": "0.0.0",
11821 "filename": "server/api/intFreshdeskField/index.js",
11822 "groupTitle": "Freshdesk_Fields"
11826 "url": "/api/integrations/freshdesk/fields/{id}",
11827 "title": "Update an existing Freshdesk Field",
11830 "title": "Example usage:",
11831 "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",
11835 "name": "updateFreshdesk_Fields",
11836 "group": "Freshdesk_Fields",
11837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11838 "version": "0.0.0",
11839 "filename": "server/api/intFreshdeskField/index.js",
11840 "groupTitle": "Freshdesk_Fields"
11844 "url": "/api/integrations/freshsales/accounts",
11845 "title": "Creates a new Freshsales Account",
11848 "title": "Example usage:",
11849 "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",
11853 "name": "CreateFreshsales_Accounts",
11854 "group": "Freshsales_Accounts",
11869 "field": "description",
11876 "field": "username",
11890 "field": "remoteUri",
11897 "field": "serverUrl",
11903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11904 "version": "0.0.0",
11905 "filename": "server/api/intFreshsalesAccount/index.js",
11906 "groupTitle": "Freshsales_Accounts"
11910 "url": "/api/integrations/freshsales/accounts/{id}",
11911 "title": "Deletes a Freshsales Account",
11914 "title": "Example usage:",
11915 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
11919 "name": "DeleteFreshsales_Accounts",
11920 "group": "Freshsales_Accounts",
11921 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11922 "version": "0.0.0",
11923 "filename": "server/api/intFreshsalesAccount/index.js",
11924 "groupTitle": "Freshsales_Accounts"
11928 "url": "/api/integrations/freshsales/accounts",
11929 "title": "Gets a list of Freshsales Accounts",
11932 "title": "Example usage:",
11933 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
11937 "name": "GetFreshsales_Accounts",
11938 "group": "Freshsales_Accounts",
11939 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11940 "version": "0.0.0",
11941 "filename": "server/api/intFreshsalesAccount/index.js",
11942 "groupTitle": "Freshsales_Accounts"
11946 "url": "/api/integrations/freshsales/accounts/{id}",
11947 "title": "Gets a single Freshsales Account",
11950 "title": "Example usage:",
11951 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
11955 "name": "ShowFreshsales_Accounts",
11956 "group": "Freshsales_Accounts",
11957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11958 "version": "0.0.0",
11959 "filename": "server/api/intFreshsalesAccount/index.js",
11960 "groupTitle": "Freshsales_Accounts"
11964 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11965 "title": "Creates new configuration",
11968 "title": "Example usage:",
11969 "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",
11973 "name": "addConfiguration",
11974 "group": "Freshsales_Accounts",
11975 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11976 "version": "0.0.0",
11977 "filename": "server/api/intFreshsalesAccount/index.js",
11978 "groupTitle": "Freshsales_Accounts"
11982 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11983 "title": "Gets account configurations",
11986 "title": "Example usage:",
11987 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11991 "name": "getConfigurations",
11992 "group": "Freshsales_Accounts",
11993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11994 "version": "0.0.0",
11995 "filename": "server/api/intFreshsalesAccount/index.js",
11996 "groupTitle": "Freshsales_Accounts"
12000 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12001 "title": "Gets account fields",
12004 "title": "Example usage:",
12005 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12009 "name": "getFields",
12010 "group": "Freshsales_Accounts",
12011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12012 "version": "0.0.0",
12013 "filename": "server/api/intFreshsalesAccount/index.js",
12014 "groupTitle": "Freshsales_Accounts"
12018 "url": "/api/integrations/freshsales/accounts/{id}",
12019 "title": "Update an existing Freshsales Account",
12022 "title": "Example usage:",
12023 "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",
12027 "name": "updateFreshsales_Accounts",
12028 "group": "Freshsales_Accounts",
12029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12030 "version": "0.0.0",
12031 "filename": "server/api/intFreshsalesAccount/index.js",
12032 "groupTitle": "Freshsales_Accounts"
12036 "url": "/api/integrations/freshsales/configurations",
12037 "title": "Creates a new Freshsales Configuration",
12040 "title": "Example usage:",
12041 "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",
12045 "name": "CreateFreshsales_Configurations",
12046 "group": "Freshsales_Configurations",
12061 "field": "description",
12067 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12068 "version": "0.0.0",
12069 "filename": "server/api/intFreshsalesConfiguration/index.js",
12070 "groupTitle": "Freshsales_Configurations"
12074 "url": "/api/integrations/freshsales/configurations/{id}",
12075 "title": "Deletes a Freshsales Configuration",
12078 "title": "Example usage:",
12079 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12083 "name": "DeleteFreshsales_Configurations",
12084 "group": "Freshsales_Configurations",
12085 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12086 "version": "0.0.0",
12087 "filename": "server/api/intFreshsalesConfiguration/index.js",
12088 "groupTitle": "Freshsales_Configurations"
12092 "url": "/api/integrations/freshsales/configurations",
12093 "title": "Gets a list of Freshsales Configurations",
12096 "title": "Example usage:",
12097 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12101 "name": "GetFreshsales_Configurations",
12102 "group": "Freshsales_Configurations",
12103 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12104 "version": "0.0.0",
12105 "filename": "server/api/intFreshsalesConfiguration/index.js",
12106 "groupTitle": "Freshsales_Configurations"
12110 "url": "/api/integrations/freshsales/configurations/{id}",
12111 "title": "Gets a single Freshsales Configuration",
12114 "title": "Example usage:",
12115 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12119 "name": "ShowFreshsales_Configurations",
12120 "group": "Freshsales_Configurations",
12121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12122 "version": "0.0.0",
12123 "filename": "server/api/intFreshsalesConfiguration/index.js",
12124 "groupTitle": "Freshsales_Configurations"
12128 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12129 "title": "Gets configurations descriptions",
12132 "title": "Example usage:",
12133 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12137 "name": "getDescriptions",
12138 "group": "Freshsales_Configurations",
12139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12140 "version": "0.0.0",
12141 "filename": "server/api/intFreshsalesConfiguration/index.js",
12142 "groupTitle": "Freshsales_Configurations"
12146 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12147 "title": "Gets configurations fields",
12150 "title": "Example usage:",
12151 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12155 "name": "getFields",
12156 "group": "Freshsales_Configurations",
12157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12158 "version": "0.0.0",
12159 "filename": "server/api/intFreshsalesConfiguration/index.js",
12160 "groupTitle": "Freshsales_Configurations"
12164 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12165 "title": "Gets configurations subjects",
12168 "title": "Example usage:",
12169 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12173 "name": "getSubjects",
12174 "group": "Freshsales_Configurations",
12175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12176 "version": "0.0.0",
12177 "filename": "server/api/intFreshsalesConfiguration/index.js",
12178 "groupTitle": "Freshsales_Configurations"
12182 "url": "/api/integrations/freshsales/configurations/{id}",
12183 "title": "Update an existing Freshsales Configuration",
12186 "title": "Example usage:",
12187 "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",
12191 "name": "updateFreshsales_Configurations",
12192 "group": "Freshsales_Configurations",
12193 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12194 "version": "0.0.0",
12195 "filename": "server/api/intFreshsalesConfiguration/index.js",
12196 "groupTitle": "Freshsales_Configurations"
12200 "url": "/api/integrations/freshsales/fields",
12201 "title": "Creates a new Freshsales Field",
12204 "title": "Example usage:",
12205 "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",
12209 "name": "CreateFreshsales_Fields",
12210 "group": "Freshsales_Fields",
12220 "\"customVariable\"",
12231 "field": "content",
12247 "\"customVariable\""
12250 "field": "keyType",
12257 "field": "keyContent",
12264 "field": "idField",
12271 "field": "nameField",
12278 "field": "customField",
12285 "field": "variableName",
12291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12292 "version": "0.0.0",
12293 "filename": "server/api/intFreshsalesField/index.js",
12294 "groupTitle": "Freshsales_Fields"
12298 "url": "/api/integrations/freshsales/fields/{id}",
12299 "title": "Deletes a Freshsales Field",
12302 "title": "Example usage:",
12303 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12307 "name": "DeleteFreshsales_Fields",
12308 "group": "Freshsales_Fields",
12309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12310 "version": "0.0.0",
12311 "filename": "server/api/intFreshsalesField/index.js",
12312 "groupTitle": "Freshsales_Fields"
12316 "url": "/api/integrations/freshsales/fields",
12317 "title": "Gets a list of Freshsales Fields",
12320 "title": "Example usage:",
12321 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12325 "name": "GetFreshsales_Fields",
12326 "group": "Freshsales_Fields",
12327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12328 "version": "0.0.0",
12329 "filename": "server/api/intFreshsalesField/index.js",
12330 "groupTitle": "Freshsales_Fields"
12334 "url": "/api/integrations/freshsales/fields/{id}",
12335 "title": "Gets a single Freshsales Field",
12338 "title": "Example usage:",
12339 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12343 "name": "ShowFreshsales_Fields",
12344 "group": "Freshsales_Fields",
12345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12346 "version": "0.0.0",
12347 "filename": "server/api/intFreshsalesField/index.js",
12348 "groupTitle": "Freshsales_Fields"
12352 "url": "/api/integrations/freshsales/fields/{id}",
12353 "title": "Update an existing Freshsales Field",
12356 "title": "Example usage:",
12357 "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",
12361 "name": "updateFreshsales_Fields",
12362 "group": "Freshsales_Fields",
12363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12364 "version": "0.0.0",
12365 "filename": "server/api/intFreshsalesField/index.js",
12366 "groupTitle": "Freshsales_Fields"
12370 "url": "/api/campaigns/{id}/blacklists",
12371 "title": "Add blacklists to an IVR campaign",
12374 "title": "Example usage:",
12375 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12379 "name": "AddBlackLists",
12380 "group": "IVR_Campaigns",
12381 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12382 "version": "0.0.0",
12383 "filename": "server/api/campaign/index.js",
12384 "groupTitle": "IVR_Campaigns"
12388 "url": "/api/campaigns/{id}/lists",
12389 "title": "Add lists to an IVR campaign",
12392 "title": "Example usage:",
12393 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12397 "name": "AddLists",
12398 "group": "IVR_Campaigns",
12399 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12400 "version": "0.0.0",
12401 "filename": "server/api/campaign/index.js",
12402 "groupTitle": "IVR_Campaigns"
12406 "url": "/api/campaigns/clone",
12407 "title": "Clone an existing IVR Campaign",
12410 "title": "Example usage:",
12411 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12415 "name": "CloneIVR_Campaigns",
12416 "group": "IVR_Campaigns",
12417 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12418 "version": "0.0.0",
12419 "filename": "server/api/campaign/index.js",
12420 "groupTitle": "IVR_Campaigns"
12424 "url": "/api/campaigns",
12425 "title": "Creates a new IVR Campaign",
12428 "title": "Example usage:",
12429 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12433 "name": "CreateIVR_Campaigns",
12434 "group": "IVR_Campaigns",
12459 "field": "description",
12467 "description": "<p>Active/Disactive Campaign</p>"
12473 "field": "limitCalls",
12474 "description": "<p>Max 200 calls.</p>"
12480 "field": "dialOriginateCallerIdName",
12487 "field": "dialOriginateCallerIdNumber",
12494 "field": "dialOriginateTimeout",
12495 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12501 "field": "dialCongestionMaxRetry",
12502 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12508 "field": "dialCongestionRetryFrequency",
12509 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12515 "field": "dialBusyMaxRetry",
12516 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12522 "field": "dialBusyRetryFrequency",
12523 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12529 "field": "dialNoAnswerMaxRetry",
12530 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12536 "field": "dialNoAnswerRetryFrequency",
12537 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12543 "field": "dialGlobalMaxRetry",
12544 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12550 "field": "dialTimezone",
12557 "field": "dialGlobalInterval",
12569 "field": "dialCheckDuplicateType",
12576 "field": "dialAMDActive",
12577 "description": "<p>Active/Disactive AMD</p>"
12583 "field": "dialAMDInitialSilence",
12584 "description": "<p>#AMD Initial Silence</p>"
12590 "field": "dialAMDGreeting",
12591 "description": "<p>#AMD Greeting</p>"
12597 "field": "dialAMDAfterGreetingSilence",
12598 "description": "<p>#AMD After Greeting Silence</p>"
12604 "field": "dialAMDTotalAnalysisTime",
12605 "description": "<p>#AMD Total Analysis Time</p>"
12611 "field": "dialAMDMinWordLength",
12612 "description": "<p>#AMD Min Word Length</p>"
12618 "field": "dialAMDBetweenWordsSilence",
12619 "description": "<p>#AMD Between Words Silence</p>"
12625 "field": "dialAMDMaximumNumberOfWords",
12626 "description": "<p>#AMD Maximum Number Of Words</p>"
12632 "field": "dialAMDSilenceThreshold",
12633 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12639 "field": "dialAMDMaximumWordLength",
12640 "description": "<p>#AMD Maximum Word Length</p>"
12650 "field": "dialOrderByScheduledAt",
12657 "field": "dialPrefix",
12664 "field": "dialRandomLastDigitCallerIdNumber",
12665 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12671 "field": "dialCutDigit",
12672 "description": "<p>Cut Digit (min:1, max:15)</p>"
12678 "field": "dialNoSuchNumberMaxRetry",
12679 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12685 "field": "dialNoSuchNumberRetryFrequency",
12686 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12692 "field": "dialDropMaxRetry",
12693 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12699 "field": "dialDropRetryFrequency",
12700 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12706 "field": "dialAbandonedMaxRetry",
12707 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12713 "field": "dialAbandonedRetryFrequency",
12714 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12720 "field": "dialMachineMaxRetry",
12721 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12727 "field": "dialMachineRetryFrequency",
12728 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12734 "field": "dialAgentRejectMaxRetry",
12735 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12741 "field": "dialAgentRejectRetryFrequency",
12742 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12748 "version": "0.0.0",
12749 "filename": "server/api/campaign/index.js",
12750 "groupTitle": "IVR_Campaigns"
12754 "url": "/api/campaigns/{id}",
12755 "title": "Deletes a IVR Campaign",
12758 "title": "Example usage:",
12759 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12763 "name": "DeleteIVR_Campaigns",
12764 "group": "IVR_Campaigns",
12765 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12766 "version": "0.0.0",
12767 "filename": "server/api/campaign/index.js",
12768 "groupTitle": "IVR_Campaigns"
12772 "url": "/api/campaigns/{id}/blacklists",
12773 "title": "Get IVR campaign blacklists",
12776 "title": "Example usage:",
12777 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12781 "name": "GetBlackLists",
12782 "group": "IVR_Campaigns",
12783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12784 "version": "0.0.0",
12785 "filename": "server/api/campaign/index.js",
12786 "groupTitle": "IVR_Campaigns"
12790 "url": "/api/campaigns/{id}/finals",
12791 "title": "Gets IVR campaign hopper finals",
12794 "title": "Example usage:",
12795 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12799 "name": "GetHopperFinals",
12800 "group": "IVR_Campaigns",
12801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12802 "version": "0.0.0",
12803 "filename": "server/api/campaign/index.js",
12804 "groupTitle": "IVR_Campaigns"
12808 "url": "/api/campaigns/{id}/hopper_histories",
12809 "title": "Gets IVR campaign hopper histories",
12812 "title": "Example usage:",
12813 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12817 "name": "GetHopperHistories",
12818 "group": "IVR_Campaigns",
12819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12820 "version": "0.0.0",
12821 "filename": "server/api/campaign/index.js",
12822 "groupTitle": "IVR_Campaigns"
12826 "url": "/api/campaigns/{id}/hoppers",
12827 "title": "Gets IVR campaign hoppers",
12830 "title": "Example usage:",
12831 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12835 "name": "GetHoppers",
12836 "group": "IVR_Campaigns",
12837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12838 "version": "0.0.0",
12839 "filename": "server/api/campaign/index.js",
12840 "groupTitle": "IVR_Campaigns"
12844 "url": "/api/campaigns",
12845 "title": "Gets a list of IVR Campaigns",
12848 "title": "Example usage:",
12849 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
12853 "name": "GetIVR_Campaigns",
12854 "group": "IVR_Campaigns",
12855 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12856 "version": "0.0.0",
12857 "filename": "server/api/campaign/index.js",
12858 "groupTitle": "IVR_Campaigns"
12862 "url": "/api/campaigns/{id}/lists",
12863 "title": "Get IVR campaign lists",
12866 "title": "Example usage:",
12867 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
12871 "name": "GetLists",
12872 "group": "IVR_Campaigns",
12873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12874 "version": "0.0.0",
12875 "filename": "server/api/campaign/index.js",
12876 "groupTitle": "IVR_Campaigns"
12880 "url": "/api/campaigns/{id}/blacklists",
12881 "title": "Remove blacklists from an IVR Campaign",
12884 "title": "Example usage:",
12885 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12889 "name": "RemoveBlackLists",
12890 "group": "IVR_Campaigns",
12891 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12892 "version": "0.0.0",
12893 "filename": "server/api/campaign/index.js",
12894 "groupTitle": "IVR_Campaigns"
12898 "url": "/api/campaigns/{id}/lists",
12899 "title": "Remove lists from an IVR Campaign",
12902 "title": "Example usage:",
12903 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12907 "name": "RemoveLists",
12908 "group": "IVR_Campaigns",
12909 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12910 "version": "0.0.0",
12911 "filename": "server/api/campaign/index.js",
12912 "groupTitle": "IVR_Campaigns"
12916 "url": "/api/campaigns/{id}",
12917 "title": "Gets a single IVR Campaign",
12920 "title": "Example usage:",
12921 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
12925 "name": "ShowIVR_Campaigns",
12926 "group": "IVR_Campaigns",
12927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12928 "version": "0.0.0",
12929 "filename": "server/api/campaign/index.js",
12930 "groupTitle": "IVR_Campaigns"
12934 "url": "/api/campaigns/{id}/blacks",
12935 "title": "Gets IVR campaign hopper blacks",
12938 "title": "Example usage:",
12939 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
12943 "name": "getHopperBlacks",
12944 "group": "IVR_Campaigns",
12945 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12946 "version": "0.0.0",
12947 "filename": "server/api/campaign/index.js",
12948 "groupTitle": "IVR_Campaigns"
12952 "url": "/api/campaigns/{id}",
12953 "title": "Update an existing IVR Campaign",
12956 "title": "Example usage:",
12957 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12961 "name": "updateIVR_Campaigns",
12962 "group": "IVR_Campaigns",
12963 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12964 "version": "0.0.0",
12965 "filename": "server/api/campaign/index.js",
12966 "groupTitle": "IVR_Campaigns"
12970 "url": "/api/integrations/reports",
12971 "title": "Creates a new Integration Report",
12974 "title": "Example usage:",
12975 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12979 "name": "CreateIntegration_Reports",
12980 "group": "Integration_Reports",
12988 "field": "integration",
12995 "field": "eventChannel",
13002 "field": "exitStatus",
13009 "field": "ticketId",
13016 "field": "integrationId",
13023 "field": "contacts",
13030 "field": "uniqueid",
13037 "field": "calleridnum",
13044 "field": "calleridname",
13058 "field": "interface",
13065 "field": "membername",
13072 "field": "agentcalledAt",
13079 "field": "agentconnectAt",
13086 "field": "holdtime",
13093 "field": "agentcomplete",
13100 "field": "agentcompleteAt",
13107 "field": "talktime",
13114 "field": "agentacw",
13121 "field": "acwtime",
13135 "field": "agentringnoanswer",
13142 "field": "agentringnoanswerAt",
13149 "field": "agentdump",
13156 "field": "agentdumpAt",
13163 "field": "lastevent",
13170 "field": "channel",
13177 "field": "channelstate",
13184 "field": "channelstatedesc",
13191 "field": "connectedlinenum",
13198 "field": "connectedlinename",
13205 "field": "language",
13212 "field": "accountcode",
13219 "field": "context",
13233 "field": "priority",
13240 "field": "destchannel",
13247 "field": "destchannelstate",
13254 "field": "destchannelstatedesc",
13261 "field": "destcalleridnum",
13268 "field": "destcalleridname",
13275 "field": "destconnectedlinenum",
13282 "field": "destconnectedlinename",
13289 "field": "destlanguage",
13296 "field": "destaccountcode",
13303 "field": "destcontext",
13310 "field": "destexten",
13317 "field": "destpriority",
13324 "field": "destuniqueid",
13331 "field": "messageId",
13338 "field": "inReplyTo",
13345 "field": "subject",
13373 "field": "attachment",
13421 "field": "appdata",
13428 "field": "projectId",
13434 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13435 "version": "0.0.0",
13436 "filename": "server/api/integrationReport/index.js",
13437 "groupTitle": "Integration_Reports"
13441 "url": "/api/integrations/reports/{id}",
13442 "title": "Deletes a Integration Report",
13445 "title": "Example usage:",
13446 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13450 "name": "DeleteIntegration_Reports",
13451 "group": "Integration_Reports",
13452 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13453 "version": "0.0.0",
13454 "filename": "server/api/integrationReport/index.js",
13455 "groupTitle": "Integration_Reports"
13459 "url": "/api/integrations/reports/describe",
13460 "title": "Gets table info about Integration Reports",
13463 "title": "Example usage:",
13464 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13468 "name": "DescribeIntegration_Reports",
13469 "group": "Integration_Reports",
13470 "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>",
13471 "version": "0.0.0",
13472 "filename": "server/api/integrationReport/index.js",
13473 "groupTitle": "Integration_Reports"
13477 "url": "/api/integrations/reports",
13478 "title": "Gets a list of Integration Reports",
13481 "title": "Example usage:",
13482 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13486 "name": "GetIntegration_Reports",
13487 "group": "Integration_Reports",
13488 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13489 "version": "0.0.0",
13490 "filename": "server/api/integrationReport/index.js",
13491 "groupTitle": "Integration_Reports"
13495 "url": "/api/integrations/reports/{id}",
13496 "title": "Gets a single Integration Report",
13499 "title": "Example usage:",
13500 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13504 "name": "ShowIntegration_Reports",
13505 "group": "Integration_Reports",
13506 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13507 "version": "0.0.0",
13508 "filename": "server/api/integrationReport/index.js",
13509 "groupTitle": "Integration_Reports"
13513 "url": "/api/integrations/reports/{id}",
13514 "title": "Update an existing Integration Report",
13517 "title": "Example usage:",
13518 "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",
13522 "name": "updateIntegration_Reports",
13523 "group": "Integration_Reports",
13524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13525 "version": "0.0.0",
13526 "filename": "server/api/integrationReport/index.js",
13527 "groupTitle": "Integration_Reports"
13531 "url": "/api/intervals",
13532 "title": "Creates a new Interval",
13535 "title": "Example usage:",
13536 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13540 "name": "CreateIntervals",
13541 "group": "Intervals",
13556 "field": "description",
13563 "field": "interval",
13569 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13570 "version": "0.0.0",
13571 "filename": "server/api/interval/index.js",
13572 "groupTitle": "Intervals"
13576 "url": "/api/intervals/{id}",
13577 "title": "Deletes a Interval",
13580 "title": "Example usage:",
13581 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13585 "name": "DeleteIntervals",
13586 "group": "Intervals",
13587 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13588 "version": "0.0.0",
13589 "filename": "server/api/interval/index.js",
13590 "groupTitle": "Intervals"
13594 "url": "/api/intervals",
13595 "title": "Gets a list of Intervals",
13598 "title": "Example usage:",
13599 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13603 "name": "GetIntervals",
13604 "group": "Intervals",
13605 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13606 "version": "0.0.0",
13607 "filename": "server/api/interval/index.js",
13608 "groupTitle": "Intervals"
13612 "url": "/api/intervals/{id}",
13613 "title": "Gets a single Interval",
13616 "title": "Example usage:",
13617 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13621 "name": "ShowIntervals",
13622 "group": "Intervals",
13623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13624 "version": "0.0.0",
13625 "filename": "server/api/interval/index.js",
13626 "groupTitle": "Intervals"
13630 "url": "/api/intervals/{id}/sub_intervals",
13631 "title": "Creates a new sub interval",
13634 "title": "Example usage:",
13635 "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",
13639 "name": "addInterval",
13640 "group": "Intervals",
13641 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13642 "version": "0.0.0",
13643 "filename": "server/api/interval/index.js",
13644 "groupTitle": "Intervals"
13648 "url": "/api/intervals/{id}/sub_intervals/create_many",
13649 "title": "Create new sub intervals set",
13652 "title": "Example usage:",
13653 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13657 "name": "addIntervals",
13658 "group": "Intervals",
13659 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13660 "version": "0.0.0",
13661 "filename": "server/api/interval/index.js",
13662 "groupTitle": "Intervals"
13666 "url": "/api/intervals/{id}/sub_intervals",
13667 "title": "Get sub intervals set",
13670 "title": "Example usage:",
13671 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13675 "name": "getIntervals",
13676 "group": "Intervals",
13677 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13678 "version": "0.0.0",
13679 "filename": "server/api/interval/index.js",
13680 "groupTitle": "Intervals"
13684 "url": "/api/intervals/{id}",
13685 "title": "Update an existing Interval",
13688 "title": "Example usage:",
13689 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13693 "name": "updateIntervals",
13694 "group": "Intervals",
13695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13696 "version": "0.0.0",
13697 "filename": "server/api/interval/index.js",
13698 "groupTitle": "Intervals"
13702 "url": "/api/jira",
13703 "title": "Creates a new issue",
13706 "title": "Example usage:",
13707 "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}",
13711 "name": "Creates_Issue",
13723 "field": "issuetype",
13730 "field": "summary",
13737 "field": "description",
13743 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13744 "version": "0.0.0",
13745 "filename": "server/api/jira/index.js",
13746 "groupTitle": "Issue"
13750 "url": "/api/jscripty/answers/reports",
13751 "title": "Creates a new Report",
13754 "title": "Example usage:",
13755 "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",
13759 "name": "CreateReports",
13760 "group": "JscriptyAnswerReport",
13768 "field": "question",
13782 "field": "membername",
13789 "field": "projectname",
13803 "field": "uniqueid",
13810 "field": "calleridname",
13817 "field": "calleridnum",
13824 "field": "questionId",
13830 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13831 "version": "0.0.0",
13832 "filename": "server/api/jscriptyAnswerReport/index.js",
13833 "groupTitle": "JscriptyAnswerReport"
13837 "url": "/api/jscripty/answers/reports/{id}",
13838 "title": "Deletes a Report",
13841 "title": "Example usage:",
13842 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
13846 "name": "DeleteReports",
13847 "group": "JscriptyAnswerReport",
13848 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13849 "version": "0.0.0",
13850 "filename": "server/api/jscriptyAnswerReport/index.js",
13851 "groupTitle": "JscriptyAnswerReport"
13855 "url": "/api/jscripty/answers/reports/describe",
13856 "title": "Gets table info about Reports",
13859 "title": "Example usage:",
13860 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
13864 "name": "DescribeReports",
13865 "group": "JscriptyAnswerReport",
13866 "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>",
13867 "version": "0.0.0",
13868 "filename": "server/api/jscriptyAnswerReport/index.js",
13869 "groupTitle": "JscriptyAnswerReport"
13873 "url": "/api/jscripty/answers/reports",
13874 "title": "Gets a list of Reports",
13877 "title": "Example usage:",
13878 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
13882 "name": "GetReports",
13883 "group": "JscriptyAnswerReport",
13884 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13885 "version": "0.0.0",
13886 "filename": "server/api/jscriptyAnswerReport/index.js",
13887 "groupTitle": "JscriptyAnswerReport"
13891 "url": "/api/jscripty/answers/reports/{id}",
13892 "title": "Gets a single Report",
13895 "title": "Example usage:",
13896 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
13900 "name": "ShowReports",
13901 "group": "JscriptyAnswerReport",
13902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13903 "version": "0.0.0",
13904 "filename": "server/api/jscriptyAnswerReport/index.js",
13905 "groupTitle": "JscriptyAnswerReport"
13909 "url": "/api/jscripty/answers/reports/{id}",
13910 "title": "Update an existing Report",
13913 "title": "Example usage:",
13914 "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",
13918 "name": "updateReports",
13919 "group": "JscriptyAnswerReport",
13920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13921 "version": "0.0.0",
13922 "filename": "server/api/jscriptyAnswerReport/index.js",
13923 "groupTitle": "JscriptyAnswerReport"
13927 "url": "/api/jscripty/questions/reports",
13928 "title": "Creates a new Report",
13931 "title": "Example usage:",
13932 "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",
13936 "name": "CreateReports",
13937 "group": "JscriptyQuestionReport",
13945 "field": "question",
13959 "field": "membername",
13966 "field": "projectname",
13980 "field": "uniqueid",
13987 "field": "calleridname",
13994 "field": "calleridnum",
14001 "field": "questionId",
14007 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14008 "version": "0.0.0",
14009 "filename": "server/api/jscriptyQuestionReport/index.js",
14010 "groupTitle": "JscriptyQuestionReport"
14014 "url": "/api/jscripty/questions/reports/{id}",
14015 "title": "Deletes a Report",
14018 "title": "Example usage:",
14019 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14023 "name": "DeleteReports",
14024 "group": "JscriptyQuestionReport",
14025 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14026 "version": "0.0.0",
14027 "filename": "server/api/jscriptyQuestionReport/index.js",
14028 "groupTitle": "JscriptyQuestionReport"
14032 "url": "/api/jscripty/questions/reports/describe",
14033 "title": "Gets table info about Reports",
14036 "title": "Example usage:",
14037 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14041 "name": "DescribeReports",
14042 "group": "JscriptyQuestionReport",
14043 "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>",
14044 "version": "0.0.0",
14045 "filename": "server/api/jscriptyQuestionReport/index.js",
14046 "groupTitle": "JscriptyQuestionReport"
14050 "url": "/api/jscripty/questions/reports",
14051 "title": "Gets a list of Reports",
14054 "title": "Example usage:",
14055 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14059 "name": "GetReports",
14060 "group": "JscriptyQuestionReport",
14061 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14062 "version": "0.0.0",
14063 "filename": "server/api/jscriptyQuestionReport/index.js",
14064 "groupTitle": "JscriptyQuestionReport"
14068 "url": "/api/jscripty/questions/reports/{id}",
14069 "title": "Gets a single Report",
14072 "title": "Example usage:",
14073 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14077 "name": "ShowReports",
14078 "group": "JscriptyQuestionReport",
14079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14080 "version": "0.0.0",
14081 "filename": "server/api/jscriptyQuestionReport/index.js",
14082 "groupTitle": "JscriptyQuestionReport"
14086 "url": "/api/jscripty/questions/reports/{id}",
14087 "title": "Update an existing Report",
14090 "title": "Example usage:",
14091 "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",
14095 "name": "updateReports",
14096 "group": "JscriptyQuestionReport",
14097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14098 "version": "0.0.0",
14099 "filename": "server/api/jscriptyQuestionReport/index.js",
14100 "groupTitle": "JscriptyQuestionReport"
14104 "url": "/api/jscripty/sessions/reports",
14105 "title": "Creates a new Report",
14108 "title": "Example usage:",
14109 "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",
14113 "name": "CreateReports",
14114 "group": "JscriptySessionReport",
14122 "field": "starttime",
14129 "field": "endtime",
14136 "field": "membername",
14143 "field": "projectname",
14157 "field": "uniqueid",
14164 "field": "calleridname",
14171 "field": "calleridnum",
14178 "field": "completed",
14184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14185 "version": "0.0.0",
14186 "filename": "server/api/jscriptySessionReport/index.js",
14187 "groupTitle": "JscriptySessionReport"
14191 "url": "/api/jscripty/sessions/reports/{id}",
14192 "title": "Deletes a Report",
14195 "title": "Example usage:",
14196 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14200 "name": "DeleteReports",
14201 "group": "JscriptySessionReport",
14202 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14203 "version": "0.0.0",
14204 "filename": "server/api/jscriptySessionReport/index.js",
14205 "groupTitle": "JscriptySessionReport"
14209 "url": "/api/jscripty/sessions/reports/describe",
14210 "title": "Gets table info about Reports",
14213 "title": "Example usage:",
14214 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14218 "name": "DescribeReports",
14219 "group": "JscriptySessionReport",
14220 "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>",
14221 "version": "0.0.0",
14222 "filename": "server/api/jscriptySessionReport/index.js",
14223 "groupTitle": "JscriptySessionReport"
14227 "url": "/api/jscripty/sessions/reports",
14228 "title": "Gets a list of Reports",
14231 "title": "Example usage:",
14232 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14236 "name": "GetReports",
14237 "group": "JscriptySessionReport",
14238 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14239 "version": "0.0.0",
14240 "filename": "server/api/jscriptySessionReport/index.js",
14241 "groupTitle": "JscriptySessionReport"
14245 "url": "/api/jscripty/sessions/reports/{id}",
14246 "title": "Gets a single Report",
14249 "title": "Example usage:",
14250 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14254 "name": "ShowReports",
14255 "group": "JscriptySessionReport",
14256 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14257 "version": "0.0.0",
14258 "filename": "server/api/jscriptySessionReport/index.js",
14259 "groupTitle": "JscriptySessionReport"
14263 "url": "/api/jscripty/sessions/reports/{id}/questions",
14264 "title": "Gets Jscripty Session questions",
14267 "title": "Example usage:",
14268 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14272 "name": "getQuestions",
14273 "group": "JscriptySessionReport",
14274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14275 "version": "0.0.0",
14276 "filename": "server/api/jscriptySessionReport/index.js",
14277 "groupTitle": "JscriptySessionReport"
14281 "url": "/api/jscripty/sessions/reports/{id}",
14282 "title": "Update an existing Report",
14285 "title": "Example usage:",
14286 "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",
14290 "name": "updateReports",
14291 "group": "JscriptySessionReport",
14292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14293 "version": "0.0.0",
14294 "filename": "server/api/jscriptySessionReport/index.js",
14295 "groupTitle": "JscriptySessionReport"
14299 "url": "/api/jscripty/projects/clone",
14300 "title": "Clone an existing Project",
14303 "title": "Example usage:",
14304 "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",
14308 "name": "CloneProjects",
14309 "group": "Jscripty_Projects",
14310 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14311 "version": "0.0.0",
14312 "filename": "server/api/jscriptyProject/index.js",
14313 "groupTitle": "Jscripty_Projects"
14317 "url": "/api/jscripty/projects",
14318 "title": "Creates a new Project",
14321 "title": "Example usage:",
14322 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14326 "name": "CreateProjects",
14327 "group": "Jscripty_Projects",
14342 "field": "description",
14349 "field": "formData",
14356 "field": "enableUncompleteSave",
14363 "field": "sendUnpauseOnSubmit",
14369 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14370 "version": "0.0.0",
14371 "filename": "server/api/jscriptyProject/index.js",
14372 "groupTitle": "Jscripty_Projects"
14376 "url": "/api/jscripty/projects/{id}",
14377 "title": "Deletes a Project",
14380 "title": "Example usage:",
14381 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14385 "name": "DeleteProjects",
14386 "group": "Jscripty_Projects",
14387 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14388 "version": "0.0.0",
14389 "filename": "server/api/jscriptyProject/index.js",
14390 "groupTitle": "Jscripty_Projects"
14394 "url": "/api/jscripty/projects",
14395 "title": "Gets a list of Projects",
14398 "title": "Example usage:",
14399 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14403 "name": "GetProjects",
14404 "group": "Jscripty_Projects",
14405 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14406 "version": "0.0.0",
14407 "filename": "server/api/jscriptyProject/index.js",
14408 "groupTitle": "Jscripty_Projects"
14412 "url": "/api/jscripty/projects/{id}",
14413 "title": "Gets a single Project",
14416 "title": "Example usage:",
14417 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14421 "name": "ShowProjects",
14422 "group": "Jscripty_Projects",
14423 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14424 "version": "0.0.0",
14425 "filename": "server/api/jscriptyProject/index.js",
14426 "groupTitle": "Jscripty_Projects"
14430 "url": "/api/jscripty/projects/{id}/answers",
14431 "title": "Gets jscripty project answers",
14434 "title": "Example usage:",
14435 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14439 "name": "getAnswers",
14440 "group": "Jscripty_Projects",
14441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14442 "version": "0.0.0",
14443 "filename": "server/api/jscriptyProject/index.js",
14444 "groupTitle": "Jscripty_Projects"
14448 "url": "/api/jscripty/projects/{id}/sessions",
14449 "title": "Gets jscripty project sessions",
14452 "title": "Example usage:",
14453 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14457 "name": "getSessions",
14458 "group": "Jscripty_Projects",
14459 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14460 "version": "0.0.0",
14461 "filename": "server/api/jscriptyProject/index.js",
14462 "groupTitle": "Jscripty_Projects"
14466 "url": "/api/jscripty/projects/{id}/summary",
14467 "title": "Gets jscripty project summary",
14470 "title": "Example usage:",
14471 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14475 "name": "getSummary",
14476 "group": "Jscripty_Projects",
14477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14478 "version": "0.0.0",
14479 "filename": "server/api/jscriptyProject/index.js",
14480 "groupTitle": "Jscripty_Projects"
14484 "url": "/api/jscripty/projects/{id}",
14485 "title": "Update an existing Project",
14488 "title": "Example usage:",
14489 "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",
14493 "name": "updateProjects",
14494 "group": "Jscripty_Projects",
14495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14496 "version": "0.0.0",
14497 "filename": "server/api/jscriptyProject/index.js",
14498 "groupTitle": "Jscripty_Projects"
14502 "url": "/api/license",
14503 "title": "Gets License Info",
14506 "title": "Example usage:",
14507 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14512 "group": "License",
14513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14514 "version": "0.0.0",
14515 "filename": "server/api/license/index.js",
14516 "groupTitle": "License"
14520 "url": "/api/license/{id}",
14521 "title": "Update License Info",
14524 "title": "Example usage:",
14525 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14530 "group": "License",
14531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14532 "version": "0.0.0",
14533 "filename": "server/api/license/index.js",
14534 "groupTitle": "License"
14538 "url": "/api/mail/accounts/{id}/users",
14539 "title": "Add agents to a mail account",
14542 "title": "Example usage:",
14543 "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",
14547 "name": "AddAgents",
14548 "group": "Mail_Accounts",
14549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14550 "version": "0.0.0",
14551 "filename": "server/api/mailAccount/index.js",
14552 "groupTitle": "Mail_Accounts"
14556 "url": "/api/mail/accounts/{id}/in_servers",
14557 "title": "Creates a new IMAP server",
14560 "title": "Example usage:",
14561 "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",
14566 "group": "Mail_Accounts",
14574 "field": "description",
14588 "field": "authentication",
14602 "field": "password",
14623 "field": "mailbox",
14630 "field": "connTimeout",
14637 "field": "authTimeout",
14644 "field": "service",
14650 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14651 "version": "0.0.0",
14652 "filename": "server/api/mailAccount/index.js",
14653 "groupTitle": "Mail_Accounts"
14657 "url": "/api/mail/accounts/{id}/out_servers",
14658 "title": "Creates a new SMTP server",
14661 "title": "Example usage:",
14662 "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",
14667 "group": "Mail_Accounts",
14675 "field": "description",
14717 "field": "service",
14724 "field": "authentication",
14730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14731 "version": "0.0.0",
14732 "filename": "server/api/mailAccount/index.js",
14733 "groupTitle": "Mail_Accounts"
14737 "url": "/api/mail/accounts/{id}",
14738 "title": "Deletes a mail account",
14741 "title": "Example usage:",
14742 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14746 "name": "DeleteMailAccounts",
14747 "group": "Mail_Accounts",
14748 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14749 "version": "0.0.0",
14750 "filename": "server/api/mailAccount/index.js",
14751 "groupTitle": "Mail_Accounts"
14755 "url": "/api/mail/accounts/describe",
14756 "title": "Gets table info about Accounts",
14759 "title": "Example usage:",
14760 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14764 "name": "DescribeAccounts",
14765 "group": "Mail_Accounts",
14766 "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>",
14767 "version": "0.0.0",
14768 "filename": "server/api/mailAccount/index.js",
14769 "groupTitle": "Mail_Accounts"
14773 "url": "/api/mail/accounts",
14774 "title": "Gets a list of Accounts",
14777 "title": "Example usage:",
14778 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14782 "name": "GetAccounts",
14783 "group": "Mail_Accounts",
14784 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14785 "version": "0.0.0",
14786 "filename": "server/api/mailAccount/index.js",
14787 "groupTitle": "Mail_Accounts"
14791 "url": "/api/mail/accounts/{id}/users",
14792 "title": "Gets agents from mail account",
14795 "title": "Example usage:",
14796 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14800 "name": "GetAgents",
14801 "group": "Mail_Accounts",
14802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14803 "version": "0.0.0",
14804 "filename": "server/api/mailAccount/index.js",
14805 "groupTitle": "Mail_Accounts"
14809 "url": "/api/mail/accounts/{id}/in_servers",
14810 "title": "Gets account IMAP server",
14813 "title": "Example usage:",
14814 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14819 "group": "Mail_Accounts",
14820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14821 "version": "0.0.0",
14822 "filename": "server/api/mailAccount/index.js",
14823 "groupTitle": "Mail_Accounts"
14827 "url": "/api/mail/accounts/{id}/out_servers",
14828 "title": "Gets account SMTP server",
14831 "title": "Example usage:",
14832 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14837 "group": "Mail_Accounts",
14838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14839 "version": "0.0.0",
14840 "filename": "server/api/mailAccount/index.js",
14841 "groupTitle": "Mail_Accounts"
14845 "url": "/api/mail/accounts/{id}/users",
14846 "title": "Removes agents from a mail account",
14849 "title": "Example usage:",
14850 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14854 "name": "RemoveAgents",
14855 "group": "Mail_Accounts",
14856 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14857 "version": "0.0.0",
14858 "filename": "server/api/mailAccount/index.js",
14859 "groupTitle": "Mail_Accounts"
14863 "url": "/api/mail/accounts/{id}/canned_answers",
14864 "title": "Removes canned answers from account",
14867 "title": "Example usage:",
14868 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14872 "name": "RemoveAnswers",
14873 "group": "Mail_Accounts",
14874 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14875 "version": "0.0.0",
14876 "filename": "server/api/mailAccount/index.js",
14877 "groupTitle": "Mail_Accounts"
14881 "url": "/api/mail/accounts/{id}/dispositions",
14882 "title": "Removes dispositions from account",
14885 "title": "Example usage:",
14886 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14890 "name": "RemoveDispositions",
14891 "group": "Mail_Accounts",
14892 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14893 "version": "0.0.0",
14894 "filename": "server/api/mailAccount/index.js",
14895 "groupTitle": "Mail_Accounts"
14899 "url": "/api/mail/accounts/{id}/in_servers",
14900 "title": "Removes IMAP server from an account",
14903 "title": "Example usage:",
14904 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
14908 "name": "RemoveImmap",
14909 "group": "Mail_Accounts",
14910 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14911 "version": "0.0.0",
14912 "filename": "server/api/mailAccount/index.js",
14913 "groupTitle": "Mail_Accounts"
14917 "url": "/api/mail/accounts/{id}/out_servers",
14918 "title": "Removes SMTP server from an account",
14921 "title": "Example usage:",
14922 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
14926 "name": "RemoveSmtp",
14927 "group": "Mail_Accounts",
14928 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14929 "version": "0.0.0",
14930 "filename": "server/api/mailAccount/index.js",
14931 "groupTitle": "Mail_Accounts"
14935 "url": "/api/mail/accounts/{id}",
14936 "title": "Gets a single Account",
14939 "title": "Example usage:",
14940 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
14944 "name": "ShowAccounts",
14945 "group": "Mail_Accounts",
14946 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14947 "version": "0.0.0",
14948 "filename": "server/api/mailAccount/index.js",
14949 "groupTitle": "Mail_Accounts"
14953 "url": "/api/mail/accounts/{id}/canned_answers",
14954 "title": "Creates new canned answer",
14957 "title": "Example usage:",
14958 "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",
14962 "name": "addAnswer",
14963 "group": "Mail_Accounts",
14985 "field": "description",
14998 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14999 "version": "0.0.0",
15000 "filename": "server/api/mailAccount/index.js",
15001 "groupTitle": "Mail_Accounts"
15005 "url": "/api/mail/accounts/{id}/applications",
15006 "title": "Creates new applications",
15009 "title": "Example usage:",
15010 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15014 "name": "addApplications",
15015 "group": "Mail_Accounts",
15023 "field": "priority",
15037 "field": "appdata",
15044 "field": "description",
15051 "field": "interval",
15057 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15058 "version": "0.0.0",
15059 "filename": "server/api/mailAccount/index.js",
15060 "groupTitle": "Mail_Accounts"
15064 "url": "/api/mail/accounts/{id}/dispositions",
15065 "title": "Creates new disposition",
15068 "title": "Example usage:",
15069 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15073 "name": "addDisposition",
15074 "group": "Mail_Accounts",
15088 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15089 "version": "0.0.0",
15090 "filename": "server/api/mailAccount/index.js",
15091 "groupTitle": "Mail_Accounts"
15095 "url": "/api/mail/accounts/{id}/interactions",
15096 "title": "Creates new interactions",
15099 "title": "Example usage:",
15100 "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",
15104 "name": "addInteraction",
15105 "group": "Mail_Accounts",
15120 "field": "closedAt",
15127 "field": "disposition",
15141 "field": "inReplyTo",
15162 "field": "subject",
15176 "field": "read1stAt",
15183 "field": "substatus",
15190 "field": "substatusAt",
15201 "field": "firstMsgDirection",
15208 "field": "lastMsgAt",
15219 "field": "lastMsgDirection",
15226 "field": "lastMsgBody",
15233 "field": "lastMsgText",
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",
15247 "title": "Create a mail account",
15250 "title": "Example usage:",
15251 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15256 "group": "Mail_Accounts",
15257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15258 "version": "0.0.0",
15259 "filename": "server/api/mailAccount/index.js",
15260 "groupTitle": "Mail_Accounts"
15264 "url": "/api/mail/accounts/{id}/canned_answers",
15265 "title": "Gets account canned answers",
15268 "title": "Example usage:",
15269 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15273 "name": "getAnswers",
15274 "group": "Mail_Accounts",
15275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15276 "version": "0.0.0",
15277 "filename": "server/api/mailAccount/index.js",
15278 "groupTitle": "Mail_Accounts"
15282 "url": "/api/mail/accounts/{id}/applications",
15283 "title": "Gets account applications",
15286 "title": "Example usage:",
15287 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15291 "name": "getApplications",
15292 "group": "Mail_Accounts",
15293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15294 "version": "0.0.0",
15295 "filename": "server/api/mailAccount/index.js",
15296 "groupTitle": "Mail_Accounts"
15300 "url": "/api/mail/accounts/{id}/dispositions",
15301 "title": "Gets account dispositions",
15304 "title": "Example usage:",
15305 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15309 "name": "getDispositions",
15310 "group": "Mail_Accounts",
15311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15312 "version": "0.0.0",
15313 "filename": "server/api/mailAccount/index.js",
15314 "groupTitle": "Mail_Accounts"
15318 "url": "/api/mail/accounts/{id}/interactions",
15319 "title": "Gets account interactions",
15322 "title": "Example usage:",
15323 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15327 "name": "getInteraction",
15328 "group": "Mail_Accounts",
15329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15330 "version": "0.0.0",
15331 "filename": "server/api/mailAccount/index.js",
15332 "groupTitle": "Mail_Accounts"
15336 "url": "/api/mail/accounts/{id}/messages",
15337 "title": "Gets account messages",
15340 "title": "Example usage:",
15341 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15345 "name": "getMessages",
15346 "group": "Mail_Accounts",
15347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15348 "version": "0.0.0",
15349 "filename": "server/api/mailAccount/index.js",
15350 "groupTitle": "Mail_Accounts"
15354 "url": "/api/mail/accounts/{id}/send",
15355 "title": "Send new mail",
15358 "title": "Example usage:",
15359 "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",
15363 "name": "sendMail",
15364 "group": "Mail_Accounts",
15365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15366 "version": "0.0.0",
15367 "filename": "server/api/mailAccount/index.js",
15368 "groupTitle": "Mail_Accounts"
15372 "url": "/api/mail/accounts/{id}",
15373 "title": "Update an existing Account",
15376 "title": "Example usage:",
15377 "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",
15381 "name": "updateAccounts",
15382 "group": "Mail_Accounts",
15383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15384 "version": "0.0.0",
15385 "filename": "server/api/mailAccount/index.js",
15386 "groupTitle": "Mail_Accounts"
15390 "url": "/api/mail/accounts/{id}/verify",
15391 "title": "Verify mail account",
15394 "title": "Example usage:",
15395 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15399 "name": "verifySmtp",
15400 "group": "Mail_Accounts",
15401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15402 "version": "0.0.0",
15403 "filename": "server/api/mailAccount/index.js",
15404 "groupTitle": "Mail_Accounts"
15408 "url": "/api/mail/applications/{id}",
15409 "title": "Deletes a Application",
15412 "title": "Example usage:",
15413 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15417 "name": "DeleteApplications",
15418 "group": "Mail_Applications",
15419 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15420 "version": "0.0.0",
15421 "filename": "server/api/mailApplication/index.js",
15422 "groupTitle": "Mail_Applications"
15426 "url": "/api/mail/applications/{id}",
15427 "title": "Gets a single Application",
15430 "title": "Example usage:",
15431 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15435 "name": "ShowApplications",
15436 "group": "Mail_Applications",
15437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15438 "version": "0.0.0",
15439 "filename": "server/api/mailApplication/index.js",
15440 "groupTitle": "Mail_Applications"
15444 "url": "/api/mail/applications/{id}",
15445 "title": "Update an existing Application",
15448 "title": "Example usage:",
15449 "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",
15453 "name": "updateApplications",
15454 "group": "Mail_Applications",
15455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15456 "version": "0.0.0",
15457 "filename": "server/api/mailApplication/index.js",
15458 "groupTitle": "Mail_Applications"
15462 "url": "/api/mail/interactions/{id}/tags",
15463 "title": "Add tags to the interaction",
15466 "title": "Example usage:",
15467 "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",
15472 "group": "Mail_Interactions",
15473 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15474 "version": "0.0.0",
15475 "filename": "server/api/mailInteraction/index.js",
15476 "groupTitle": "Mail_Interactions"
15480 "url": "/api/mail/interactions",
15481 "title": "Creates a new Interaction",
15484 "title": "Example usage:",
15485 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15489 "name": "CreateInteractions",
15490 "group": "Mail_Interactions",
15505 "field": "closedAt",
15512 "field": "disposition",
15526 "field": "inReplyTo",
15547 "field": "subject",
15561 "field": "read1stAt",
15568 "field": "substatus",
15575 "field": "substatusAt",
15586 "field": "firstMsgDirection",
15593 "field": "lastMsgAt",
15604 "field": "lastMsgDirection",
15611 "field": "lastMsgBody",
15618 "field": "lastMsgText",
15624 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15625 "version": "0.0.0",
15626 "filename": "server/api/mailInteraction/index.js",
15627 "groupTitle": "Mail_Interactions"
15631 "url": "/api/mail/interactions/{id}",
15632 "title": "Deletes a Interaction",
15635 "title": "Example usage:",
15636 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15640 "name": "DeleteInteractions",
15641 "group": "Mail_Interactions",
15642 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15643 "version": "0.0.0",
15644 "filename": "server/api/mailInteraction/index.js",
15645 "groupTitle": "Mail_Interactions"
15649 "url": "/api/mail/interactions/describe",
15650 "title": "Gets table info about Interactions",
15653 "title": "Example usage:",
15654 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15658 "name": "DescribeInteractions",
15659 "group": "Mail_Interactions",
15660 "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>",
15661 "version": "0.0.0",
15662 "filename": "server/api/mailInteraction/index.js",
15663 "groupTitle": "Mail_Interactions"
15667 "url": "/api/mail/interactions",
15668 "title": "Gets a list of Interactions",
15671 "title": "Example usage:",
15672 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15676 "name": "GetInteractions",
15677 "group": "Mail_Interactions",
15678 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15679 "version": "0.0.0",
15680 "filename": "server/api/mailInteraction/index.js",
15681 "groupTitle": "Mail_Interactions"
15685 "url": "/api/mail/interactions/{id}/tags",
15686 "title": "Removes tags from interaction",
15689 "title": "Example usage:",
15690 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15694 "name": "RemoveTags",
15695 "group": "Mail_Interactions",
15696 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15697 "version": "0.0.0",
15698 "filename": "server/api/mailInteraction/index.js",
15699 "groupTitle": "Mail_Interactions"
15703 "url": "/api/mail/interactions/{id}",
15704 "title": "Gets a single Interaction",
15707 "title": "Example usage:",
15708 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15712 "name": "ShowInteractions",
15713 "group": "Mail_Interactions",
15714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715 "version": "0.0.0",
15716 "filename": "server/api/mailInteraction/index.js",
15717 "groupTitle": "Mail_Interactions"
15721 "url": "/api/mail/interactions/{id}/messages",
15722 "title": "Creates new message",
15725 "title": "Example usage:",
15726 "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",
15730 "name": "addMessage",
15731 "group": "Mail_Interactions",
15746 "field": "plainBody",
15764 "field": "direction",
15771 "field": "messageId",
15806 "field": "subject",
15841 "field": "originTo",
15848 "field": "originCc",
15854 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15855 "version": "0.0.0",
15856 "filename": "server/api/mailInteraction/index.js",
15857 "groupTitle": "Mail_Interactions"
15861 "url": "/api/mail/interactions/{id}/download",
15862 "title": "Gets interaction",
15865 "title": "Example usage:",
15866 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
15870 "name": "download",
15871 "group": "Mail_Interactions",
15872 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15873 "version": "0.0.0",
15874 "filename": "server/api/mailInteraction/index.js",
15875 "groupTitle": "Mail_Interactions"
15879 "url": "/api/mail/interactions/{id}/messages",
15880 "title": "Gets interaction messages",
15883 "title": "Example usage:",
15884 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
15888 "name": "getMessages",
15889 "group": "Mail_Interactions",
15890 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15891 "version": "0.0.0",
15892 "filename": "server/api/mailInteraction/index.js",
15893 "groupTitle": "Mail_Interactions"
15897 "url": "/api/mail/interactions/{id}",
15898 "title": "Update an existing Interaction",
15901 "title": "Example usage:",
15902 "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",
15906 "name": "updateInteractions",
15907 "group": "Mail_Interactions",
15908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15909 "version": "0.0.0",
15910 "filename": "server/api/mailInteraction/index.js",
15911 "groupTitle": "Mail_Interactions"
15915 "url": "/api/mail/messages/{id}",
15916 "title": "Deletes a Message",
15919 "title": "Example usage:",
15920 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
15924 "name": "DeleteMessages",
15925 "group": "Mail_Messages",
15926 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15927 "version": "0.0.0",
15928 "filename": "server/api/mailMessage/index.js",
15929 "groupTitle": "Mail_Messages"
15933 "url": "/api/mail/messages/describe",
15934 "title": "Gets table info about Messages",
15937 "title": "Example usage:",
15938 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
15942 "name": "DescribeMessages",
15943 "group": "Mail_Messages",
15944 "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>",
15945 "version": "0.0.0",
15946 "filename": "server/api/mailMessage/index.js",
15947 "groupTitle": "Mail_Messages"
15951 "url": "/api/mail/messages",
15952 "title": "Gets a list of Messages",
15955 "title": "Example usage:",
15956 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
15960 "name": "GetMessages",
15961 "group": "Mail_Messages",
15962 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15963 "version": "0.0.0",
15964 "filename": "server/api/mailMessage/index.js",
15965 "groupTitle": "Mail_Messages"
15969 "url": "/api/mail/messages/{id}",
15970 "title": "Gets a single Message",
15973 "title": "Example usage:",
15974 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
15978 "name": "ShowMessages",
15979 "group": "Mail_Messages",
15980 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15981 "version": "0.0.0",
15982 "filename": "server/api/mailMessage/index.js",
15983 "groupTitle": "Mail_Messages"
15987 "url": "/api/mail/messages/{id}/accept",
15988 "title": "Accepts message",
15991 "title": "Example usage:",
15992 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
15996 "name": "acceptMessage",
15997 "group": "Mail_Messages",
15998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15999 "version": "0.0.0",
16000 "filename": "server/api/mailMessage/index.js",
16001 "groupTitle": "Mail_Messages"
16005 "url": "/api/mail/messages",
16006 "title": "Create a message",
16009 "title": "Example usage:",
16010 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16014 "name": "createMessage",
16015 "group": "Mail_Messages",
16016 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16017 "version": "0.0.0",
16018 "filename": "server/api/mailMessage/index.js",
16019 "groupTitle": "Mail_Messages"
16023 "url": "/api/mail/messages/{id}/download",
16024 "title": "Gets message",
16027 "title": "Example usage:",
16028 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16032 "name": "download",
16033 "group": "Mail_Messages",
16034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16035 "version": "0.0.0",
16036 "filename": "server/api/mailMessage/index.js",
16037 "groupTitle": "Mail_Messages"
16041 "url": "/api/mail/messages/{id}/reject",
16042 "title": "Rejects message",
16045 "title": "Example usage:",
16046 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16050 "name": "rejectMessage",
16051 "group": "Mail_Messages",
16052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16053 "version": "0.0.0",
16054 "filename": "server/api/mailMessage/index.js",
16055 "groupTitle": "Mail_Messages"
16059 "url": "/api/mail/messages/{id}",
16060 "title": "Update an existing Message",
16063 "title": "Example usage:",
16064 "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",
16068 "name": "updateMessages",
16069 "group": "Mail_Messages",
16070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16071 "version": "0.0.0",
16072 "filename": "server/api/mailMessage/index.js",
16073 "groupTitle": "Mail_Messages"
16077 "url": "/api/mail/reports/queue",
16078 "title": "Creates a new Mail Queue Report",
16081 "title": "Example usage:",
16082 "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",
16086 "name": "CreateMail_Queue_Reports",
16087 "group": "Mail_Queue_Reports",
16095 "field": "uniqueid",
16116 "field": "leaveAt",
16123 "field": "acceptAt",
16143 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16144 "version": "0.0.0",
16145 "filename": "server/api/mailQueueReport/index.js",
16146 "groupTitle": "Mail_Queue_Reports"
16150 "url": "/api/mail/reports/queue/{id}",
16151 "title": "Deletes a Mail Queue Report",
16154 "title": "Example usage:",
16155 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16159 "name": "DeleteMail_Queue_Reports",
16160 "group": "Mail_Queue_Reports",
16161 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16162 "version": "0.0.0",
16163 "filename": "server/api/mailQueueReport/index.js",
16164 "groupTitle": "Mail_Queue_Reports"
16168 "url": "/api/mail/reports/queue/describe",
16169 "title": "Gets table info about Mail Queue Reports",
16172 "title": "Example usage:",
16173 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16177 "name": "DescribeMail_Queue_Reports",
16178 "group": "Mail_Queue_Reports",
16179 "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>",
16180 "version": "0.0.0",
16181 "filename": "server/api/mailQueueReport/index.js",
16182 "groupTitle": "Mail_Queue_Reports"
16186 "url": "/api/mail/reports/queue",
16187 "title": "Gets a list of Mail Queue Reports",
16190 "title": "Example usage:",
16191 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16195 "name": "GetMail_Queue_Reports",
16196 "group": "Mail_Queue_Reports",
16197 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16198 "version": "0.0.0",
16199 "filename": "server/api/mailQueueReport/index.js",
16200 "groupTitle": "Mail_Queue_Reports"
16204 "url": "/api/mail/reports/queue/{id}",
16205 "title": "Gets a single Mail Queue Report",
16208 "title": "Example usage:",
16209 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16213 "name": "ShowMail_Queue_Reports",
16214 "group": "Mail_Queue_Reports",
16215 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16216 "version": "0.0.0",
16217 "filename": "server/api/mailQueueReport/index.js",
16218 "groupTitle": "Mail_Queue_Reports"
16222 "url": "/api/mail/reports/queue/{id}",
16223 "title": "Update an existing Mail Queue Report",
16226 "title": "Example usage:",
16227 "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",
16231 "name": "updateMail_Queue_Reports",
16232 "group": "Mail_Queue_Reports",
16233 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16234 "version": "0.0.0",
16235 "filename": "server/api/mailQueueReport/index.js",
16236 "groupTitle": "Mail_Queue_Reports"
16240 "url": "/api/mail/queues/{id}/users",
16241 "title": "Add agents to a queue",
16244 "title": "Example usage:",
16245 "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",
16249 "name": "AddAgents",
16250 "group": "Mail_Queues",
16251 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16252 "version": "0.0.0",
16253 "filename": "server/api/mailQueue/index.js",
16254 "groupTitle": "Mail_Queues"
16258 "url": "/api/mail/queues/{id}/teams",
16259 "title": "Add teams to a queue",
16262 "title": "Example usage:",
16263 "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",
16267 "name": "AddTeams",
16268 "group": "Mail_Queues",
16269 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16270 "version": "0.0.0",
16271 "filename": "server/api/mailQueue/index.js",
16272 "groupTitle": "Mail_Queues"
16276 "url": "/api/mail/queues",
16277 "title": "Creates a new Queue",
16280 "title": "Example usage:",
16281 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16285 "name": "CreateQueues",
16286 "group": "Mail_Queues",
16301 "field": "description",
16308 "field": "timeout",
16320 "field": "strategy",
16326 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16327 "version": "0.0.0",
16328 "filename": "server/api/mailQueue/index.js",
16329 "groupTitle": "Mail_Queues"
16333 "url": "/api/mail/queues/{id}",
16334 "title": "Deletes a Queue",
16337 "title": "Example usage:",
16338 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16342 "name": "DeleteQueues",
16343 "group": "Mail_Queues",
16344 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16345 "version": "0.0.0",
16346 "filename": "server/api/mailQueue/index.js",
16347 "groupTitle": "Mail_Queues"
16351 "url": "/api/mail/queues/describe",
16352 "title": "Gets table info about Queues",
16355 "title": "Example usage:",
16356 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16360 "name": "DescribeQueues",
16361 "group": "Mail_Queues",
16362 "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>",
16363 "version": "0.0.0",
16364 "filename": "server/api/mailQueue/index.js",
16365 "groupTitle": "Mail_Queues"
16369 "url": "/api/mail/queues/{id}/users",
16370 "title": "Gets queue agents",
16373 "title": "Example usage:",
16374 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16378 "name": "GetAgents",
16379 "group": "Mail_Queues",
16380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16381 "version": "0.0.0",
16382 "filename": "server/api/mailQueue/index.js",
16383 "groupTitle": "Mail_Queues"
16387 "url": "/api/mail/queues/{id}/members",
16388 "title": "GetMembers",
16391 "title": "Example usage:",
16392 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16396 "name": "GetMembers",
16397 "group": "Mail_Queues",
16398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16399 "version": "0.0.0",
16400 "filename": "server/api/mailQueue/index.js",
16401 "groupTitle": "Mail_Queues"
16405 "url": "/api/mail/queues",
16406 "title": "Gets a list of Queues",
16409 "title": "Example usage:",
16410 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16414 "name": "GetQueues",
16415 "group": "Mail_Queues",
16416 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16417 "version": "0.0.0",
16418 "filename": "server/api/mailQueue/index.js",
16419 "groupTitle": "Mail_Queues"
16423 "url": "/api/mail/queues/{id}/teams",
16424 "title": "Gets queues list",
16427 "title": "Example usage:",
16428 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16432 "name": "GetTeams",
16433 "group": "Mail_Queues",
16434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16435 "version": "0.0.0",
16436 "filename": "server/api/mailQueue/index.js",
16437 "groupTitle": "Mail_Queues"
16441 "url": "/api/mail/queues/{id}/users",
16442 "title": "Removes agents from a queue",
16445 "title": "Example usage:",
16446 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16450 "name": "RemoveAgents",
16451 "group": "Mail_Queues",
16452 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16453 "version": "0.0.0",
16454 "filename": "server/api/mailQueue/index.js",
16455 "groupTitle": "Mail_Queues"
16459 "url": "/api/mail/queues/{id}",
16460 "title": "Gets a single Queue",
16463 "title": "Example usage:",
16464 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16468 "name": "ShowQueues",
16469 "group": "Mail_Queues",
16470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16471 "version": "0.0.0",
16472 "filename": "server/api/mailQueue/index.js",
16473 "groupTitle": "Mail_Queues"
16477 "url": "/api/mail/queues/{id}",
16478 "title": "Update an existing Queue",
16481 "title": "Example usage:",
16482 "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",
16486 "name": "updateQueues",
16487 "group": "Mail_Queues",
16488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16489 "version": "0.0.0",
16490 "filename": "server/api/mailQueue/index.js",
16491 "groupTitle": "Mail_Queues"
16495 "url": "/api/mail/out_servers",
16496 "title": "Creates a new SMTP",
16499 "title": "Example usage:",
16500 "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",
16504 "name": "CreateSMTPs",
16505 "group": "Mail_SMTP",
16513 "field": "description",
16555 "field": "service",
16562 "field": "authentication",
16568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16569 "version": "0.0.0",
16570 "filename": "server/api/mailServerOut/index.js",
16571 "groupTitle": "Mail_SMTP"
16575 "url": "/api/mail/out_servers/{id}",
16576 "title": "Deletes a SMTP",
16579 "title": "Example usage:",
16580 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16584 "name": "DeleteSMTPs",
16585 "group": "Mail_SMTP",
16586 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16587 "version": "0.0.0",
16588 "filename": "server/api/mailServerOut/index.js",
16589 "groupTitle": "Mail_SMTP"
16593 "url": "/api/mail/out_servers",
16594 "title": "Gets a list of SMTPs",
16597 "title": "Example usage:",
16598 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16602 "name": "GetSMTPs",
16603 "group": "Mail_SMTP",
16604 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16605 "version": "0.0.0",
16606 "filename": "server/api/mailServerOut/index.js",
16607 "groupTitle": "Mail_SMTP"
16611 "url": "/api/mail/out_servers/{id}",
16612 "title": "Gets a single SMTP",
16615 "title": "Example usage:",
16616 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16620 "name": "ShowSMTPs",
16621 "group": "Mail_SMTP",
16622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16623 "version": "0.0.0",
16624 "filename": "server/api/mailServerOut/index.js",
16625 "groupTitle": "Mail_SMTP"
16629 "url": "/api/mail/out_servers/{id}",
16630 "title": "Update an existing SMTP",
16633 "title": "Example usage:",
16634 "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",
16638 "name": "updateSMTPs",
16639 "group": "Mail_SMTP",
16640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16641 "version": "0.0.0",
16642 "filename": "server/api/mailServerOut/index.js",
16643 "groupTitle": "Mail_SMTP"
16647 "url": "/api/mail/substatuses",
16648 "title": "Creates a new Queue",
16651 "title": "Example usage:",
16652 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16656 "name": "CreateSubstatuses",
16657 "group": "Mail_Substatuses",
16672 "field": "description",
16678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679 "version": "0.0.0",
16680 "filename": "server/api/mailSubstatus/index.js",
16681 "groupTitle": "Mail_Substatuses"
16685 "url": "/api/mail/substatuses/{id}",
16686 "title": "Deletes a Queue",
16689 "title": "Example usage:",
16690 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16694 "name": "DeleteSubstatuses",
16695 "group": "Mail_Substatuses",
16696 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16697 "version": "0.0.0",
16698 "filename": "server/api/mailSubstatus/index.js",
16699 "groupTitle": "Mail_Substatuses"
16703 "url": "/api/mail/substatuses/describe",
16704 "title": "Gets table info about Substatuses",
16707 "title": "Example usage:",
16708 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16712 "name": "DescribeSubstatuses",
16713 "group": "Mail_Substatuses",
16714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16715 "version": "0.0.0",
16716 "filename": "server/api/mailSubstatus/index.js",
16717 "groupTitle": "Mail_Substatuses"
16721 "url": "/api/mail/substatuses",
16722 "title": "Gets a list of Substatuses",
16725 "title": "Example usage:",
16726 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16730 "name": "GetSubstatuses",
16731 "group": "Mail_Substatuses",
16732 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/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>",
16733 "version": "0.0.0",
16734 "filename": "server/api/mailSubstatus/index.js",
16735 "groupTitle": "Mail_Substatuses"
16739 "url": "/api/mail/substatuses/{id}",
16740 "title": "Gets a single Queue",
16743 "title": "Example usage:",
16744 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16748 "name": "ShowSubstatuses",
16749 "group": "Mail_Substatuses",
16750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16751 "version": "0.0.0",
16752 "filename": "server/api/mailSubstatus/index.js",
16753 "groupTitle": "Mail_Substatuses"
16757 "url": "/api/mail/substatuses/{id}",
16758 "title": "Update an existing Queue",
16761 "title": "Example usage:",
16762 "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",
16766 "name": "updateSubstatuses",
16767 "group": "Mail_Substatuses",
16768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16769 "version": "0.0.0",
16770 "filename": "server/api/mailSubstatus/index.js",
16771 "groupTitle": "Mail_Substatuses"
16775 "url": "/api/mail/reports/transfer",
16776 "title": "Creates a new Mail Transfer Report",
16779 "title": "Example usage:",
16780 "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",
16784 "name": "CreateMail_Transfer_Reports",
16785 "group": "Mail_Transfer_Reports",
16793 "field": "uniqueid",
16812 "field": "transferredAt",
16818 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16819 "version": "0.0.0",
16820 "filename": "server/api/mailTransferReport/index.js",
16821 "groupTitle": "Mail_Transfer_Reports"
16825 "url": "/api/mail/reports/transfer/{id}",
16826 "title": "Deletes a Mail Transfer Report",
16829 "title": "Example usage:",
16830 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
16834 "name": "DeleteMail_Transfer_Reports",
16835 "group": "Mail_Transfer_Reports",
16836 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16837 "version": "0.0.0",
16838 "filename": "server/api/mailTransferReport/index.js",
16839 "groupTitle": "Mail_Transfer_Reports"
16843 "url": "/api/mail/reports/transfer/describe",
16844 "title": "Gets table info about Mail Transfer Reports",
16847 "title": "Example usage:",
16848 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
16852 "name": "DescribeMail_Transfer_Reports",
16853 "group": "Mail_Transfer_Reports",
16854 "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>",
16855 "version": "0.0.0",
16856 "filename": "server/api/mailTransferReport/index.js",
16857 "groupTitle": "Mail_Transfer_Reports"
16861 "url": "/api/mail/reports/transfer",
16862 "title": "Gets a list of Mail Transfer Reports",
16865 "title": "Example usage:",
16866 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
16870 "name": "GetMail_Transfer_Reports",
16871 "group": "Mail_Transfer_Reports",
16872 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16873 "version": "0.0.0",
16874 "filename": "server/api/mailTransferReport/index.js",
16875 "groupTitle": "Mail_Transfer_Reports"
16879 "url": "/api/mail/reports/transfer/{id}",
16880 "title": "Gets a single Mail Transfer Report",
16883 "title": "Example usage:",
16884 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
16888 "name": "ShowMail_Transfer_Reports",
16889 "group": "Mail_Transfer_Reports",
16890 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16891 "version": "0.0.0",
16892 "filename": "server/api/mailTransferReport/index.js",
16893 "groupTitle": "Mail_Transfer_Reports"
16897 "url": "/api/mail/reports/transfer/{id}",
16898 "title": "Update an existing Mail Transfer Report",
16901 "title": "Example usage:",
16902 "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",
16906 "name": "updateMail_Transfer_Reports",
16907 "group": "Mail_Transfer_Reports",
16908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16909 "version": "0.0.0",
16910 "filename": "server/api/mailTransferReport/index.js",
16911 "groupTitle": "Mail_Transfer_Reports"
16915 "url": "/api/members/reports/describe",
16916 "title": "Gets table info about Member Reports",
16919 "title": "Example usage:",
16920 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
16924 "name": "DescribeMember_Reports",
16925 "group": "Member_Reports",
16926 "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>",
16927 "version": "0.0.0",
16928 "filename": "server/api/memberReport/index.js",
16929 "groupTitle": "Member_Reports"
16933 "url": "/api/members/reports",
16934 "title": "Gets a list of Member Reports",
16937 "title": "Example usage:",
16938 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
16942 "name": "GetMember_Reports",
16943 "group": "Member_Reports",
16944 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16945 "version": "0.0.0",
16946 "filename": "server/api/memberReport/index.js",
16947 "groupTitle": "Member_Reports"
16951 "url": "/api/members/reports/{id}",
16952 "title": "Gets a single Member Report",
16955 "title": "Example usage:",
16956 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
16960 "name": "ShowMember_Reports",
16961 "group": "Member_Reports",
16962 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16963 "version": "0.0.0",
16964 "filename": "server/api/memberReport/index.js",
16965 "groupTitle": "Member_Reports"
16969 "url": "/api/migrations",
16970 "title": "Gets a list of Migrations",
16973 "title": "Example usage:",
16974 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
16978 "name": "GetMigrations",
16979 "group": "Migrations",
16980 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16981 "version": "0.0.0",
16982 "filename": "server/api/migration/index.js",
16983 "groupTitle": "Migrations"
16987 "url": "/api/voice/networks",
16988 "title": "Create a new network",
16991 "title": "Example usage:",
16992 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16997 "group": "Networks",
16998 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16999 "version": "0.0.0",
17000 "filename": "server/api/network/index.js",
17001 "groupTitle": "Networks"
17005 "url": "/api/voice/networks/{id}",
17006 "title": "Deletes a network",
17009 "title": "Example usage:",
17010 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17015 "group": "Networks",
17016 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17017 "version": "0.0.0",
17018 "filename": "server/api/network/index.js",
17019 "groupTitle": "Networks"
17023 "url": "/api/networks",
17024 "title": "Gets a list of Networks",
17027 "title": "Example usage:",
17028 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17032 "name": "GetNetworks",
17033 "group": "Networks",
17034 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17035 "version": "0.0.0",
17036 "filename": "server/api/network/index.js",
17037 "groupTitle": "Networks"
17041 "url": "/api/networks/{id}",
17042 "title": "Gets a single Network",
17045 "title": "Example usage:",
17046 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17050 "name": "ShowNetworks",
17051 "group": "Networks",
17052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17053 "version": "0.0.0",
17054 "filename": "server/api/network/index.js",
17055 "groupTitle": "Networks"
17059 "url": "/api/voice/networks/{id}",
17060 "title": "Update an existing network",
17063 "title": "Example usage:",
17064 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17069 "group": "Networks",
17070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17071 "version": "0.0.0",
17072 "filename": "server/api/network/index.js",
17073 "groupTitle": "Networks"
17077 "url": "/api/notifications",
17078 "title": "Send notification to user",
17081 "title": "Example usage:",
17082 "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17087 "group": "Notifications",
17088 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17089 "version": "0.0.0",
17090 "filename": "server/api/notification/index.js",
17091 "groupTitle": "Notifications"
17095 "url": "/api/openchannel/accounts/{id}/users",
17096 "title": "Add agents to a openchannel account",
17099 "title": "Example usage:",
17100 "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",
17104 "name": "AddAgents",
17105 "group": "Openchannel_Accounts",
17106 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17107 "version": "0.0.0",
17108 "filename": "server/api/openchannelAccount/index.js",
17109 "groupTitle": "Openchannel_Accounts"
17113 "url": "/api/openchannel/accounts",
17114 "title": "Creates a new Account",
17117 "title": "Example usage:",
17118 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17122 "name": "CreateAccounts",
17123 "group": "Openchannel_Accounts",
17138 "field": "description",
17152 "field": "replyUri",
17166 "field": "notificationTemplate",
17173 "field": "notificationSound",
17180 "field": "notificationShake",
17187 "field": "waitForTheAssignedAgent",
17201 "field": "queueTransfer",
17208 "field": "queueTransferTimeout",
17215 "field": "agentTransfer",
17222 "field": "agentTransferTimeout",
17229 "field": "mandatoryDispositionPauseId",
17230 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17236 "field": "mandatoryDisposition",
17237 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17242 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17243 "version": "0.0.0",
17244 "filename": "server/api/openchannelAccount/index.js",
17245 "groupTitle": "Openchannel_Accounts"
17249 "url": "/api/openchannel/accounts/{id}",
17250 "title": "Deletes a Account",
17253 "title": "Example usage:",
17254 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17258 "name": "DeleteAccounts",
17259 "group": "Openchannel_Accounts",
17260 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17261 "version": "0.0.0",
17262 "filename": "server/api/openchannelAccount/index.js",
17263 "groupTitle": "Openchannel_Accounts"
17267 "url": "/api/openchannel/accounts/describe",
17268 "title": "Gets table info about Accounts",
17271 "title": "Example usage:",
17272 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17276 "name": "DescribeAccounts",
17277 "group": "Openchannel_Accounts",
17278 "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>",
17279 "version": "0.0.0",
17280 "filename": "server/api/openchannelAccount/index.js",
17281 "groupTitle": "Openchannel_Accounts"
17285 "url": "/api/openchannel/accounts",
17286 "title": "Gets a list of Accounts",
17289 "title": "Example usage:",
17290 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17294 "name": "GetAccounts",
17295 "group": "Openchannel_Accounts",
17296 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17297 "version": "0.0.0",
17298 "filename": "server/api/openchannelAccount/index.js",
17299 "groupTitle": "Openchannel_Accounts"
17303 "url": "/api/openchannel/accounts/{id}/users",
17304 "title": "Gets agents from openchannel account",
17307 "title": "Example usage:",
17308 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17312 "name": "GetAgents",
17313 "group": "Openchannel_Accounts",
17314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17315 "version": "0.0.0",
17316 "filename": "server/api/openchannelAccount/index.js",
17317 "groupTitle": "Openchannel_Accounts"
17321 "url": "/api/openchannel/accounts/{id}/users",
17322 "title": "Removes agents from a openchannel account",
17325 "title": "Example usage:",
17326 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17330 "name": "RemoveAgents",
17331 "group": "Openchannel_Accounts",
17332 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17333 "version": "0.0.0",
17334 "filename": "server/api/openchannelAccount/index.js",
17335 "groupTitle": "Openchannel_Accounts"
17339 "url": "/api/openchannel/accounts/{id}/canned_answers",
17340 "title": "Removes canned answers from account",
17343 "title": "Example usage:",
17344 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17348 "name": "RemoveAnswers",
17349 "group": "Openchannel_Accounts",
17350 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17351 "version": "0.0.0",
17352 "filename": "server/api/openchannelAccount/index.js",
17353 "groupTitle": "Openchannel_Accounts"
17357 "url": "/api/openchannel/accounts/{id}/dispositions",
17358 "title": "Removes dispositions from account",
17361 "title": "Example usage:",
17362 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17366 "name": "RemoveDispositions",
17367 "group": "Openchannel_Accounts",
17368 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17369 "version": "0.0.0",
17370 "filename": "server/api/openchannelAccount/index.js",
17371 "groupTitle": "Openchannel_Accounts"
17375 "url": "/api/openchannel/accounts/{id}",
17376 "title": "Gets a single Account",
17379 "title": "Example usage:",
17380 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17384 "name": "ShowAccounts",
17385 "group": "Openchannel_Accounts",
17386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17387 "version": "0.0.0",
17388 "filename": "server/api/openchannelAccount/index.js",
17389 "groupTitle": "Openchannel_Accounts"
17393 "url": "/api/openchannel/accounts/{id}/canned_answers",
17394 "title": "Creates new canned answer",
17397 "title": "Example usage:",
17398 "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",
17402 "name": "addAnswer",
17403 "group": "Openchannel_Accounts",
17425 "field": "description",
17438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17439 "version": "0.0.0",
17440 "filename": "server/api/openchannelAccount/index.js",
17441 "groupTitle": "Openchannel_Accounts"
17445 "url": "/api/openchannel/accounts/{id}/applications",
17446 "title": "Creates new applications",
17449 "title": "Example usage:",
17450 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17454 "name": "addApplications",
17455 "group": "Openchannel_Accounts",
17463 "field": "priority",
17477 "field": "appdata",
17484 "field": "description",
17491 "field": "interval",
17497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17498 "version": "0.0.0",
17499 "filename": "server/api/openchannelAccount/index.js",
17500 "groupTitle": "Openchannel_Accounts"
17504 "url": "/api/openchannel/accounts/{id}/dispositions",
17505 "title": "Creates new disposition",
17508 "title": "Example usage:",
17509 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17513 "name": "addDisposition",
17514 "group": "Openchannel_Accounts",
17528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17529 "version": "0.0.0",
17530 "filename": "server/api/openchannelAccount/index.js",
17531 "groupTitle": "Openchannel_Accounts"
17535 "url": "/api/openchannel/accounts/{id}/canned_answers",
17536 "title": "Gets account canned answers",
17539 "title": "Example usage:",
17540 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17544 "name": "getAnswers",
17545 "group": "Openchannel_Accounts",
17546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17547 "version": "0.0.0",
17548 "filename": "server/api/openchannelAccount/index.js",
17549 "groupTitle": "Openchannel_Accounts"
17553 "url": "/api/openchannel/accounts/{id}/applications",
17554 "title": "Gets account applications",
17557 "title": "Example usage:",
17558 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17562 "name": "getApplications",
17563 "group": "Openchannel_Accounts",
17564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17565 "version": "0.0.0",
17566 "filename": "server/api/openchannelAccount/index.js",
17567 "groupTitle": "Openchannel_Accounts"
17571 "url": "/api/openchannel/accounts/{id}/dispositions",
17572 "title": "Gets account dispositions",
17575 "title": "Example usage:",
17576 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17580 "name": "getDispositions",
17581 "group": "Openchannel_Accounts",
17582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17583 "version": "0.0.0",
17584 "filename": "server/api/openchannelAccount/index.js",
17585 "groupTitle": "Openchannel_Accounts"
17589 "url": "/api/openchannel/accounts/{id}/interactions",
17590 "title": "Gets Openchannel Account Interactions",
17593 "title": "Example usage:",
17594 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17598 "name": "getInteractions",
17599 "group": "Openchannel_Accounts",
17600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17601 "version": "0.0.0",
17602 "filename": "server/api/openchannelAccount/index.js",
17603 "groupTitle": "Openchannel_Accounts"
17607 "url": "/api/openchannel/accounts/{id}/notify",
17608 "title": "Notify new message",
17611 "title": "Example usage:",
17612 "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",
17617 "group": "Openchannel_Accounts",
17618 "description": "<p>Motion 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>",
17619 "version": "0.0.0",
17620 "filename": "server/api/openchannelAccount/index.js",
17621 "groupTitle": "Openchannel_Accounts"
17625 "url": "/api/openchannel/accounts/{id}/send",
17626 "title": "Send new openchannel message",
17629 "title": "Example usage:",
17630 "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",
17634 "name": "sendOpenchannel",
17635 "group": "Openchannel_Accounts",
17636 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17637 "version": "0.0.0",
17638 "filename": "server/api/openchannelAccount/index.js",
17639 "groupTitle": "Openchannel_Accounts"
17643 "url": "/api/openchannel/accounts/{id}",
17644 "title": "Update an existing Account",
17647 "title": "Example usage:",
17648 "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",
17652 "name": "updateAccounts",
17653 "group": "Openchannel_Accounts",
17654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17655 "version": "0.0.0",
17656 "filename": "server/api/openchannelAccount/index.js",
17657 "groupTitle": "Openchannel_Accounts"
17661 "url": "/api/openchannel/applications",
17662 "title": "Creates a new Application",
17665 "title": "Example usage:",
17666 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17670 "name": "CreateApplications",
17671 "group": "Openchannel_Applications",
17679 "field": "priority",
17693 "field": "appdata",
17700 "field": "description",
17707 "field": "interval",
17713 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17714 "version": "0.0.0",
17715 "filename": "server/api/openchannelApplication/index.js",
17716 "groupTitle": "Openchannel_Applications"
17720 "url": "/api/openchannel/applications/{id}",
17721 "title": "Deletes a Application",
17724 "title": "Example usage:",
17725 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17729 "name": "DeleteApplications",
17730 "group": "Openchannel_Applications",
17731 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17732 "version": "0.0.0",
17733 "filename": "server/api/openchannelApplication/index.js",
17734 "groupTitle": "Openchannel_Applications"
17738 "url": "/api/openchannel/applications",
17739 "title": "Gets a list of Applications",
17742 "title": "Example usage:",
17743 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17747 "name": "GetApplications",
17748 "group": "Openchannel_Applications",
17749 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17750 "version": "0.0.0",
17751 "filename": "server/api/openchannelApplication/index.js",
17752 "groupTitle": "Openchannel_Applications"
17756 "url": "/api/openchannel/applications/{id}",
17757 "title": "Gets a single Application",
17760 "title": "Example usage:",
17761 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17765 "name": "ShowApplications",
17766 "group": "Openchannel_Applications",
17767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17768 "version": "0.0.0",
17769 "filename": "server/api/openchannelApplication/index.js",
17770 "groupTitle": "Openchannel_Applications"
17774 "url": "/api/openchannel/applications/{id}",
17775 "title": "Update an existing Application",
17778 "title": "Example usage:",
17779 "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",
17783 "name": "updateApplications",
17784 "group": "Openchannel_Applications",
17785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17786 "version": "0.0.0",
17787 "filename": "server/api/openchannelApplication/index.js",
17788 "groupTitle": "Openchannel_Applications"
17792 "url": "/api/openchannel/interactions/{id}/tags",
17793 "title": "Add tags to the interaction",
17796 "title": "Example usage:",
17797 "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",
17802 "group": "Openchannel_Interactions",
17803 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17804 "version": "0.0.0",
17805 "filename": "server/api/openchannelInteraction/index.js",
17806 "groupTitle": "Openchannel_Interactions"
17810 "url": "/api/openchannel/interactions",
17811 "title": "Creates a new Interaction",
17814 "title": "Example usage:",
17815 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17819 "name": "CreateInteractions",
17820 "group": "Openchannel_Interactions",
17835 "field": "closedAt",
17842 "field": "disposition",
17856 "field": "read1stAt",
17863 "field": "threadId",
17870 "field": "externalUrl",
17877 "field": "lastMsgAt",
17888 "field": "lastMsgDirection",
17901 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17902 "version": "0.0.0",
17903 "filename": "server/api/openchannelInteraction/index.js",
17904 "groupTitle": "Openchannel_Interactions"
17908 "url": "/api/openchannel/interactions/{id}",
17909 "title": "Deletes a Interaction",
17912 "title": "Example usage:",
17913 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
17917 "name": "DeleteInteractions",
17918 "group": "Openchannel_Interactions",
17919 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17920 "version": "0.0.0",
17921 "filename": "server/api/openchannelInteraction/index.js",
17922 "groupTitle": "Openchannel_Interactions"
17926 "url": "/api/openchannel/interactions/describe",
17927 "title": "Gets table info about Interactions",
17930 "title": "Example usage:",
17931 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
17935 "name": "DescribeInteractions",
17936 "group": "Openchannel_Interactions",
17937 "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>",
17938 "version": "0.0.0",
17939 "filename": "server/api/openchannelInteraction/index.js",
17940 "groupTitle": "Openchannel_Interactions"
17944 "url": "/api/openchannel/interactions",
17945 "title": "Gets a list of Interactions",
17948 "title": "Example usage:",
17949 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
17953 "name": "GetInteractions",
17954 "group": "Openchannel_Interactions",
17955 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17956 "version": "0.0.0",
17957 "filename": "server/api/openchannelInteraction/index.js",
17958 "groupTitle": "Openchannel_Interactions"
17962 "url": "/api/openchannel/interactions/{id}/tags",
17963 "title": "Removes tags from interaction",
17966 "title": "Example usage:",
17967 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17971 "name": "RemoveTags",
17972 "group": "Openchannel_Interactions",
17973 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17974 "version": "0.0.0",
17975 "filename": "server/api/openchannelInteraction/index.js",
17976 "groupTitle": "Openchannel_Interactions"
17980 "url": "/api/openchannel/interactions/{id}",
17981 "title": "Gets a single Interaction",
17984 "title": "Example usage:",
17985 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
17989 "name": "ShowInteractions",
17990 "group": "Openchannel_Interactions",
17991 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17992 "version": "0.0.0",
17993 "filename": "server/api/openchannelInteraction/index.js",
17994 "groupTitle": "Openchannel_Interactions"
17998 "url": "/api/openchannel/interactions/{id}/messages",
17999 "title": "Creates new messages",
18002 "title": "Example usage:",
18003 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18007 "name": "addMessage",
18008 "group": "Openchannel_Interactions",
18041 "field": "direction",
18054 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18055 "version": "0.0.0",
18056 "filename": "server/api/openchannelInteraction/index.js",
18057 "groupTitle": "Openchannel_Interactions"
18061 "url": "/api/openchannel/interactions/{id}/download",
18062 "title": "Gets interaction",
18065 "title": "Example usage:",
18066 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18070 "name": "download",
18071 "group": "Openchannel_Interactions",
18072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18073 "version": "0.0.0",
18074 "filename": "server/api/openchannelInteraction/index.js",
18075 "groupTitle": "Openchannel_Interactions"
18079 "url": "/api/openchannel/interactions/{id}/messages",
18080 "title": "Gets interaction messages",
18083 "title": "Example usage:",
18084 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18088 "name": "getMessages",
18089 "group": "Openchannel_Interactions",
18090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18091 "version": "0.0.0",
18092 "filename": "server/api/openchannelInteraction/index.js",
18093 "groupTitle": "Openchannel_Interactions"
18097 "url": "/api/openchannel/interactions/{id}",
18098 "title": "Update an existing Interaction",
18101 "title": "Example usage:",
18102 "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",
18106 "name": "updateInteractions",
18107 "group": "Openchannel_Interactions",
18108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18109 "version": "0.0.0",
18110 "filename": "server/api/openchannelInteraction/index.js",
18111 "groupTitle": "Openchannel_Interactions"
18115 "url": "/api/openchannel/messages",
18116 "title": "Creates a new Message",
18119 "title": "Example usage:",
18120 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18124 "name": "CreateMessages",
18125 "group": "Openchannel_Messages",
18158 "field": "direction",
18171 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18172 "version": "0.0.0",
18173 "filename": "server/api/openchannelMessage/index.js",
18174 "groupTitle": "Openchannel_Messages"
18178 "url": "/api/openchannel/messages/{id}",
18179 "title": "Deletes a Message",
18182 "title": "Example usage:",
18183 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18187 "name": "DeleteMessages",
18188 "group": "Openchannel_Messages",
18189 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18190 "version": "0.0.0",
18191 "filename": "server/api/openchannelMessage/index.js",
18192 "groupTitle": "Openchannel_Messages"
18196 "url": "/api/openchannel/messages/describe",
18197 "title": "Gets table info about Messages",
18200 "title": "Example usage:",
18201 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18205 "name": "DescribeMessages",
18206 "group": "Openchannel_Messages",
18207 "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>",
18208 "version": "0.0.0",
18209 "filename": "server/api/openchannelMessage/index.js",
18210 "groupTitle": "Openchannel_Messages"
18214 "url": "/api/openchannel/messages",
18215 "title": "Gets a list of Messages",
18218 "title": "Example usage:",
18219 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18223 "name": "GetMessages",
18224 "group": "Openchannel_Messages",
18225 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18226 "version": "0.0.0",
18227 "filename": "server/api/openchannelMessage/index.js",
18228 "groupTitle": "Openchannel_Messages"
18232 "url": "/api/openchannel/messages/{id}",
18233 "title": "Gets a single Message",
18236 "title": "Example usage:",
18237 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18241 "name": "ShowMessages",
18242 "group": "Openchannel_Messages",
18243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18244 "version": "0.0.0",
18245 "filename": "server/api/openchannelMessage/index.js",
18246 "groupTitle": "Openchannel_Messages"
18250 "url": "/api/openchannel/messages/{id}/accept",
18251 "title": "Accepts message",
18254 "title": "Example usage:",
18255 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18259 "name": "acceptMessage",
18260 "group": "Openchannel_Messages",
18261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18262 "version": "0.0.0",
18263 "filename": "server/api/openchannelMessage/index.js",
18264 "groupTitle": "Openchannel_Messages"
18268 "url": "/api/openchannel/messages/{id}/reject",
18269 "title": "Rejects message",
18272 "title": "Example usage:",
18273 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18277 "name": "rejectMessage",
18278 "group": "Openchannel_Messages",
18279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18280 "version": "0.0.0",
18281 "filename": "server/api/openchannelMessage/index.js",
18282 "groupTitle": "Openchannel_Messages"
18286 "url": "/api/openchannel/messages/{id}",
18287 "title": "Update an existing Message",
18290 "title": "Example usage:",
18291 "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",
18295 "name": "updateMessages",
18296 "group": "Openchannel_Messages",
18297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18298 "version": "0.0.0",
18299 "filename": "server/api/openchannelMessage/index.js",
18300 "groupTitle": "Openchannel_Messages"
18304 "url": "/api/openchannel/reports/queue",
18305 "title": "Creates a new Openchannel Queue Report",
18308 "title": "Example usage:",
18309 "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",
18313 "name": "CreateOpenchannel_Queue_Reports",
18314 "group": "Openchannel_Queue_Reports",
18322 "field": "uniqueid",
18343 "field": "leaveAt",
18350 "field": "acceptAt",
18370 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18371 "version": "0.0.0",
18372 "filename": "server/api/openchannelQueueReport/index.js",
18373 "groupTitle": "Openchannel_Queue_Reports"
18377 "url": "/api/openchannel/reports/queue/{id}",
18378 "title": "Deletes a Openchannel Queue Report",
18381 "title": "Example usage:",
18382 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18386 "name": "DeleteOpenchannel_Queue_Reports",
18387 "group": "Openchannel_Queue_Reports",
18388 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18389 "version": "0.0.0",
18390 "filename": "server/api/openchannelQueueReport/index.js",
18391 "groupTitle": "Openchannel_Queue_Reports"
18395 "url": "/api/openchannel/reports/queue/describe",
18396 "title": "Gets table info about Openchannel Queue Reports",
18399 "title": "Example usage:",
18400 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18404 "name": "DescribeOpenchannel_Queue_Reports",
18405 "group": "Openchannel_Queue_Reports",
18406 "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>",
18407 "version": "0.0.0",
18408 "filename": "server/api/openchannelQueueReport/index.js",
18409 "groupTitle": "Openchannel_Queue_Reports"
18413 "url": "/api/openchannel/reports/queue",
18414 "title": "Gets a list of Openchannel Queue Reports",
18417 "title": "Example usage:",
18418 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18422 "name": "GetOpenchannel_Queue_Reports",
18423 "group": "Openchannel_Queue_Reports",
18424 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18425 "version": "0.0.0",
18426 "filename": "server/api/openchannelQueueReport/index.js",
18427 "groupTitle": "Openchannel_Queue_Reports"
18431 "url": "/api/openchannel/reports/queue/{id}",
18432 "title": "Gets a single Openchannel Queue Report",
18435 "title": "Example usage:",
18436 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18440 "name": "ShowOpenchannel_Queue_Reports",
18441 "group": "Openchannel_Queue_Reports",
18442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18443 "version": "0.0.0",
18444 "filename": "server/api/openchannelQueueReport/index.js",
18445 "groupTitle": "Openchannel_Queue_Reports"
18449 "url": "/api/openchannel/reports/queue/{id}",
18450 "title": "Update an existing Openchannel Queue Report",
18453 "title": "Example usage:",
18454 "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",
18458 "name": "updateOpenchannel_Queue_Reports",
18459 "group": "Openchannel_Queue_Reports",
18460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18461 "version": "0.0.0",
18462 "filename": "server/api/openchannelQueueReport/index.js",
18463 "groupTitle": "Openchannel_Queue_Reports"
18467 "url": "/api/openchannel/queues/{id}/users",
18468 "title": "Add agents to a queue",
18471 "title": "Example usage:",
18472 "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",
18476 "name": "AddAgents",
18477 "group": "Openchannel_Queues",
18478 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18479 "version": "0.0.0",
18480 "filename": "server/api/openchannelQueue/index.js",
18481 "groupTitle": "Openchannel_Queues"
18485 "url": "/api/openchannel/queues/{id}/teams",
18486 "title": "Add teams to a queue",
18489 "title": "Example usage:",
18490 "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",
18494 "name": "AddTeams",
18495 "group": "Openchannel_Queues",
18496 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18497 "version": "0.0.0",
18498 "filename": "server/api/openchannelQueue/index.js",
18499 "groupTitle": "Openchannel_Queues"
18503 "url": "/api/openchannel/queues",
18504 "title": "Creates a new Queue",
18507 "title": "Example usage:",
18508 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18512 "name": "CreateQueues",
18513 "group": "Openchannel_Queues",
18528 "field": "description",
18535 "field": "timeout",
18547 "field": "strategy",
18553 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18554 "version": "0.0.0",
18555 "filename": "server/api/openchannelQueue/index.js",
18556 "groupTitle": "Openchannel_Queues"
18560 "url": "/api/openchannel/queues/{id}",
18561 "title": "Deletes a Queue",
18564 "title": "Example usage:",
18565 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18569 "name": "DeleteQueues",
18570 "group": "Openchannel_Queues",
18571 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18572 "version": "0.0.0",
18573 "filename": "server/api/openchannelQueue/index.js",
18574 "groupTitle": "Openchannel_Queues"
18578 "url": "/api/openchannel/queues/describe",
18579 "title": "Gets table info about Queues",
18582 "title": "Example usage:",
18583 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18587 "name": "DescribeQueues",
18588 "group": "Openchannel_Queues",
18589 "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>",
18590 "version": "0.0.0",
18591 "filename": "server/api/openchannelQueue/index.js",
18592 "groupTitle": "Openchannel_Queues"
18596 "url": "/api/openchannel/queues/{id}/users",
18597 "title": "Gets queue agents",
18600 "title": "Example usage:",
18601 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18605 "name": "GetAgents",
18606 "group": "Openchannel_Queues",
18607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18608 "version": "0.0.0",
18609 "filename": "server/api/openchannelQueue/index.js",
18610 "groupTitle": "Openchannel_Queues"
18614 "url": "/api/openchannel/queues/{id}/members",
18615 "title": "GetMembers",
18618 "title": "Example usage:",
18619 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18623 "name": "GetMembers",
18624 "group": "Openchannel_Queues",
18625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18626 "version": "0.0.0",
18627 "filename": "server/api/openchannelQueue/index.js",
18628 "groupTitle": "Openchannel_Queues"
18632 "url": "/api/openchannel/queues",
18633 "title": "Gets a list of Queues",
18636 "title": "Example usage:",
18637 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18641 "name": "GetQueues",
18642 "group": "Openchannel_Queues",
18643 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18644 "version": "0.0.0",
18645 "filename": "server/api/openchannelQueue/index.js",
18646 "groupTitle": "Openchannel_Queues"
18650 "url": "/api/openchannel/queues/{id}/teams",
18651 "title": "Gets queues list",
18654 "title": "Example usage:",
18655 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18659 "name": "GetTeams",
18660 "group": "Openchannel_Queues",
18661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18662 "version": "0.0.0",
18663 "filename": "server/api/openchannelQueue/index.js",
18664 "groupTitle": "Openchannel_Queues"
18668 "url": "/api/openchannel/queues/{id}/users",
18669 "title": "Removes agents from a queue",
18672 "title": "Example usage:",
18673 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18677 "name": "RemoveAgents",
18678 "group": "Openchannel_Queues",
18679 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18680 "version": "0.0.0",
18681 "filename": "server/api/openchannelQueue/index.js",
18682 "groupTitle": "Openchannel_Queues"
18686 "url": "/api/openchannel/queues/{id}",
18687 "title": "Gets a single Queue",
18690 "title": "Example usage:",
18691 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18695 "name": "ShowQueues",
18696 "group": "Openchannel_Queues",
18697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18698 "version": "0.0.0",
18699 "filename": "server/api/openchannelQueue/index.js",
18700 "groupTitle": "Openchannel_Queues"
18704 "url": "/api/openchannel/queues/{id}",
18705 "title": "Update an existing Queue",
18708 "title": "Example usage:",
18709 "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",
18713 "name": "updateQueues",
18714 "group": "Openchannel_Queues",
18715 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18716 "version": "0.0.0",
18717 "filename": "server/api/openchannelQueue/index.js",
18718 "groupTitle": "Openchannel_Queues"
18722 "url": "/api/openchannel/reports/transfer",
18723 "title": "Creates a new Openchannel Transfer Report",
18726 "title": "Example usage:",
18727 "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",
18731 "name": "CreateOpenchannel_Transfer_Reports",
18732 "group": "Openchannel_Transfer_Reports",
18740 "field": "uniqueid",
18759 "field": "transferredAt",
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/openchannelTransferReport/index.js",
18768 "groupTitle": "Openchannel_Transfer_Reports"
18772 "url": "/api/openchannel/reports/transfer/{id}",
18773 "title": "Deletes a Openchannel Transfer Report",
18776 "title": "Example usage:",
18777 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18781 "name": "DeleteOpenchannel_Transfer_Reports",
18782 "group": "Openchannel_Transfer_Reports",
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/openchannelTransferReport/index.js",
18786 "groupTitle": "Openchannel_Transfer_Reports"
18790 "url": "/api/openchannel/reports/transfer/describe",
18791 "title": "Gets table info about Openchannel Transfer Reports",
18794 "title": "Example usage:",
18795 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
18799 "name": "DescribeOpenchannel_Transfer_Reports",
18800 "group": "Openchannel_Transfer_Reports",
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/openchannelTransferReport/index.js",
18804 "groupTitle": "Openchannel_Transfer_Reports"
18808 "url": "/api/openchannel/reports/transfer",
18809 "title": "Gets a list of Openchannel Transfer Reports",
18812 "title": "Example usage:",
18813 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
18817 "name": "GetOpenchannel_Transfer_Reports",
18818 "group": "Openchannel_Transfer_Reports",
18819 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18820 "version": "0.0.0",
18821 "filename": "server/api/openchannelTransferReport/index.js",
18822 "groupTitle": "Openchannel_Transfer_Reports"
18826 "url": "/api/openchannel/reports/transfer/{id}",
18827 "title": "Gets a single Openchannel Transfer Report",
18830 "title": "Example usage:",
18831 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
18835 "name": "ShowOpenchannel_Transfer_Reports",
18836 "group": "Openchannel_Transfer_Reports",
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/openchannelTransferReport/index.js",
18840 "groupTitle": "Openchannel_Transfer_Reports"
18844 "url": "/api/openchannel/reports/transfer/{id}",
18845 "title": "Update an existing Openchannel Transfer Report",
18848 "title": "Example usage:",
18849 "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",
18853 "name": "updateOpenchannel_Transfer_Reports",
18854 "group": "Openchannel_Transfer_Reports",
18855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18856 "version": "0.0.0",
18857 "filename": "server/api/openchannelTransferReport/index.js",
18858 "groupTitle": "Openchannel_Transfer_Reports"
18862 "url": "/api/pauses",
18863 "title": "Creates a new Pause",
18866 "title": "Example usage:",
18867 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18871 "name": "CreatePauses",
18887 "field": "description",
18893 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18894 "version": "0.0.0",
18895 "filename": "server/api/pause/index.js",
18896 "groupTitle": "Pauses"
18900 "url": "/api/pauses/{id}",
18901 "title": "Deletes a Pause",
18904 "title": "Example usage:",
18905 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
18909 "name": "DeletePauses",
18911 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18912 "version": "0.0.0",
18913 "filename": "server/api/pause/index.js",
18914 "groupTitle": "Pauses"
18918 "url": "/api/pauses",
18919 "title": "Gets a list of Pauses",
18922 "title": "Example usage:",
18923 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
18927 "name": "GetPauses",
18929 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18930 "version": "0.0.0",
18931 "filename": "server/api/pause/index.js",
18932 "groupTitle": "Pauses"
18936 "url": "/api/pauses/{id}",
18937 "title": "Gets a single Pause",
18940 "title": "Example usage:",
18941 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
18945 "name": "ShowPauses",
18947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18948 "version": "0.0.0",
18949 "filename": "server/api/pause/index.js",
18950 "groupTitle": "Pauses"
18954 "url": "/api/pauses/{id}",
18955 "title": "Update an existing Pause",
18958 "title": "Example usage:",
18959 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18963 "name": "updatePauses",
18965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18966 "version": "0.0.0",
18967 "filename": "server/api/pause/index.js",
18968 "groupTitle": "Pauses"
18972 "url": "/api/plugins",
18973 "title": "Gets a list of Plugins",
18976 "title": "Example usage:",
18977 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
18981 "name": "GetPlugins",
18982 "group": "Plugins",
18983 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18984 "version": "0.0.0",
18985 "filename": "server/api/plugin/index.js",
18986 "groupTitle": "Plugins"
18990 "url": "/api/plugins/{id}",
18991 "title": "Gets a single Plugin",
18994 "title": "Example usage:",
18995 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
18999 "name": "ShowPlugins",
19000 "group": "Plugins",
19001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19002 "version": "0.0.0",
19003 "filename": "server/api/plugin/index.js",
19004 "groupTitle": "Plugins"
19008 "url": "/api/plugins/{id}",
19009 "title": "Delete a plugin",
19012 "title": "Example usage:",
19013 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19017 "name": "destroyPlugin",
19018 "group": "Plugins",
19019 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19020 "version": "0.0.0",
19021 "filename": "server/api/plugin/index.js",
19022 "groupTitle": "Plugins"
19026 "url": "/api/plugins/{id}/download",
19027 "title": "Download plugin source code",
19030 "title": "Example usage:",
19031 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19035 "name": "download",
19036 "group": "Plugins",
19037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19038 "version": "0.0.0",
19039 "filename": "server/api/plugin/index.js",
19040 "groupTitle": "Plugins"
19044 "url": "/api/plugins/{id}",
19045 "title": "Update an existing plugin",
19048 "title": "Example usage:",
19049 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19053 "name": "updatePlugin",
19054 "group": "Plugins",
19055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19056 "version": "0.0.0",
19057 "filename": "server/api/plugin/index.js",
19058 "groupTitle": "Plugins"
19062 "url": "/api/plugins",
19063 "title": "Upload new plugin",
19066 "title": "Example usage:",
19067 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19071 "name": "uploadPlugin",
19072 "group": "Plugins",
19073 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19074 "version": "0.0.0",
19075 "filename": "server/api/plugin/index.js",
19076 "groupTitle": "Plugins"
19080 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19081 "title": "Redirect a plugin request to the specified path",
19084 "title": "Example usage:",
19085 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19089 "name": "webhookPlugin",
19090 "group": "Plugins",
19091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19092 "version": "0.0.0",
19093 "filename": "server/api/plugin/index.js",
19094 "groupTitle": "Plugins"
19098 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19099 "title": "Redirect a plugin request to the specified path",
19102 "title": "Example usage:",
19103 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19107 "name": "webhookPlugin",
19108 "group": "Plugins",
19109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19110 "version": "0.0.0",
19111 "filename": "server/api/plugin/index.js",
19112 "groupTitle": "Plugins"
19116 "url": "/api/pm2/{id}",
19117 "title": "Deletes an existing process",
19120 "title": "Example usage:",
19121 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19125 "name": "DeletePm2Process",
19127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19128 "version": "0.0.0",
19129 "filename": "server/api/pm2/index.js",
19130 "groupTitle": "Pm2"
19134 "url": "/api/pm2/{id}",
19135 "title": "Gets a single pm2 process",
19138 "title": "Example usage:",
19139 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19143 "name": "GetPm2Process",
19145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19146 "version": "0.0.0",
19147 "filename": "server/api/pm2/index.js",
19148 "groupTitle": "Pm2"
19153 "title": "Gets pm2 processes",
19156 "title": "Example usage:",
19157 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19161 "name": "GetPm2Processes",
19163 "description": "<p>Motion returns the pm2 processes list.</p>",
19164 "version": "0.0.0",
19165 "filename": "server/api/pm2/index.js",
19166 "groupTitle": "Pm2"
19171 "title": "Start a single pm2 process",
19174 "title": "Example usage:",
19175 "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",
19179 "name": "StartPm2Process",
19201 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19202 "version": "0.0.0",
19203 "filename": "server/api/pm2/index.js",
19204 "groupTitle": "Pm2"
19208 "url": "/api/pm2/{id}",
19209 "title": "Update an existing process",
19212 "title": "Example usage:",
19213 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19217 "name": "UpdatePm2Process",
19219 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19220 "version": "0.0.0",
19221 "filename": "server/api/pm2/index.js",
19222 "groupTitle": "Pm2"
19226 "url": "/api/rpc/campaigns/",
19227 "title": "Gets a list of campaigns",
19230 "title": "Example usage:",
19231 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19235 "name": "Campaigns",
19236 "group": "RPC_Realtime",
19237 "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>",
19238 "version": "0.0.0",
19239 "filename": "server/api/rpc/index.js",
19240 "groupTitle": "RPC_Realtime"
19244 "url": "/api/rpc/fax/accounts",
19245 "title": "Gets a list of FaxAccounts",
19248 "title": "Example usage:",
19249 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19253 "name": "FaxAccounts",
19254 "group": "RPC_Realtime",
19255 "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>",
19256 "version": "0.0.0",
19257 "filename": "server/api/rpc/index.js",
19258 "groupTitle": "RPC_Realtime"
19262 "url": "/api/rpc/agents/:id/capacity",
19263 "title": "Sets agent capacity",
19266 "title": "Example usage:",
19267 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19271 "name": "RTAgentCapacity",
19272 "group": "RPC_Realtime",
19273 "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>",
19274 "version": "0.0.0",
19275 "filename": "server/api/rpc/index.js",
19276 "groupTitle": "RPC_Realtime"
19280 "url": "/api/rpc/agents",
19281 "title": "Gets a list of RTAgents",
19284 "title": "Example usage:",
19285 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19289 "name": "RTAgents",
19290 "group": "RPC_Realtime",
19291 "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>",
19292 "version": "0.0.0",
19293 "filename": "server/api/rpc/index.js",
19294 "groupTitle": "RPC_Realtime"
19298 "url": "/api/rpc/chat/queues",
19299 "title": "Gets a list of RTChatQueues",
19302 "title": "Example usage:",
19303 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19307 "name": "RTChatQueues",
19308 "group": "RPC_Realtime",
19309 "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>",
19310 "version": "0.0.0",
19311 "filename": "server/api/rpc/index.js",
19312 "groupTitle": "RPC_Realtime"
19316 "url": "/api/rpc/fax/queues",
19317 "title": "Gets a list of RTFaxQueues",
19320 "title": "Example usage:",
19321 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19325 "name": "RTFaxQueues",
19326 "group": "RPC_Realtime",
19327 "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>",
19328 "version": "0.0.0",
19329 "filename": "server/api/rpc/index.js",
19330 "groupTitle": "RPC_Realtime"
19334 "url": "/api/rpc/mail/accounts",
19335 "title": "Gets a list of RTMailAccounts",
19338 "title": "Example usage:",
19339 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19343 "name": "RTMailAccounts",
19344 "group": "RPC_Realtime",
19345 "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>",
19346 "version": "0.0.0",
19347 "filename": "server/api/rpc/index.js",
19348 "groupTitle": "RPC_Realtime"
19352 "url": "/api/rpc/mail/queues",
19353 "title": "Gets a list of RTMailQueues",
19356 "title": "Example usage:",
19357 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19361 "name": "RTMailQueues",
19362 "group": "RPC_Realtime",
19363 "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>",
19364 "version": "0.0.0",
19365 "filename": "server/api/rpc/index.js",
19366 "groupTitle": "RPC_Realtime"
19370 "url": "/api/rpc/openchannel/queues",
19371 "title": "Gets a list of RTOpenchannelQueues",
19374 "title": "Example usage:",
19375 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19379 "name": "RTOpenchannelQueues",
19380 "group": "RPC_Realtime",
19381 "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>",
19382 "version": "0.0.0",
19383 "filename": "server/api/rpc/index.js",
19384 "groupTitle": "RPC_Realtime"
19388 "url": "/api/rpc/outbound/channels",
19389 "title": "Gets a list of RTOutboundChannels",
19392 "title": "Example usage:",
19393 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19397 "name": "RTOutboundChannels",
19398 "group": "RPC_Realtime",
19399 "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>",
19400 "version": "0.0.0",
19401 "filename": "server/api/rpc/index.js",
19402 "groupTitle": "RPC_Realtime"
19406 "url": "/api/rpc/sms/queues",
19407 "title": "Gets a list of RTSmsQueues",
19410 "title": "Example usage:",
19411 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19415 "name": "RTSmsQueues",
19416 "group": "RPC_Realtime",
19417 "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>",
19418 "version": "0.0.0",
19419 "filename": "server/api/rpc/index.js",
19420 "groupTitle": "RPC_Realtime"
19424 "url": "/api/rpc/telephones",
19425 "title": "Gets a list of RTTelephones",
19428 "title": "Example usage:",
19429 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19433 "name": "RTTelephones",
19434 "group": "RPC_Realtime",
19435 "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>",
19436 "version": "0.0.0",
19437 "filename": "server/api/rpc/index.js",
19438 "groupTitle": "RPC_Realtime"
19442 "url": "/api/rpc/trunks",
19443 "title": "Gets a list of RTTrunks",
19446 "title": "Example usage:",
19447 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19451 "name": "RTTrunks",
19452 "group": "RPC_Realtime",
19453 "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>",
19454 "version": "0.0.0",
19455 "filename": "server/api/rpc/index.js",
19456 "groupTitle": "RPC_Realtime"
19460 "url": "/api/rpc/voice/channels",
19461 "title": "Gets a list of RTVoiceChannelMixMonitor",
19464 "title": "Example usage:",
19465 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19469 "name": "RTVoiceChannelMixMonitor",
19470 "group": "RPC_Realtime",
19471 "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>",
19472 "version": "0.0.0",
19473 "filename": "server/api/rpc/index.js",
19474 "groupTitle": "RPC_Realtime"
19478 "url": "/api/rpc/voice/channels",
19479 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19482 "title": "Example usage:",
19483 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19487 "name": "RTVoiceChannelStopMixMonitor",
19488 "group": "RPC_Realtime",
19489 "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>",
19490 "version": "0.0.0",
19491 "filename": "server/api/rpc/index.js",
19492 "groupTitle": "RPC_Realtime"
19496 "url": "/api/rpc/voice/channels",
19497 "title": "Gets a list of RTVoiceChannels",
19500 "title": "Example usage:",
19501 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19505 "name": "RTVoiceChannels",
19506 "group": "RPC_Realtime",
19507 "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>",
19508 "version": "0.0.0",
19509 "filename": "server/api/rpc/index.js",
19510 "groupTitle": "RPC_Realtime"
19514 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19515 "title": "Gets a single RTVoiceQueueChannel",
19518 "title": "Example usage:",
19519 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19523 "name": "RTVoiceQueueChannel",
19524 "group": "RPC_Realtime",
19525 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19526 "version": "0.0.0",
19527 "filename": "server/api/rpc/index.js",
19528 "groupTitle": "RPC_Realtime"
19532 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19533 "title": "Hangup a single RTVoiceQueueChannel",
19536 "title": "Example usage:",
19537 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19541 "name": "RTVoiceQueueChannelHangup",
19542 "group": "RPC_Realtime",
19543 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19544 "version": "0.0.0",
19545 "filename": "server/api/rpc/index.js",
19546 "groupTitle": "RPC_Realtime"
19550 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19551 "title": "Hangup a single RTVoiceQueueChannel",
19554 "title": "Example usage:",
19555 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19559 "name": "RTVoiceQueueChannelRedirect",
19560 "group": "RPC_Realtime",
19561 "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>",
19562 "version": "0.0.0",
19563 "filename": "server/api/rpc/index.js",
19564 "groupTitle": "RPC_Realtime"
19568 "url": "/api/rpc/voice/queues/preview/{id}",
19569 "title": "Gets a single preview contact",
19572 "title": "Example usage:",
19573 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19577 "name": "RTVoiceQueuePreview",
19578 "group": "RPC_Realtime",
19579 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19580 "version": "0.0.0",
19581 "filename": "server/api/rpc/index.js",
19582 "groupTitle": "RPC_Realtime"
19586 "url": "/api/rpc/outbound",
19587 "title": "Gets a list of RTOutbound",
19590 "title": "Example usage:",
19591 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19595 "name": "RTVoiceQueues",
19596 "group": "RPC_Realtime",
19597 "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>",
19598 "version": "0.0.0",
19599 "filename": "server/api/rpc/index.js",
19600 "groupTitle": "RPC_Realtime"
19604 "url": "/api/rpc/voice/queues",
19605 "title": "Gets a list of RTVoiceQueues",
19608 "title": "Example usage:",
19609 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19613 "name": "RTVoiceQueues",
19614 "group": "RPC_Realtime",
19615 "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>",
19616 "version": "0.0.0",
19617 "filename": "server/api/rpc/index.js",
19618 "groupTitle": "RPC_Realtime"
19622 "url": "/api/rpc/voice/queues/channels",
19623 "title": "Gets a list of RTVoiceQueuesChannels",
19626 "title": "Example usage:",
19627 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19631 "name": "RTVoiceQueuesChannels",
19632 "group": "RPC_Realtime",
19633 "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>",
19634 "version": "0.0.0",
19635 "filename": "server/api/rpc/index.js",
19636 "groupTitle": "RPC_Realtime"
19640 "url": "/api/rpc/chat/queues/{id}",
19641 "title": "Gets a single RTChatQueue",
19644 "title": "Example usage:",
19645 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19649 "name": "ShowRTChatQueues",
19650 "group": "RPC_Realtime",
19651 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19652 "version": "0.0.0",
19653 "filename": "server/api/rpc/index.js",
19654 "groupTitle": "RPC_Realtime"
19658 "url": "/api/rpc/fax/queues/{id}",
19659 "title": "Gets a single RTFaxQueue",
19662 "title": "Example usage:",
19663 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19667 "name": "ShowRTFaxQueues",
19668 "group": "RPC_Realtime",
19669 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19670 "version": "0.0.0",
19671 "filename": "server/api/rpc/index.js",
19672 "groupTitle": "RPC_Realtime"
19676 "url": "/api/rpc/mail/queues/{id}",
19677 "title": "Gets a single RTMailQueue",
19680 "title": "Example usage:",
19681 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19685 "name": "ShowRTMailQueues",
19686 "group": "RPC_Realtime",
19687 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19688 "version": "0.0.0",
19689 "filename": "server/api/rpc/index.js",
19690 "groupTitle": "RPC_Realtime"
19694 "url": "/api/rpc/openchannel/queues/{id}",
19695 "title": "Gets a single RTOpenchannelQueue",
19698 "title": "Example usage:",
19699 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19703 "name": "ShowRTOpenchannelQueues",
19704 "group": "RPC_Realtime",
19705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19706 "version": "0.0.0",
19707 "filename": "server/api/rpc/index.js",
19708 "groupTitle": "RPC_Realtime"
19712 "url": "/api/rpc/sms/queues/{id}",
19713 "title": "Gets a single RTSmsQueue",
19716 "title": "Example usage:",
19717 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19721 "name": "ShowRTSmsQueues",
19722 "group": "RPC_Realtime",
19723 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19724 "version": "0.0.0",
19725 "filename": "server/api/rpc/index.js",
19726 "groupTitle": "RPC_Realtime"
19730 "url": "/api/rpc/voice/queues/{id}",
19731 "title": "Gets a single RTVoiceQueue",
19734 "title": "Example usage:",
19735 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19739 "name": "ShowRTVoiceQueues",
19740 "group": "RPC_Realtime",
19741 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19742 "version": "0.0.0",
19743 "filename": "server/api/rpc/index.js",
19744 "groupTitle": "RPC_Realtime"
19748 "url": "/api/rpc/agents/:id/notify",
19749 "title": "Notify message to a specific agent",
19752 "title": "Example usage:",
19753 "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",
19757 "name": "agentNotify",
19758 "group": "RPC_Realtime",
19759 "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>",
19760 "version": "0.0.0",
19761 "filename": "server/api/rpc/index.js",
19762 "groupTitle": "RPC_Realtime"
19766 "url": "/api/rpc/chat/queues/:id/notify",
19767 "title": "Notify message to a specific queue",
19770 "title": "Example usage:",
19771 "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",
19775 "name": "chatQueueNotify",
19776 "group": "RPC_Realtime",
19777 "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>",
19778 "version": "0.0.0",
19779 "filename": "server/api/rpc/index.js",
19780 "groupTitle": "RPC_Realtime"
19784 "url": "/api/rpc/chat/queues/waitinginteractions",
19785 "title": "Gets a list of chatQueuesWaitingInteractions",
19788 "title": "Example usage:",
19789 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
19793 "name": "chatQueuesWaitingInteractions",
19794 "group": "RPC_Realtime",
19795 "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>",
19796 "version": "0.0.0",
19797 "filename": "server/api/rpc/index.js",
19798 "groupTitle": "RPC_Realtime"
19802 "url": "/api/rpc/fax/queues/:id/notify",
19803 "title": "Notify message to a specific queue",
19806 "title": "Example usage:",
19807 "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",
19811 "name": "faxQueueNotify",
19812 "group": "RPC_Realtime",
19813 "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>",
19814 "version": "0.0.0",
19815 "filename": "server/api/rpc/index.js",
19816 "groupTitle": "RPC_Realtime"
19820 "url": "/api/rpc/fax/queues/waitinginteractions",
19821 "title": "Gets a list of faxQueuesWaitingInteractions",
19824 "title": "Example usage:",
19825 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
19829 "name": "faxQueuesWaitingInteractions",
19830 "group": "RPC_Realtime",
19831 "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>",
19832 "version": "0.0.0",
19833 "filename": "server/api/rpc/index.js",
19834 "groupTitle": "RPC_Realtime"
19838 "url": "/api/rpc/mail/queues/:id/notify",
19839 "title": "Notify message to a specific queue",
19842 "title": "Example usage:",
19843 "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",
19847 "name": "mailQueueNotify",
19848 "group": "RPC_Realtime",
19849 "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>",
19850 "version": "0.0.0",
19851 "filename": "server/api/rpc/index.js",
19852 "groupTitle": "RPC_Realtime"
19856 "url": "/api/rpc/mail/queues/waitinginteractions",
19857 "title": "Gets a list of mailQueuesWaitingInteractions",
19860 "title": "Example usage:",
19861 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
19865 "name": "mailQueuesWaitingInteractions",
19866 "group": "RPC_Realtime",
19867 "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>",
19868 "version": "0.0.0",
19869 "filename": "server/api/rpc/index.js",
19870 "groupTitle": "RPC_Realtime"
19874 "url": "/api/rpc/openchannel/queues/:id/notify",
19875 "title": "Notify message to a specific queue",
19878 "title": "Example usage:",
19879 "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",
19883 "name": "openchannelQueueNotify",
19884 "group": "RPC_Realtime",
19885 "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>",
19886 "version": "0.0.0",
19887 "filename": "server/api/rpc/index.js",
19888 "groupTitle": "RPC_Realtime"
19892 "url": "/api/rpc/openchannel/queues/waitinginteractions",
19893 "title": "Gets a list of openchannelQueuesWaitingInteractions",
19896 "title": "Example usage:",
19897 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
19901 "name": "openchannelQueuesWaitingInteractions",
19902 "group": "RPC_Realtime",
19903 "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>",
19904 "version": "0.0.0",
19905 "filename": "server/api/rpc/index.js",
19906 "groupTitle": "RPC_Realtime"
19910 "url": "/api/rpc/sms/queues/:id/notify",
19911 "title": "Notify message to a specific queue",
19914 "title": "Example usage:",
19915 "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",
19919 "name": "smsQueueNotify",
19920 "group": "RPC_Realtime",
19921 "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>",
19922 "version": "0.0.0",
19923 "filename": "server/api/rpc/index.js",
19924 "groupTitle": "RPC_Realtime"
19928 "url": "/api/rpc/sms/queues/waitinginteractions",
19929 "title": "Gets a list of smsQueuesWaitingInteractions",
19932 "title": "Example usage:",
19933 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
19937 "name": "smsQueuesWaitingInteractions",
19938 "group": "RPC_Realtime",
19939 "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>",
19940 "version": "0.0.0",
19941 "filename": "server/api/rpc/index.js",
19942 "groupTitle": "RPC_Realtime"
19946 "url": "/api/integrations/salesforce/accounts",
19947 "title": "Creates a new Salesforce Account",
19950 "title": "Example usage:",
19951 "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",
19955 "name": "CreateSalesforce_Accounts",
19956 "group": "Salesforce_Accounts",
19971 "field": "description",
19978 "field": "username",
19985 "field": "remoteUri",
19992 "field": "password",
19999 "field": "clientId",
20006 "field": "clientSecret",
20013 "field": "securityToken",
20020 "field": "serverUrl",
20027 "\"integrationTab\"",
20037 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20038 "version": "0.0.0",
20039 "filename": "server/api/intSalesforceAccount/index.js",
20040 "groupTitle": "Salesforce_Accounts"
20044 "url": "/api/integrations/salesforce/accounts/{id}",
20045 "title": "Deletes a Salesforce Account",
20048 "title": "Example usage:",
20049 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20053 "name": "DeleteSalesforce_Accounts",
20054 "group": "Salesforce_Accounts",
20055 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20056 "version": "0.0.0",
20057 "filename": "server/api/intSalesforceAccount/index.js",
20058 "groupTitle": "Salesforce_Accounts"
20062 "url": "/api/integrations/salesforce/accounts",
20063 "title": "Gets a list of Salesforce Accounts",
20066 "title": "Example usage:",
20067 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20071 "name": "GetSalesforce_Accounts",
20072 "group": "Salesforce_Accounts",
20073 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20074 "version": "0.0.0",
20075 "filename": "server/api/intSalesforceAccount/index.js",
20076 "groupTitle": "Salesforce_Accounts"
20080 "url": "/api/integrations/salesforce/accounts/{id}",
20081 "title": "Gets a single Salesforce Account",
20084 "title": "Example usage:",
20085 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20089 "name": "ShowSalesforce_Accounts",
20090 "group": "Salesforce_Accounts",
20091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20092 "version": "0.0.0",
20093 "filename": "server/api/intSalesforceAccount/index.js",
20094 "groupTitle": "Salesforce_Accounts"
20098 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20099 "title": "Creates new configuration",
20102 "title": "Example usage:",
20103 "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",
20107 "name": "addConfiguration",
20108 "group": "Salesforce_Accounts",
20109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20110 "version": "0.0.0",
20111 "filename": "server/api/intSalesforceAccount/index.js",
20112 "groupTitle": "Salesforce_Accounts"
20116 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20117 "title": "Gets account configurations",
20120 "title": "Example usage:",
20121 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20125 "name": "getConfigurations",
20126 "group": "Salesforce_Accounts",
20127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20128 "version": "0.0.0",
20129 "filename": "server/api/intSalesforceAccount/index.js",
20130 "groupTitle": "Salesforce_Accounts"
20134 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20135 "title": "Gets account fields",
20138 "title": "Example usage:",
20139 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20143 "name": "getFields",
20144 "group": "Salesforce_Accounts",
20145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20146 "version": "0.0.0",
20147 "filename": "server/api/intSalesforceAccount/index.js",
20148 "groupTitle": "Salesforce_Accounts"
20152 "url": "/api/integrations/salesforce/accounts/{id}",
20153 "title": "Update an existing Salesforce Account",
20156 "title": "Example usage:",
20157 "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",
20161 "name": "updateSalesforce_Accounts",
20162 "group": "Salesforce_Accounts",
20163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20164 "version": "0.0.0",
20165 "filename": "server/api/intSalesforceAccount/index.js",
20166 "groupTitle": "Salesforce_Accounts"
20170 "url": "/api/integrations/salesforce/configurations",
20171 "title": "Creates a new Salesforce Configuration",
20174 "title": "Example usage:",
20175 "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",
20179 "name": "CreateSalesforce_Configurations",
20180 "group": "Salesforce_Configurations",
20195 "field": "description",
20206 "field": "ticketType",
20213 "\"contact_lead\"",
20218 "field": "moduleSearch",
20230 "field": "moduleCreate",
20236 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20237 "version": "0.0.0",
20238 "filename": "server/api/intSalesforceConfiguration/index.js",
20239 "groupTitle": "Salesforce_Configurations"
20243 "url": "/api/integrations/salesforce/configurations/{id}",
20244 "title": "Deletes a Salesforce Configuration",
20247 "title": "Example usage:",
20248 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20252 "name": "DeleteSalesforce_Configurations",
20253 "group": "Salesforce_Configurations",
20254 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20255 "version": "0.0.0",
20256 "filename": "server/api/intSalesforceConfiguration/index.js",
20257 "groupTitle": "Salesforce_Configurations"
20261 "url": "/api/integrations/salesforce/configurations",
20262 "title": "Gets a list of Salesforce Configurations",
20265 "title": "Example usage:",
20266 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20270 "name": "GetSalesforce_Configurations",
20271 "group": "Salesforce_Configurations",
20272 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20273 "version": "0.0.0",
20274 "filename": "server/api/intSalesforceConfiguration/index.js",
20275 "groupTitle": "Salesforce_Configurations"
20279 "url": "/api/integrations/salesforce/configurations/{id}",
20280 "title": "Gets a single Salesforce Configuration",
20283 "title": "Example usage:",
20284 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20288 "name": "ShowSalesforce_Configurations",
20289 "group": "Salesforce_Configurations",
20290 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20291 "version": "0.0.0",
20292 "filename": "server/api/intSalesforceConfiguration/index.js",
20293 "groupTitle": "Salesforce_Configurations"
20297 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20298 "title": "Gets configurations descriptions",
20301 "title": "Example usage:",
20302 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20306 "name": "getDescriptions",
20307 "group": "Salesforce_Configurations",
20308 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20309 "version": "0.0.0",
20310 "filename": "server/api/intSalesforceConfiguration/index.js",
20311 "groupTitle": "Salesforce_Configurations"
20315 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20316 "title": "Gets configurations fields",
20319 "title": "Example usage:",
20320 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20324 "name": "getFields",
20325 "group": "Salesforce_Configurations",
20326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20327 "version": "0.0.0",
20328 "filename": "server/api/intSalesforceConfiguration/index.js",
20329 "groupTitle": "Salesforce_Configurations"
20333 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20334 "title": "Gets configurations subjects",
20337 "title": "Example usage:",
20338 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20342 "name": "getSubjects",
20343 "group": "Salesforce_Configurations",
20344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20345 "version": "0.0.0",
20346 "filename": "server/api/intSalesforceConfiguration/index.js",
20347 "groupTitle": "Salesforce_Configurations"
20351 "url": "/api/integrations/salesforce/configurations/{id}",
20352 "title": "Update an existing Salesforce Configuration",
20355 "title": "Example usage:",
20356 "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",
20360 "name": "updateSalesforce_Configurations",
20361 "group": "Salesforce_Configurations",
20362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20363 "version": "0.0.0",
20364 "filename": "server/api/intSalesforceConfiguration/index.js",
20365 "groupTitle": "Salesforce_Configurations"
20369 "url": "/api/integrations/salesforce/fields",
20370 "title": "Creates a new Salesforce Field",
20373 "title": "Example usage:",
20374 "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",
20378 "name": "CreateSalesforce_Fields",
20379 "group": "Salesforce_Fields",
20389 "\"customVariable\"",
20400 "field": "content",
20416 "\"customVariable\""
20419 "field": "keyType",
20426 "field": "keyContent",
20433 "field": "idField",
20440 "field": "variableName",
20446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20447 "version": "0.0.0",
20448 "filename": "server/api/intSalesforceField/index.js",
20449 "groupTitle": "Salesforce_Fields"
20453 "url": "/api/integrations/salesforce/fields/{id}",
20454 "title": "Deletes a Salesforce Field",
20457 "title": "Example usage:",
20458 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20462 "name": "DeleteSalesforce_Fields",
20463 "group": "Salesforce_Fields",
20464 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20465 "version": "0.0.0",
20466 "filename": "server/api/intSalesforceField/index.js",
20467 "groupTitle": "Salesforce_Fields"
20471 "url": "/api/integrations/salesforce/fields",
20472 "title": "Gets a list of Salesforce Fields",
20475 "title": "Example usage:",
20476 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20480 "name": "GetSalesforce_Fields",
20481 "group": "Salesforce_Fields",
20482 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20483 "version": "0.0.0",
20484 "filename": "server/api/intSalesforceField/index.js",
20485 "groupTitle": "Salesforce_Fields"
20489 "url": "/api/integrations/salesforce/fields/{id}",
20490 "title": "Gets a single Salesforce Field",
20493 "title": "Example usage:",
20494 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20498 "name": "ShowSalesforce_Fields",
20499 "group": "Salesforce_Fields",
20500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20501 "version": "0.0.0",
20502 "filename": "server/api/intSalesforceField/index.js",
20503 "groupTitle": "Salesforce_Fields"
20507 "url": "/api/integrations/salesforce/fields/{id}",
20508 "title": "Update an existing Salesforce Field",
20511 "title": "Example usage:",
20512 "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",
20516 "name": "updateSalesforce_Fields",
20517 "group": "Salesforce_Fields",
20518 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20519 "version": "0.0.0",
20520 "filename": "server/api/intSalesforceField/index.js",
20521 "groupTitle": "Salesforce_Fields"
20525 "url": "/api/schedules",
20526 "title": "Creates a new Schedule",
20529 "title": "Example usage:",
20530 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20534 "name": "CreateSchedules",
20535 "group": "Schedules",
20550 "field": "description",
20571 "field": "startAt",
20585 "field": "subtractNumber",
20601 "field": "subtractUnit",
20631 "field": "sendMail",
20659 "field": "sendIfEmpty",
20665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20666 "version": "0.0.0",
20667 "filename": "server/api/schedule/index.js",
20668 "groupTitle": "Schedules"
20672 "url": "/api/schedules/{id}",
20673 "title": "Deletes a Schedule",
20676 "title": "Example usage:",
20677 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20681 "name": "DeleteSchedules",
20682 "group": "Schedules",
20683 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20684 "version": "0.0.0",
20685 "filename": "server/api/schedule/index.js",
20686 "groupTitle": "Schedules"
20690 "url": "/api/schedules",
20691 "title": "Gets a list of Schedules",
20694 "title": "Example usage:",
20695 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20699 "name": "GetSchedules",
20700 "group": "Schedules",
20701 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20702 "version": "0.0.0",
20703 "filename": "server/api/schedule/index.js",
20704 "groupTitle": "Schedules"
20708 "url": "/api/schedules/{id}",
20709 "title": "Gets a single Schedule",
20712 "title": "Example usage:",
20713 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
20717 "name": "ShowSchedules",
20718 "group": "Schedules",
20719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20720 "version": "0.0.0",
20721 "filename": "server/api/schedule/index.js",
20722 "groupTitle": "Schedules"
20726 "url": "/api/schedules/{id}/run",
20727 "title": "Run Scheduler",
20730 "title": "Example usage:",
20731 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
20736 "group": "Schedules",
20737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20738 "version": "0.0.0",
20739 "filename": "server/api/schedule/index.js",
20740 "groupTitle": "Schedules"
20744 "url": "/api/schedules/{id}",
20745 "title": "Update an existing Schedule",
20748 "title": "Example usage:",
20749 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20753 "name": "updateSchedules",
20754 "group": "Schedules",
20755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20756 "version": "0.0.0",
20757 "filename": "server/api/schedule/index.js",
20758 "groupTitle": "Schedules"
20762 "url": "/api/screen/recordings",
20763 "title": "Creates a new Recording",
20766 "title": "Example usage:",
20767 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20771 "name": "CreateRecordings",
20772 "group": "Screen_Recordings",
20787 "field": "interactionid",
20794 "field": "channel",
20815 "field": "duration",
20822 "field": "startedAt",
20829 "field": "closedAt",
20836 "field": "createdAt",
20843 "field": "updatedAt",
20849 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20850 "version": "0.0.0",
20851 "filename": "server/api/screenRecording/index.js",
20852 "groupTitle": "Screen_Recordings"
20856 "url": "/api/screen/recordings/describe",
20857 "title": "Gets table info about Recordings",
20860 "title": "Example usage:",
20861 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
20865 "name": "DescribeRecordings",
20866 "group": "Screen_Recordings",
20867 "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>",
20868 "version": "0.0.0",
20869 "filename": "server/api/screenRecording/index.js",
20870 "groupTitle": "Screen_Recordings"
20874 "url": "/api/screen/recordings",
20875 "title": "Gets a list of Recordings",
20878 "title": "Example usage:",
20879 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
20883 "name": "GetRecordings",
20884 "group": "Screen_Recordings",
20885 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20886 "version": "0.0.0",
20887 "filename": "server/api/screenRecording/index.js",
20888 "groupTitle": "Screen_Recordings"
20892 "url": "/api/screen/recordings/{id}",
20893 "title": "Gets a single Recording",
20896 "title": "Example usage:",
20897 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
20901 "name": "ShowRecordings",
20902 "group": "Screen_Recordings",
20903 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20904 "version": "0.0.0",
20905 "filename": "server/api/screenRecording/index.js",
20906 "groupTitle": "Screen_Recordings"
20910 "url": "/api/screen/recordings/{id}",
20911 "title": "Delete screen recording",
20914 "title": "Example usage:",
20915 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
20920 "group": "Screen_Recordings",
20921 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20922 "version": "0.0.0",
20923 "filename": "server/api/screenRecording/index.js",
20924 "groupTitle": "Screen_Recordings"
20928 "url": "/api/screen/recordings/{id}/download",
20929 "title": "Download Recording",
20932 "title": "Example usage:",
20933 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
20937 "name": "download",
20938 "group": "Screen_Recordings",
20939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20940 "version": "0.0.0",
20941 "filename": "server/api/screenRecording/index.js",
20942 "groupTitle": "Screen_Recordings"
20946 "url": "/api/screen/recordings/{id}",
20947 "title": "Update an existing Recording",
20950 "title": "Example usage:",
20951 "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",
20955 "name": "updateRecordings",
20956 "group": "Screen_Recordings",
20957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20958 "version": "0.0.0",
20959 "filename": "server/api/screenRecording/index.js",
20960 "groupTitle": "Screen_Recordings"
20964 "url": "/api/integrations/servicenow/accounts",
20965 "title": "Creates a new Servicenow Account",
20968 "title": "Example usage:",
20969 "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",
20973 "name": "CreateServicenow_Accounts",
20974 "group": "Servicenow_Accounts",
20989 "field": "description",
20996 "field": "username",
21003 "field": "password",
21017 "field": "remoteUri",
21024 "field": "serverUrl",
21030 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21031 "version": "0.0.0",
21032 "filename": "server/api/intServicenowAccount/index.js",
21033 "groupTitle": "Servicenow_Accounts"
21037 "url": "/api/integrations/servicenow/accounts/{id}",
21038 "title": "Deletes a Servicenow Account",
21041 "title": "Example usage:",
21042 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21046 "name": "DeleteServicenow_Accounts",
21047 "group": "Servicenow_Accounts",
21048 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21049 "version": "0.0.0",
21050 "filename": "server/api/intServicenowAccount/index.js",
21051 "groupTitle": "Servicenow_Accounts"
21055 "url": "/api/integrations/servicenow/accounts",
21056 "title": "Gets a list of Servicenow Accounts",
21059 "title": "Example usage:",
21060 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21064 "name": "GetServicenow_Accounts",
21065 "group": "Servicenow_Accounts",
21066 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21067 "version": "0.0.0",
21068 "filename": "server/api/intServicenowAccount/index.js",
21069 "groupTitle": "Servicenow_Accounts"
21073 "url": "/api/integrations/servicenow/accounts/{id}",
21074 "title": "Gets a single Servicenow Account",
21077 "title": "Example usage:",
21078 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21082 "name": "ShowServicenow_Accounts",
21083 "group": "Servicenow_Accounts",
21084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21085 "version": "0.0.0",
21086 "filename": "server/api/intServicenowAccount/index.js",
21087 "groupTitle": "Servicenow_Accounts"
21091 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21092 "title": "Creates new configuration",
21095 "title": "Example usage:",
21096 "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",
21100 "name": "addConfiguration",
21101 "group": "Servicenow_Accounts",
21102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21103 "version": "0.0.0",
21104 "filename": "server/api/intServicenowAccount/index.js",
21105 "groupTitle": "Servicenow_Accounts"
21109 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21110 "title": "Gets account configurations",
21113 "title": "Example usage:",
21114 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21118 "name": "getConfigurations",
21119 "group": "Servicenow_Accounts",
21120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21121 "version": "0.0.0",
21122 "filename": "server/api/intServicenowAccount/index.js",
21123 "groupTitle": "Servicenow_Accounts"
21127 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21128 "title": "Gets account fields",
21131 "title": "Example usage:",
21132 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21136 "name": "getFields",
21137 "group": "Servicenow_Accounts",
21138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21139 "version": "0.0.0",
21140 "filename": "server/api/intServicenowAccount/index.js",
21141 "groupTitle": "Servicenow_Accounts"
21145 "url": "/api/integrations/servicenow/accounts/{id}",
21146 "title": "Update an existing Servicenow Account",
21149 "title": "Example usage:",
21150 "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",
21154 "name": "updateServicenow_Accounts",
21155 "group": "Servicenow_Accounts",
21156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21157 "version": "0.0.0",
21158 "filename": "server/api/intServicenowAccount/index.js",
21159 "groupTitle": "Servicenow_Accounts"
21163 "url": "/api/integrations/servicenow/configurations",
21164 "title": "Creates a new Servicenow Configuration",
21167 "title": "Example usage:",
21168 "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",
21172 "name": "CreateServicenow_Configurations",
21173 "group": "Servicenow_Configurations",
21188 "field": "description",
21194 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21195 "version": "0.0.0",
21196 "filename": "server/api/intServicenowConfiguration/index.js",
21197 "groupTitle": "Servicenow_Configurations"
21201 "url": "/api/integrations/servicenow/configurations/{id}",
21202 "title": "Deletes a Servicenow Configuration",
21205 "title": "Example usage:",
21206 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21210 "name": "DeleteServicenow_Configurations",
21211 "group": "Servicenow_Configurations",
21212 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21213 "version": "0.0.0",
21214 "filename": "server/api/intServicenowConfiguration/index.js",
21215 "groupTitle": "Servicenow_Configurations"
21219 "url": "/api/integrations/servicenow/configurations",
21220 "title": "Gets a list of Servicenow Configurations",
21223 "title": "Example usage:",
21224 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21228 "name": "GetServicenow_Configurations",
21229 "group": "Servicenow_Configurations",
21230 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21231 "version": "0.0.0",
21232 "filename": "server/api/intServicenowConfiguration/index.js",
21233 "groupTitle": "Servicenow_Configurations"
21237 "url": "/api/integrations/servicenow/configurations/{id}",
21238 "title": "Gets a single Servicenow Configuration",
21241 "title": "Example usage:",
21242 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21246 "name": "ShowServicenow_Configurations",
21247 "group": "Servicenow_Configurations",
21248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21249 "version": "0.0.0",
21250 "filename": "server/api/intServicenowConfiguration/index.js",
21251 "groupTitle": "Servicenow_Configurations"
21255 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21256 "title": "Gets configurations descriptions",
21259 "title": "Example usage:",
21260 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21264 "name": "getDescriptions",
21265 "group": "Servicenow_Configurations",
21266 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21267 "version": "0.0.0",
21268 "filename": "server/api/intServicenowConfiguration/index.js",
21269 "groupTitle": "Servicenow_Configurations"
21273 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21274 "title": "Gets configurations fields",
21277 "title": "Example usage:",
21278 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21282 "name": "getFields",
21283 "group": "Servicenow_Configurations",
21284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21285 "version": "0.0.0",
21286 "filename": "server/api/intServicenowConfiguration/index.js",
21287 "groupTitle": "Servicenow_Configurations"
21291 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21292 "title": "Gets configurations subjects",
21295 "title": "Example usage:",
21296 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21300 "name": "getSubjects",
21301 "group": "Servicenow_Configurations",
21302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21303 "version": "0.0.0",
21304 "filename": "server/api/intServicenowConfiguration/index.js",
21305 "groupTitle": "Servicenow_Configurations"
21309 "url": "/api/integrations/servicenow/configurations/{id}",
21310 "title": "Update an existing Servicenow Configuration",
21313 "title": "Example usage:",
21314 "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",
21318 "name": "updateServicenow_Configurations",
21319 "group": "Servicenow_Configurations",
21320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21321 "version": "0.0.0",
21322 "filename": "server/api/intServicenowConfiguration/index.js",
21323 "groupTitle": "Servicenow_Configurations"
21327 "url": "/api/integrations/servicenow/fields",
21328 "title": "Creates a new Servicenow Field",
21331 "title": "Example usage:",
21332 "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",
21336 "name": "CreateServicenow_Fields",
21337 "group": "Servicenow_Fields",
21347 "\"customVariable\"",
21358 "field": "content",
21374 "\"customVariable\""
21377 "field": "keyType",
21384 "field": "keyContent",
21391 "field": "idField",
21398 "field": "nameField",
21405 "field": "customField",
21412 "field": "variableName",
21418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21419 "version": "0.0.0",
21420 "filename": "server/api/intServicenowField/index.js",
21421 "groupTitle": "Servicenow_Fields"
21425 "url": "/api/integrations/servicenow/fields/{id}",
21426 "title": "Deletes a Servicenow Field",
21429 "title": "Example usage:",
21430 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21434 "name": "DeleteServicenow_Fields",
21435 "group": "Servicenow_Fields",
21436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21437 "version": "0.0.0",
21438 "filename": "server/api/intServicenowField/index.js",
21439 "groupTitle": "Servicenow_Fields"
21443 "url": "/api/integrations/servicenow/fields",
21444 "title": "Gets a list of Servicenow Fields",
21447 "title": "Example usage:",
21448 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21452 "name": "GetServicenow_Fields",
21453 "group": "Servicenow_Fields",
21454 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21455 "version": "0.0.0",
21456 "filename": "server/api/intServicenowField/index.js",
21457 "groupTitle": "Servicenow_Fields"
21461 "url": "/api/integrations/servicenow/fields/{id}",
21462 "title": "Gets a single Servicenow Field",
21465 "title": "Example usage:",
21466 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21470 "name": "ShowServicenow_Fields",
21471 "group": "Servicenow_Fields",
21472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21473 "version": "0.0.0",
21474 "filename": "server/api/intServicenowField/index.js",
21475 "groupTitle": "Servicenow_Fields"
21479 "url": "/api/integrations/servicenow/fields/{id}",
21480 "title": "Update an existing Servicenow Field",
21483 "title": "Example usage:",
21484 "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",
21488 "name": "updateServicenow_Fields",
21489 "group": "Servicenow_Fields",
21490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21491 "version": "0.0.0",
21492 "filename": "server/api/intServicenowField/index.js",
21493 "groupTitle": "Servicenow_Fields"
21497 "url": "/api/settings",
21498 "title": "Gets a list of Settings",
21501 "title": "Example usage:",
21502 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21506 "name": "GetSettings",
21507 "group": "Settings",
21508 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21509 "version": "0.0.0",
21510 "filename": "server/api/setting/index.js",
21511 "groupTitle": "Settings"
21515 "url": "/api/settings/{id}",
21516 "title": "Gets a single Setting",
21519 "title": "Example usage:",
21520 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21524 "name": "ShowSettings",
21525 "group": "Settings",
21526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21527 "version": "0.0.0",
21528 "filename": "server/api/setting/index.js",
21529 "groupTitle": "Settings"
21533 "url": "/api/settings/{id}/favicon",
21534 "title": "Add Favicon",
21537 "title": "Example usage:",
21538 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21542 "name": "addFavicon",
21543 "group": "Settings",
21544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21545 "version": "0.0.0",
21546 "filename": "server/api/setting/index.js",
21547 "groupTitle": "Settings"
21551 "url": "/api/settings/{id}/logo",
21552 "title": "Add logo",
21555 "title": "Example usage:",
21556 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21561 "group": "Settings",
21562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21563 "version": "0.0.0",
21564 "filename": "server/api/setting/index.js",
21565 "groupTitle": "Settings"
21569 "url": "/api/settings/{id}/logo_login",
21570 "title": "Add logo login",
21573 "title": "Example usage:",
21574 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21578 "name": "addLogoLogin",
21579 "group": "Settings",
21580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21581 "version": "0.0.0",
21582 "filename": "server/api/setting/index.js",
21583 "groupTitle": "Settings"
21587 "url": "/api/settings/{id}/preferred",
21588 "title": "Add Preferred",
21591 "title": "Example usage:",
21592 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21596 "name": "addPreferred",
21597 "group": "Settings",
21598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21599 "version": "0.0.0",
21600 "filename": "server/api/setting/index.js",
21601 "groupTitle": "Settings"
21605 "url": "/api/settings/{id}/favicon",
21606 "title": "Get Favicon",
21609 "title": "Example usage:",
21610 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21614 "name": "getFavicon",
21615 "group": "Settings",
21616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21617 "version": "0.0.0",
21618 "filename": "server/api/setting/index.js",
21619 "groupTitle": "Settings"
21623 "url": "/api/settings/{id}/gdpr",
21624 "title": "Get gdpr settings",
21627 "title": "Example usage:",
21628 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21633 "group": "Settings",
21634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21635 "version": "0.0.0",
21636 "filename": "server/api/setting/index.js",
21637 "groupTitle": "Settings"
21641 "url": "/api/settings/{id}/logo",
21642 "title": "Get logo",
21645 "title": "Example usage:",
21646 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21651 "group": "Settings",
21652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21653 "version": "0.0.0",
21654 "filename": "server/api/setting/index.js",
21655 "groupTitle": "Settings"
21659 "url": "/api/settings/{id}/logo_login",
21660 "title": "Get logo login",
21663 "title": "Example usage:",
21664 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21668 "name": "getLogoLogin",
21669 "group": "Settings",
21670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21671 "version": "0.0.0",
21672 "filename": "server/api/setting/index.js",
21673 "groupTitle": "Settings"
21677 "url": "/api/settings/{id}/preferred",
21678 "title": "Get Preferred",
21681 "title": "Example usage:",
21682 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21686 "name": "getPreferred",
21687 "group": "Settings",
21688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21689 "version": "0.0.0",
21690 "filename": "server/api/setting/index.js",
21691 "groupTitle": "Settings"
21695 "url": "/api/settings/{id}",
21696 "title": "Update an existing Setting",
21699 "title": "Example usage:",
21700 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21704 "name": "updateSettings",
21705 "group": "Settings",
21706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21707 "version": "0.0.0",
21708 "filename": "server/api/setting/index.js",
21709 "groupTitle": "Settings"
21713 "url": "/api/sms/accounts/{id}/users",
21714 "title": "Add agents to a sms account",
21717 "title": "Example usage:",
21718 "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",
21722 "name": "AddAgents",
21723 "group": "Sms_Accounts",
21724 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21725 "version": "0.0.0",
21726 "filename": "server/api/smsAccount/index.js",
21727 "groupTitle": "Sms_Accounts"
21731 "url": "/api/sms/accounts",
21732 "title": "Creates a new Account",
21735 "title": "Example usage:",
21736 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21740 "name": "CreateAccounts",
21741 "group": "Sms_Accounts",
21802 "field": "accountSid",
21816 "field": "authToken",
21828 "field": "smsMethod",
21835 "field": "username",
21842 "field": "password",
21856 "field": "senderString",
21863 "field": "deliveryReport",
21870 "field": "description",
21877 "field": "notificationTemplate",
21884 "field": "notificationSound",
21891 "field": "notificationShake",
21898 "field": "waitForTheAssignedAgent",
21905 "field": "queueTransfer",
21912 "field": "queueTransferTimeout",
21919 "field": "agentTransfer",
21926 "field": "agentTransferTimeout",
21933 "field": "baseUrl",
21940 "field": "mandatoryDispositionPauseId",
21941 "description": "<p>Status to put when mandatory disposition is enabled</p>"
21947 "field": "mandatoryDisposition",
21948 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
21953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21954 "version": "0.0.0",
21955 "filename": "server/api/smsAccount/index.js",
21956 "groupTitle": "Sms_Accounts"
21960 "url": "/api/sms/accounts/{id}",
21961 "title": "Deletes a Account",
21964 "title": "Example usage:",
21965 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
21969 "name": "DeleteAccounts",
21970 "group": "Sms_Accounts",
21971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21972 "version": "0.0.0",
21973 "filename": "server/api/smsAccount/index.js",
21974 "groupTitle": "Sms_Accounts"
21978 "url": "/api/sms/accounts/describe",
21979 "title": "Gets table info about Accounts",
21982 "title": "Example usage:",
21983 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
21987 "name": "DescribeAccounts",
21988 "group": "Sms_Accounts",
21989 "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>",
21990 "version": "0.0.0",
21991 "filename": "server/api/smsAccount/index.js",
21992 "groupTitle": "Sms_Accounts"
21996 "url": "/api/sms/accounts",
21997 "title": "Gets a list of Accounts",
22000 "title": "Example usage:",
22001 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22005 "name": "GetAccounts",
22006 "group": "Sms_Accounts",
22007 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22008 "version": "0.0.0",
22009 "filename": "server/api/smsAccount/index.js",
22010 "groupTitle": "Sms_Accounts"
22014 "url": "/api/sms/accounts/{id}/users",
22015 "title": "Gets agents from sms account",
22018 "title": "Example usage:",
22019 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22023 "name": "GetAgents",
22024 "group": "Sms_Accounts",
22025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22026 "version": "0.0.0",
22027 "filename": "server/api/smsAccount/index.js",
22028 "groupTitle": "Sms_Accounts"
22032 "url": "/api/sms/accounts/{id}/users",
22033 "title": "Removes agents from a sms account",
22036 "title": "Example usage:",
22037 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22041 "name": "RemoveAgents",
22042 "group": "Sms_Accounts",
22043 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22044 "version": "0.0.0",
22045 "filename": "server/api/smsAccount/index.js",
22046 "groupTitle": "Sms_Accounts"
22050 "url": "/api/sms/accounts/{id}/canned_answers",
22051 "title": "Removes canned answers from account",
22054 "title": "Example usage:",
22055 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22059 "name": "RemoveAnswers",
22060 "group": "Sms_Accounts",
22061 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22062 "version": "0.0.0",
22063 "filename": "server/api/smsAccount/index.js",
22064 "groupTitle": "Sms_Accounts"
22068 "url": "/api/sms/accounts/{id}/dispositions",
22069 "title": "Removes dispositions from account",
22072 "title": "Example usage:",
22073 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22077 "name": "RemoveDispositions",
22078 "group": "Sms_Accounts",
22079 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22080 "version": "0.0.0",
22081 "filename": "server/api/smsAccount/index.js",
22082 "groupTitle": "Sms_Accounts"
22086 "url": "/api/sms/accounts/{id}",
22087 "title": "Gets a single Account",
22090 "title": "Example usage:",
22091 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22095 "name": "ShowAccounts",
22096 "group": "Sms_Accounts",
22097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22098 "version": "0.0.0",
22099 "filename": "server/api/smsAccount/index.js",
22100 "groupTitle": "Sms_Accounts"
22104 "url": "/api/sms/messages/{id}/accept",
22105 "title": "Accepts message",
22108 "title": "Example usage:",
22109 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22113 "name": "acceptMessage",
22114 "group": "Sms_Accounts",
22115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22116 "version": "0.0.0",
22117 "filename": "server/api/smsMessage/index.js",
22118 "groupTitle": "Sms_Accounts"
22122 "url": "/api/sms/accounts/{id}/canned_answers",
22123 "title": "Creates new canned answer",
22126 "title": "Example usage:",
22127 "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",
22131 "name": "addAnswer",
22132 "group": "Sms_Accounts",
22154 "field": "description",
22167 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22168 "version": "0.0.0",
22169 "filename": "server/api/smsAccount/index.js",
22170 "groupTitle": "Sms_Accounts"
22174 "url": "/api/sms/accounts/{id}/applications",
22175 "title": "Creates new applications",
22178 "title": "Example usage:",
22179 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22183 "name": "addApplications",
22184 "group": "Sms_Accounts",
22192 "field": "priority",
22206 "field": "appdata",
22213 "field": "description",
22220 "field": "interval",
22226 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22227 "version": "0.0.0",
22228 "filename": "server/api/smsAccount/index.js",
22229 "groupTitle": "Sms_Accounts"
22233 "url": "/api/sms/accounts/{id}/dispositions",
22234 "title": "Creates new disposition",
22237 "title": "Example usage:",
22238 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22242 "name": "addDisposition",
22243 "group": "Sms_Accounts",
22257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22258 "version": "0.0.0",
22259 "filename": "server/api/smsAccount/index.js",
22260 "groupTitle": "Sms_Accounts"
22264 "url": "/api/sms/accounts/{id}/canned_answers",
22265 "title": "Gets account canned answers",
22268 "title": "Example usage:",
22269 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22273 "name": "getAnswers",
22274 "group": "Sms_Accounts",
22275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22276 "version": "0.0.0",
22277 "filename": "server/api/smsAccount/index.js",
22278 "groupTitle": "Sms_Accounts"
22282 "url": "/api/sms/accounts/{id}/applications",
22283 "title": "Gets account applications",
22286 "title": "Example usage:",
22287 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22291 "name": "getApplications",
22292 "group": "Sms_Accounts",
22293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22294 "version": "0.0.0",
22295 "filename": "server/api/smsAccount/index.js",
22296 "groupTitle": "Sms_Accounts"
22300 "url": "/api/sms/accounts/{id}/dispositions",
22301 "title": "Gets account dispositions",
22304 "title": "Example usage:",
22305 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22309 "name": "getDispositions",
22310 "group": "Sms_Accounts",
22311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22312 "version": "0.0.0",
22313 "filename": "server/api/smsAccount/index.js",
22314 "groupTitle": "Sms_Accounts"
22318 "url": "/api/sms/accounts/{id}/interactions",
22319 "title": "Gets Sms Account interactions",
22322 "title": "Example usage:",
22323 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22327 "name": "getInteractions",
22328 "group": "Sms_Accounts",
22329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22330 "version": "0.0.0",
22331 "filename": "server/api/smsAccount/index.js",
22332 "groupTitle": "Sms_Accounts"
22336 "url": "/api/sms/accounts/{id}/notify",
22337 "title": "Notify new message",
22340 "title": "Example usage:",
22341 "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",
22346 "group": "Sms_Accounts",
22347 "description": "<p>Motion 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>",
22348 "version": "0.0.0",
22349 "filename": "server/api/smsAccount/index.js",
22350 "groupTitle": "Sms_Accounts"
22354 "url": "/api/sms/messages/{id}/reject",
22355 "title": "Rejects message",
22358 "title": "Example usage:",
22359 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22363 "name": "rejectMessage",
22364 "group": "Sms_Accounts",
22365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22366 "version": "0.0.0",
22367 "filename": "server/api/smsMessage/index.js",
22368 "groupTitle": "Sms_Accounts"
22372 "url": "/api/sms/accounts/{id}/send",
22373 "title": "Send new sms message",
22376 "title": "Example usage:",
22377 "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",
22382 "group": "Sms_Accounts",
22383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22384 "version": "0.0.0",
22385 "filename": "server/api/smsAccount/index.js",
22386 "groupTitle": "Sms_Accounts"
22390 "url": "/api/sms/messages/{id}/status",
22391 "title": "Receive message status",
22394 "title": "Example usage:",
22395 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22399 "name": "statusMessage",
22400 "group": "Sms_Accounts",
22401 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22402 "version": "0.0.0",
22403 "filename": "server/api/smsMessage/index.js",
22404 "groupTitle": "Sms_Accounts"
22408 "url": "/api/sms/accounts/{id}/status",
22409 "title": "Receive message status as get request",
22412 "title": "Example usage:",
22413 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22417 "name": "statusMessage",
22418 "group": "Sms_Accounts",
22419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22420 "version": "0.0.0",
22421 "filename": "server/api/smsAccount/index.js",
22422 "groupTitle": "Sms_Accounts"
22426 "url": "/api/sms/accounts/{id}/status",
22427 "title": "Receive message status",
22430 "title": "Example usage:",
22431 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22435 "name": "statusMessage",
22436 "group": "Sms_Accounts",
22437 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22438 "version": "0.0.0",
22439 "filename": "server/api/smsAccount/index.js",
22440 "groupTitle": "Sms_Accounts"
22444 "url": "/api/sms/accounts/{id}",
22445 "title": "Update an existing Account",
22448 "title": "Example usage:",
22449 "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",
22453 "name": "updateAccounts",
22454 "group": "Sms_Accounts",
22455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22456 "version": "0.0.0",
22457 "filename": "server/api/smsAccount/index.js",
22458 "groupTitle": "Sms_Accounts"
22462 "url": "/api/sms/applications",
22463 "title": "Creates a new Application",
22466 "title": "Example usage:",
22467 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22471 "name": "CreateApplications",
22472 "group": "Sms_Applications",
22480 "field": "priority",
22494 "field": "appdata",
22501 "field": "description",
22508 "field": "interval",
22514 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22515 "version": "0.0.0",
22516 "filename": "server/api/smsApplication/index.js",
22517 "groupTitle": "Sms_Applications"
22521 "url": "/api/sms/applications/{id}",
22522 "title": "Deletes a Application",
22525 "title": "Example usage:",
22526 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22530 "name": "DeleteApplications",
22531 "group": "Sms_Applications",
22532 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22533 "version": "0.0.0",
22534 "filename": "server/api/smsApplication/index.js",
22535 "groupTitle": "Sms_Applications"
22539 "url": "/api/sms/applications",
22540 "title": "Gets a list of Applications",
22543 "title": "Example usage:",
22544 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22548 "name": "GetApplications",
22549 "group": "Sms_Applications",
22550 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22551 "version": "0.0.0",
22552 "filename": "server/api/smsApplication/index.js",
22553 "groupTitle": "Sms_Applications"
22557 "url": "/api/sms/applications/{id}",
22558 "title": "Gets a single Application",
22561 "title": "Example usage:",
22562 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22566 "name": "ShowApplications",
22567 "group": "Sms_Applications",
22568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22569 "version": "0.0.0",
22570 "filename": "server/api/smsApplication/index.js",
22571 "groupTitle": "Sms_Applications"
22575 "url": "/api/sms/applications/{id}",
22576 "title": "Update an existing Application",
22579 "title": "Example usage:",
22580 "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",
22584 "name": "updateApplications",
22585 "group": "Sms_Applications",
22586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22587 "version": "0.0.0",
22588 "filename": "server/api/smsApplication/index.js",
22589 "groupTitle": "Sms_Applications"
22593 "url": "/api/sms/interactions/{id}/tags",
22594 "title": "Add tags to the interaction",
22597 "title": "Example usage:",
22598 "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",
22603 "group": "Sms_Interactions",
22604 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22605 "version": "0.0.0",
22606 "filename": "server/api/smsInteraction/index.js",
22607 "groupTitle": "Sms_Interactions"
22611 "url": "/api/sms/interactions",
22612 "title": "Creates a new Interaction",
22615 "title": "Example usage:",
22616 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22620 "name": "CreateInteractions",
22621 "group": "Sms_Interactions",
22636 "field": "closedAt",
22643 "field": "disposition",
22664 "field": "read1stAt",
22675 "field": "firstMsgDirection",
22682 "field": "lastMsgAt",
22693 "field": "lastMsgDirection",
22699 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22700 "version": "0.0.0",
22701 "filename": "server/api/smsInteraction/index.js",
22702 "groupTitle": "Sms_Interactions"
22706 "url": "/api/sms/interactions/{id}",
22707 "title": "Deletes a Interaction",
22710 "title": "Example usage:",
22711 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
22715 "name": "DeleteInteractions",
22716 "group": "Sms_Interactions",
22717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22718 "version": "0.0.0",
22719 "filename": "server/api/smsInteraction/index.js",
22720 "groupTitle": "Sms_Interactions"
22724 "url": "/api/sms/interactions/describe",
22725 "title": "Gets table info about Interactions",
22728 "title": "Example usage:",
22729 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
22733 "name": "DescribeInteractions",
22734 "group": "Sms_Interactions",
22735 "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>",
22736 "version": "0.0.0",
22737 "filename": "server/api/smsInteraction/index.js",
22738 "groupTitle": "Sms_Interactions"
22742 "url": "/api/sms/interactions",
22743 "title": "Gets a list of Interactions",
22746 "title": "Example usage:",
22747 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
22751 "name": "GetInteractions",
22752 "group": "Sms_Interactions",
22753 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22754 "version": "0.0.0",
22755 "filename": "server/api/smsInteraction/index.js",
22756 "groupTitle": "Sms_Interactions"
22760 "url": "/api/sms/interactions/{id}/tags",
22761 "title": "Removes tags from interaction",
22764 "title": "Example usage:",
22765 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22769 "name": "RemoveTags",
22770 "group": "Sms_Interactions",
22771 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22772 "version": "0.0.0",
22773 "filename": "server/api/smsInteraction/index.js",
22774 "groupTitle": "Sms_Interactions"
22778 "url": "/api/sms/interactions/{id}",
22779 "title": "Gets a single Interaction",
22782 "title": "Example usage:",
22783 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
22787 "name": "ShowInteractions",
22788 "group": "Sms_Interactions",
22789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22790 "version": "0.0.0",
22791 "filename": "server/api/smsInteraction/index.js",
22792 "groupTitle": "Sms_Interactions"
22796 "url": "/api/sms/interactions/{id}/messages",
22797 "title": "Creates new messages",
22800 "title": "Example usage:",
22801 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22805 "name": "addMessage",
22806 "group": "Sms_Interactions",
22832 "field": "direction",
22839 "field": "messageId",
22866 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22867 "version": "0.0.0",
22868 "filename": "server/api/smsInteraction/index.js",
22869 "groupTitle": "Sms_Interactions"
22873 "url": "/api/sms/interactions/{id}/download",
22874 "title": "Gets interaction",
22877 "title": "Example usage:",
22878 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
22882 "name": "download",
22883 "group": "Sms_Interactions",
22884 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22885 "version": "0.0.0",
22886 "filename": "server/api/smsInteraction/index.js",
22887 "groupTitle": "Sms_Interactions"
22891 "url": "/api/sms/interactions/{id}/messages",
22892 "title": "Gets interaction messages",
22895 "title": "Example usage:",
22896 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
22900 "name": "getMessages",
22901 "group": "Sms_Interactions",
22902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22903 "version": "0.0.0",
22904 "filename": "server/api/smsInteraction/index.js",
22905 "groupTitle": "Sms_Interactions"
22909 "url": "/api/sms/interactions/{id}",
22910 "title": "Update an existing Interaction",
22913 "title": "Example usage:",
22914 "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",
22918 "name": "updateInteractions",
22919 "group": "Sms_Interactions",
22920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22921 "version": "0.0.0",
22922 "filename": "server/api/smsInteraction/index.js",
22923 "groupTitle": "Sms_Interactions"
22927 "url": "/api/sms/messages",
22928 "title": "Creates a new Message",
22931 "title": "Example usage:",
22932 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22936 "name": "CreateMessages",
22937 "group": "Sms_Messages",
22963 "field": "direction",
22970 "field": "messageId",
22997 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22998 "version": "0.0.0",
22999 "filename": "server/api/smsMessage/index.js",
23000 "groupTitle": "Sms_Messages"
23004 "url": "/api/sms/messages/{id}",
23005 "title": "Deletes a Message",
23008 "title": "Example usage:",
23009 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23013 "name": "DeleteMessages",
23014 "group": "Sms_Messages",
23015 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23016 "version": "0.0.0",
23017 "filename": "server/api/smsMessage/index.js",
23018 "groupTitle": "Sms_Messages"
23022 "url": "/api/sms/messages/describe",
23023 "title": "Gets table info about Messages",
23026 "title": "Example usage:",
23027 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23031 "name": "DescribeMessages",
23032 "group": "Sms_Messages",
23033 "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>",
23034 "version": "0.0.0",
23035 "filename": "server/api/smsMessage/index.js",
23036 "groupTitle": "Sms_Messages"
23040 "url": "/api/sms/messages",
23041 "title": "Gets a list of Messages",
23044 "title": "Example usage:",
23045 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23049 "name": "GetMessages",
23050 "group": "Sms_Messages",
23051 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23052 "version": "0.0.0",
23053 "filename": "server/api/smsMessage/index.js",
23054 "groupTitle": "Sms_Messages"
23058 "url": "/api/sms/messages/{id}",
23059 "title": "Gets a single Message",
23062 "title": "Example usage:",
23063 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23067 "name": "ShowMessages",
23068 "group": "Sms_Messages",
23069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23070 "version": "0.0.0",
23071 "filename": "server/api/smsMessage/index.js",
23072 "groupTitle": "Sms_Messages"
23076 "url": "/api/sms/messages/{id}",
23077 "title": "Update an existing Message",
23080 "title": "Example usage:",
23081 "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",
23085 "name": "updateMessages",
23086 "group": "Sms_Messages",
23087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23088 "version": "0.0.0",
23089 "filename": "server/api/smsMessage/index.js",
23090 "groupTitle": "Sms_Messages"
23094 "url": "/api/sms/reports/queue",
23095 "title": "Creates a new Sms Queue Report",
23098 "title": "Example usage:",
23099 "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",
23103 "name": "CreateSms_Queue_Reports",
23104 "group": "Sms_Queue_Reports",
23112 "field": "uniqueid",
23133 "field": "leaveAt",
23140 "field": "acceptAt",
23160 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161 "version": "0.0.0",
23162 "filename": "server/api/smsQueueReport/index.js",
23163 "groupTitle": "Sms_Queue_Reports"
23167 "url": "/api/sms/reports/queue/{id}",
23168 "title": "Deletes a Sms Queue Report",
23171 "title": "Example usage:",
23172 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23176 "name": "DeleteSms_Queue_Reports",
23177 "group": "Sms_Queue_Reports",
23178 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23179 "version": "0.0.0",
23180 "filename": "server/api/smsQueueReport/index.js",
23181 "groupTitle": "Sms_Queue_Reports"
23185 "url": "/api/sms/reports/queue/describe",
23186 "title": "Gets table info about Sms Queue Reports",
23189 "title": "Example usage:",
23190 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23194 "name": "DescribeSms_Queue_Reports",
23195 "group": "Sms_Queue_Reports",
23196 "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>",
23197 "version": "0.0.0",
23198 "filename": "server/api/smsQueueReport/index.js",
23199 "groupTitle": "Sms_Queue_Reports"
23203 "url": "/api/sms/reports/queue",
23204 "title": "Gets a list of Sms Queue Reports",
23207 "title": "Example usage:",
23208 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23212 "name": "GetSms_Queue_Reports",
23213 "group": "Sms_Queue_Reports",
23214 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23215 "version": "0.0.0",
23216 "filename": "server/api/smsQueueReport/index.js",
23217 "groupTitle": "Sms_Queue_Reports"
23221 "url": "/api/sms/reports/queue/{id}",
23222 "title": "Gets a single Sms Queue Report",
23225 "title": "Example usage:",
23226 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23230 "name": "ShowSms_Queue_Reports",
23231 "group": "Sms_Queue_Reports",
23232 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23233 "version": "0.0.0",
23234 "filename": "server/api/smsQueueReport/index.js",
23235 "groupTitle": "Sms_Queue_Reports"
23239 "url": "/api/sms/reports/queue/{id}",
23240 "title": "Update an existing Sms Queue Report",
23243 "title": "Example usage:",
23244 "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",
23248 "name": "updateSms_Queue_Reports",
23249 "group": "Sms_Queue_Reports",
23250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23251 "version": "0.0.0",
23252 "filename": "server/api/smsQueueReport/index.js",
23253 "groupTitle": "Sms_Queue_Reports"
23257 "url": "/api/sms/queues/{id}/users",
23258 "title": "Add agents to a queue",
23261 "title": "Example usage:",
23262 "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",
23266 "name": "AddAgents",
23267 "group": "Sms_Queues",
23268 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23269 "version": "0.0.0",
23270 "filename": "server/api/smsQueue/index.js",
23271 "groupTitle": "Sms_Queues"
23275 "url": "/api/sms/queues/{id}/teams",
23276 "title": "Add teams to a queue",
23279 "title": "Example usage:",
23280 "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",
23284 "name": "AddTeams",
23285 "group": "Sms_Queues",
23286 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23287 "version": "0.0.0",
23288 "filename": "server/api/smsQueue/index.js",
23289 "groupTitle": "Sms_Queues"
23293 "url": "/api/sms/queues",
23294 "title": "Creates a new Queue",
23297 "title": "Example usage:",
23298 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23302 "name": "CreateQueues",
23303 "group": "Sms_Queues",
23318 "field": "description",
23325 "field": "timeout",
23337 "field": "strategy",
23343 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23344 "version": "0.0.0",
23345 "filename": "server/api/smsQueue/index.js",
23346 "groupTitle": "Sms_Queues"
23350 "url": "/api/sms/queues/{id}",
23351 "title": "Deletes a Queue",
23354 "title": "Example usage:",
23355 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23359 "name": "DeleteQueues",
23360 "group": "Sms_Queues",
23361 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23362 "version": "0.0.0",
23363 "filename": "server/api/smsQueue/index.js",
23364 "groupTitle": "Sms_Queues"
23368 "url": "/api/sms/queues/describe",
23369 "title": "Gets table info about Queues",
23372 "title": "Example usage:",
23373 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23377 "name": "DescribeQueues",
23378 "group": "Sms_Queues",
23379 "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>",
23380 "version": "0.0.0",
23381 "filename": "server/api/smsQueue/index.js",
23382 "groupTitle": "Sms_Queues"
23386 "url": "/api/sms/queues/{id}/users",
23387 "title": "Gets queue agents",
23390 "title": "Example usage:",
23391 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23395 "name": "GetAgents",
23396 "group": "Sms_Queues",
23397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23398 "version": "0.0.0",
23399 "filename": "server/api/smsQueue/index.js",
23400 "groupTitle": "Sms_Queues"
23404 "url": "/api/sms/queues/{id}/members",
23405 "title": "GetMembers",
23408 "title": "Example usage:",
23409 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23413 "name": "GetMembers",
23414 "group": "Sms_Queues",
23415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23416 "version": "0.0.0",
23417 "filename": "server/api/smsQueue/index.js",
23418 "groupTitle": "Sms_Queues"
23422 "url": "/api/sms/queues",
23423 "title": "Gets a list of Queues",
23426 "title": "Example usage:",
23427 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23431 "name": "GetQueues",
23432 "group": "Sms_Queues",
23433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23434 "version": "0.0.0",
23435 "filename": "server/api/smsQueue/index.js",
23436 "groupTitle": "Sms_Queues"
23440 "url": "/api/sms/queues/{id}/teams",
23441 "title": "Gets queues list",
23444 "title": "Example usage:",
23445 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23449 "name": "GetTeams",
23450 "group": "Sms_Queues",
23451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23452 "version": "0.0.0",
23453 "filename": "server/api/smsQueue/index.js",
23454 "groupTitle": "Sms_Queues"
23458 "url": "/api/sms/queues/{id}/users",
23459 "title": "Removes agents from a queue",
23462 "title": "Example usage:",
23463 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23467 "name": "RemoveAgents",
23468 "group": "Sms_Queues",
23469 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23470 "version": "0.0.0",
23471 "filename": "server/api/smsQueue/index.js",
23472 "groupTitle": "Sms_Queues"
23476 "url": "/api/sms/queues/{id}",
23477 "title": "Gets a single Queue",
23480 "title": "Example usage:",
23481 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23485 "name": "ShowQueues",
23486 "group": "Sms_Queues",
23487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23488 "version": "0.0.0",
23489 "filename": "server/api/smsQueue/index.js",
23490 "groupTitle": "Sms_Queues"
23494 "url": "/api/sms/queues/{id}",
23495 "title": "Update an existing Queue",
23498 "title": "Example usage:",
23499 "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",
23503 "name": "updateQueues",
23504 "group": "Sms_Queues",
23505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23506 "version": "0.0.0",
23507 "filename": "server/api/smsQueue/index.js",
23508 "groupTitle": "Sms_Queues"
23512 "url": "/api/sms/reports/transfer",
23513 "title": "Creates a new Sms Transfer Report",
23516 "title": "Example usage:",
23517 "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",
23521 "name": "CreateSms_Transfer_Reports",
23522 "group": "Sms_Transfer_Reports",
23530 "field": "uniqueid",
23549 "field": "transferredAt",
23555 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23556 "version": "0.0.0",
23557 "filename": "server/api/smsTransferReport/index.js",
23558 "groupTitle": "Sms_Transfer_Reports"
23562 "url": "/api/sms/reports/transfer/{id}",
23563 "title": "Deletes a Sms Transfer Report",
23566 "title": "Example usage:",
23567 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23571 "name": "DeleteSms_Transfer_Reports",
23572 "group": "Sms_Transfer_Reports",
23573 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23574 "version": "0.0.0",
23575 "filename": "server/api/smsTransferReport/index.js",
23576 "groupTitle": "Sms_Transfer_Reports"
23580 "url": "/api/sms/reports/transfer/describe",
23581 "title": "Gets table info about Sms Transfer Reports",
23584 "title": "Example usage:",
23585 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23589 "name": "DescribeSms_Transfer_Reports",
23590 "group": "Sms_Transfer_Reports",
23591 "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>",
23592 "version": "0.0.0",
23593 "filename": "server/api/smsTransferReport/index.js",
23594 "groupTitle": "Sms_Transfer_Reports"
23598 "url": "/api/sms/reports/transfer",
23599 "title": "Gets a list of Sms Transfer Reports",
23602 "title": "Example usage:",
23603 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23607 "name": "GetSms_Transfer_Reports",
23608 "group": "Sms_Transfer_Reports",
23609 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23610 "version": "0.0.0",
23611 "filename": "server/api/smsTransferReport/index.js",
23612 "groupTitle": "Sms_Transfer_Reports"
23616 "url": "/api/sms/reports/transfer/{id}",
23617 "title": "Gets a single Sms Transfer Report",
23620 "title": "Example usage:",
23621 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23625 "name": "ShowSms_Transfer_Reports",
23626 "group": "Sms_Transfer_Reports",
23627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23628 "version": "0.0.0",
23629 "filename": "server/api/smsTransferReport/index.js",
23630 "groupTitle": "Sms_Transfer_Reports"
23634 "url": "/api/sms/reports/transfer/{id}",
23635 "title": "Update an existing Sms Transfer Report",
23638 "title": "Example usage:",
23639 "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",
23643 "name": "updateSms_Transfer_Reports",
23644 "group": "Sms_Transfer_Reports",
23645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23646 "version": "0.0.0",
23647 "filename": "server/api/smsTransferReport/index.js",
23648 "groupTitle": "Sms_Transfer_Reports"
23652 "url": "/api/sounds",
23653 "title": "Gets a list of Sounds",
23656 "title": "Example usage:",
23657 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
23661 "name": "GetSounds",
23663 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23664 "version": "0.0.0",
23665 "filename": "server/api/sound/index.js",
23666 "groupTitle": "Sounds"
23670 "url": "/api/sounds/{id}",
23671 "title": "Gets a single Sound",
23674 "title": "Example usage:",
23675 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
23679 "name": "ShowSounds",
23681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23682 "version": "0.0.0",
23683 "filename": "server/api/sound/index.js",
23684 "groupTitle": "Sounds"
23688 "url": "/api/sounds",
23689 "title": "Create a new sound",
23692 "title": "Example usage:",
23693 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23697 "name": "addSound",
23699 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23700 "version": "0.0.0",
23701 "filename": "server/api/sound/index.js",
23702 "groupTitle": "Sounds"
23706 "url": "/api/sounds/{id}",
23707 "title": "Deletes a sound",
23710 "title": "Example usage:",
23711 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
23715 "name": "destroySound",
23717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23718 "version": "0.0.0",
23719 "filename": "server/api/sound/index.js",
23720 "groupTitle": "Sounds"
23724 "url": "/api/sounds/{id}/download",
23725 "title": "Download Sound",
23728 "title": "Example usage:",
23729 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
23733 "name": "download",
23735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23736 "version": "0.0.0",
23737 "filename": "server/api/sound/index.js",
23738 "groupTitle": "Sounds"
23742 "url": "/api/sounds",
23743 "title": "Update an existing new sound",
23746 "title": "Example usage:",
23747 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
23751 "name": "updateSound",
23753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23754 "version": "0.0.0",
23755 "filename": "server/api/sound/index.js",
23756 "groupTitle": "Sounds"
23760 "url": "/api/square/details/reports",
23761 "title": "Creates a new Square Detail Report",
23764 "title": "Example usage:",
23765 "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",
23769 "name": "CreateSquare_Detail_Reports",
23770 "group": "Square_Details_Reports",
23778 "field": "uniqueid",
23792 "field": "application",
23806 "field": "project_name",
23813 "field": "callerid",
23819 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23820 "version": "0.0.0",
23821 "filename": "server/api/squareReportDetail/index.js",
23822 "groupTitle": "Square_Details_Reports"
23826 "url": "/api/square/details/reports/{id}",
23827 "title": "Deletes a Square Detail Report",
23830 "title": "Example usage:",
23831 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
23835 "name": "DeleteSquare_Detail_Reports",
23836 "group": "Square_Details_Reports",
23837 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23838 "version": "0.0.0",
23839 "filename": "server/api/squareReportDetail/index.js",
23840 "groupTitle": "Square_Details_Reports"
23844 "url": "/api/square/details/reports/describe",
23845 "title": "Gets table info about Square Detail Reports",
23848 "title": "Example usage:",
23849 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
23853 "name": "DescribeSquare_Detail_Reports",
23854 "group": "Square_Details_Reports",
23855 "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>",
23856 "version": "0.0.0",
23857 "filename": "server/api/squareReportDetail/index.js",
23858 "groupTitle": "Square_Details_Reports"
23862 "url": "/api/square/details/reports",
23863 "title": "Gets a list of Square Detail Reports",
23866 "title": "Example usage:",
23867 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
23871 "name": "GetSquare_Detail_Reports",
23872 "group": "Square_Details_Reports",
23873 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23874 "version": "0.0.0",
23875 "filename": "server/api/squareReportDetail/index.js",
23876 "groupTitle": "Square_Details_Reports"
23880 "url": "/api/square/details/reports/{id}",
23881 "title": "Gets a single Square Detail Report",
23884 "title": "Example usage:",
23885 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
23889 "name": "ShowSquare_Detail_Reports",
23890 "group": "Square_Details_Reports",
23891 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23892 "version": "0.0.0",
23893 "filename": "server/api/squareReportDetail/index.js",
23894 "groupTitle": "Square_Details_Reports"
23898 "url": "/api/square/details/reports/{id}",
23899 "title": "Update an existing Square Detail Report",
23902 "title": "Example usage:",
23903 "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",
23907 "name": "updateSquare_Detail_Reports",
23908 "group": "Square_Details_Reports",
23909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23910 "version": "0.0.0",
23911 "filename": "server/api/squareReportDetail/index.js",
23912 "groupTitle": "Square_Details_Reports"
23916 "url": "/api/square/messages",
23917 "title": "Creates a new Message",
23920 "title": "Example usage:",
23921 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23925 "name": "CreateMessages",
23926 "group": "Square_Messages",
23934 "field": "uniqueid",
23952 "field": "direction",
23958 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23959 "version": "0.0.0",
23960 "filename": "server/api/squareMessage/index.js",
23961 "groupTitle": "Square_Messages"
23965 "url": "/api/square/messages/{id}",
23966 "title": "Deletes a Message",
23969 "title": "Example usage:",
23970 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
23974 "name": "DeleteMessages",
23975 "group": "Square_Messages",
23976 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23977 "version": "0.0.0",
23978 "filename": "server/api/squareMessage/index.js",
23979 "groupTitle": "Square_Messages"
23983 "url": "/api/square/messages",
23984 "title": "Gets a list of Messages",
23987 "title": "Example usage:",
23988 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
23992 "name": "GetMessages",
23993 "group": "Square_Messages",
23994 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23995 "version": "0.0.0",
23996 "filename": "server/api/squareMessage/index.js",
23997 "groupTitle": "Square_Messages"
24001 "url": "/api/square/messages/{id}",
24002 "title": "Gets a single Message",
24005 "title": "Example usage:",
24006 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24010 "name": "ShowMessages",
24011 "group": "Square_Messages",
24012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24013 "version": "0.0.0",
24014 "filename": "server/api/squareMessage/index.js",
24015 "groupTitle": "Square_Messages"
24019 "url": "/api/square/messages/{id}",
24020 "title": "Update an existing Message",
24023 "title": "Example usage:",
24024 "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",
24028 "name": "updateMessages",
24029 "group": "Square_Messages",
24030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24031 "version": "0.0.0",
24032 "filename": "server/api/squareMessage/index.js",
24033 "groupTitle": "Square_Messages"
24037 "url": "/api/square/odbc",
24038 "title": "Creates a new ODBC",
24041 "title": "Example usage:",
24042 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24046 "name": "CreateODBCs",
24047 "group": "Square_ODBC",
24069 "field": "description",
24075 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24076 "version": "0.0.0",
24077 "filename": "server/api/squareOdbc/index.js",
24078 "groupTitle": "Square_ODBC"
24082 "url": "/api/square/odbc/{id}",
24083 "title": "Deletes a ODBC",
24086 "title": "Example usage:",
24087 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24091 "name": "DeleteODBCs",
24092 "group": "Square_ODBC",
24093 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24094 "version": "0.0.0",
24095 "filename": "server/api/squareOdbc/index.js",
24096 "groupTitle": "Square_ODBC"
24100 "url": "/api/square/odbc",
24101 "title": "Gets a list of ODBCs",
24104 "title": "Example usage:",
24105 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24109 "name": "GetODBCs",
24110 "group": "Square_ODBC",
24111 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24112 "version": "0.0.0",
24113 "filename": "server/api/squareOdbc/index.js",
24114 "groupTitle": "Square_ODBC"
24118 "url": "/api/square/odbc/{id}",
24119 "title": "Gets a single ODBC",
24122 "title": "Example usage:",
24123 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24127 "name": "ShowODBCs",
24128 "group": "Square_ODBC",
24129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24130 "version": "0.0.0",
24131 "filename": "server/api/squareOdbc/index.js",
24132 "groupTitle": "Square_ODBC"
24136 "url": "/api/square/odbc/{id}/test",
24137 "title": "Test Odbc",
24140 "title": "Example usage:",
24141 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24146 "group": "Square_ODBC",
24147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24148 "version": "0.0.0",
24149 "filename": "server/api/squareOdbc/index.js",
24150 "groupTitle": "Square_ODBC"
24154 "url": "/api/square/odbc/{id}",
24155 "title": "Update an existing ODBC",
24158 "title": "Example usage:",
24159 "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",
24163 "name": "updateODBCs",
24164 "group": "Square_ODBC",
24165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24166 "version": "0.0.0",
24167 "filename": "server/api/squareOdbc/index.js",
24168 "groupTitle": "Square_ODBC"
24172 "url": "/api/square/projects",
24173 "title": "Creates a new Project",
24176 "title": "Example usage:",
24177 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24181 "name": "CreateProjects",
24182 "group": "Square_Projects",
24197 "field": "description",
24211 "field": "preproduction",
24218 "field": "production",
24224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24225 "version": "0.0.0",
24226 "filename": "server/api/squareProject/index.js",
24227 "groupTitle": "Square_Projects"
24231 "url": "/api/square/projects/{id}",
24232 "title": "Deletes a Project",
24235 "title": "Example usage:",
24236 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24240 "name": "DeleteProjects",
24241 "group": "Square_Projects",
24242 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24243 "version": "0.0.0",
24244 "filename": "server/api/squareProject/index.js",
24245 "groupTitle": "Square_Projects"
24249 "url": "/api/square/projects",
24250 "title": "Gets a list of Projects",
24253 "title": "Example usage:",
24254 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24258 "name": "GetProjects",
24259 "group": "Square_Projects",
24260 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24261 "version": "0.0.0",
24262 "filename": "server/api/squareProject/index.js",
24263 "groupTitle": "Square_Projects"
24267 "url": "/api/square/projects/{id}",
24268 "title": "Gets a single Project",
24271 "title": "Example usage:",
24272 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24276 "name": "ShowProjects",
24277 "group": "Square_Projects",
24278 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24279 "version": "0.0.0",
24280 "filename": "server/api/squareProject/index.js",
24281 "groupTitle": "Square_Projects"
24285 "url": "/api/square/projects/{id}/users",
24286 "title": "Adds user permissions to a Project",
24289 "title": "Example usage:",
24290 "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",
24294 "name": "addUsers",
24295 "group": "Square_Projects",
24296 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24297 "version": "0.0.0",
24298 "filename": "server/api/squareProject/index.js",
24299 "groupTitle": "Square_Projects"
24303 "url": "/api/square/projects/{id}/users",
24304 "title": "Gets users permissions from Project",
24307 "title": "Example usage:",
24308 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24312 "name": "getUsers",
24313 "group": "Square_Projects",
24314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24315 "version": "0.0.0",
24316 "filename": "server/api/squareProject/index.js",
24317 "groupTitle": "Square_Projects"
24321 "url": "/api/square/projects/{id}/users",
24322 "title": "Removes user permissions from a Project",
24325 "title": "Example usage:",
24326 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24330 "name": "removeUsers",
24331 "group": "Square_Projects",
24332 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24333 "version": "0.0.0",
24334 "filename": "server/api/squareProject/index.js",
24335 "groupTitle": "Square_Projects"
24339 "url": "/api/square/projects/{id}",
24340 "title": "Update an existing Project",
24343 "title": "Example usage:",
24344 "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",
24348 "name": "updateProjects",
24349 "group": "Square_Projects",
24350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24351 "version": "0.0.0",
24352 "filename": "server/api/squareProject/index.js",
24353 "groupTitle": "Square_Projects"
24357 "url": "/api/square/recordings",
24358 "title": "Creates a new Recording",
24361 "title": "Example usage:",
24362 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24366 "name": "CreateRecordings",
24367 "group": "Square_Recordings",
24375 "field": "uniqueid",
24382 "field": "callerid",
24389 "field": "calleridname",
24396 "field": "context",
24403 "field": "extension",
24410 "field": "priority",
24417 "field": "accountcode",
24431 "field": "projectName",
24438 "field": "saveName",
24445 "field": "filename",
24452 "field": "savePath",
24465 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24466 "version": "0.0.0",
24467 "filename": "server/api/squareRecording/index.js",
24468 "groupTitle": "Square_Recordings"
24472 "url": "/api/square/recordings",
24473 "title": "Gets a list of Recordings",
24476 "title": "Example usage:",
24477 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24481 "name": "GetRecordings",
24482 "group": "Square_Recordings",
24483 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24484 "version": "0.0.0",
24485 "filename": "server/api/squareRecording/index.js",
24486 "groupTitle": "Square_Recordings"
24490 "url": "/api/square/recordings/{id}",
24491 "title": "Gets a single Recording",
24494 "title": "Example usage:",
24495 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24499 "name": "ShowRecordings",
24500 "group": "Square_Recordings",
24501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24502 "version": "0.0.0",
24503 "filename": "server/api/squareRecording/index.js",
24504 "groupTitle": "Square_Recordings"
24508 "url": "/api/square/recordings/{id}/delete",
24509 "title": "Delete recording",
24512 "title": "Example usage:",
24513 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24518 "group": "Square_Recordings",
24519 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24520 "version": "0.0.0",
24521 "filename": "server/api/squareRecording/index.js",
24522 "groupTitle": "Square_Recordings"
24526 "url": "/api/square/recordings/{id}/download",
24527 "title": "Download Recording",
24530 "title": "Example usage:",
24531 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24535 "name": "download",
24536 "group": "Square_Recordings",
24537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24538 "version": "0.0.0",
24539 "filename": "server/api/squareRecording/index.js",
24540 "groupTitle": "Square_Recordings"
24544 "url": "/api/square/recordings/{id}",
24545 "title": "Update an existing Recording",
24548 "title": "Example usage:",
24549 "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",
24553 "name": "updateRecordings",
24554 "group": "Square_Recordings",
24555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24556 "version": "0.0.0",
24557 "filename": "server/api/squareRecording/index.js",
24558 "groupTitle": "Square_Recordings"
24562 "url": "/api/square/reports",
24563 "title": "Creates a new Square Report",
24566 "title": "Example usage:",
24567 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24571 "name": "CreateSquare_Reports",
24572 "group": "Square_Reports",
24580 "field": "network",
24587 "field": "network_script",
24594 "field": "request",
24601 "field": "channel",
24608 "field": "language",
24622 "field": "uniqueid",
24629 "field": "version",
24636 "field": "callerid",
24643 "field": "calleridname",
24650 "field": "callingpres",
24657 "field": "callingani2",
24664 "field": "callington",
24671 "field": "callingtns",
24692 "field": "context",
24699 "field": "extension",
24706 "field": "priority",
24713 "field": "enhanced",
24720 "field": "accountcode",
24727 "field": "threadid",
24734 "field": "project_name",
24748 "field": "leaveAt",
24761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24762 "version": "0.0.0",
24763 "filename": "server/api/squareReport/index.js",
24764 "groupTitle": "Square_Reports"
24768 "url": "/api/square/reports/{id}",
24769 "title": "Deletes a Square Report",
24772 "title": "Example usage:",
24773 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
24777 "name": "DeleteSquare_Reports",
24778 "group": "Square_Reports",
24779 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24780 "version": "0.0.0",
24781 "filename": "server/api/squareReport/index.js",
24782 "groupTitle": "Square_Reports"
24786 "url": "/api/square/reports/describe",
24787 "title": "Gets table info about Square Reports",
24790 "title": "Example usage:",
24791 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
24795 "name": "DescribeSquare_Reports",
24796 "group": "Square_Reports",
24797 "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>",
24798 "version": "0.0.0",
24799 "filename": "server/api/squareReport/index.js",
24800 "groupTitle": "Square_Reports"
24804 "url": "/api/square/reports",
24805 "title": "Gets a list of Square Reports",
24808 "title": "Example usage:",
24809 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
24813 "name": "GetSquare_Reports",
24814 "group": "Square_Reports",
24815 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24816 "version": "0.0.0",
24817 "filename": "server/api/squareReport/index.js",
24818 "groupTitle": "Square_Reports"
24822 "url": "/api/square/reports/{id}",
24823 "title": "Gets a single Square Report",
24826 "title": "Example usage:",
24827 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
24831 "name": "ShowSquare_Reports",
24832 "group": "Square_Reports",
24833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24834 "version": "0.0.0",
24835 "filename": "server/api/squareReport/index.js",
24836 "groupTitle": "Square_Reports"
24840 "url": "/api/square/reports/{id}",
24841 "title": "Update an existing Square Report",
24844 "title": "Example usage:",
24845 "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",
24849 "name": "updateSquare_Reports",
24850 "group": "Square_Reports",
24851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24852 "version": "0.0.0",
24853 "filename": "server/api/squareReport/index.js",
24854 "groupTitle": "Square_Reports"
24858 "url": "/api/integrations/sugarcrm/configurations",
24859 "title": "Creates a new SugarCRM Configuration",
24862 "title": "Example usage:",
24863 "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",
24867 "name": "CreateSugarCRM_Configurations",
24868 "group": "SugarCRM_Configurations",
24883 "field": "description",
24889 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24890 "version": "0.0.0",
24891 "filename": "server/api/intSugarcrmConfiguration/index.js",
24892 "groupTitle": "SugarCRM_Configurations"
24896 "url": "/api/integrations/sugarcrm/configurations/{id}",
24897 "title": "Deletes a SugarCRM Configuration",
24900 "title": "Example usage:",
24901 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
24905 "name": "DeleteSugarCRM_Configurations",
24906 "group": "SugarCRM_Configurations",
24907 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24908 "version": "0.0.0",
24909 "filename": "server/api/intSugarcrmConfiguration/index.js",
24910 "groupTitle": "SugarCRM_Configurations"
24914 "url": "/api/integrations/sugarcrm/configurations",
24915 "title": "Gets a list of SugarCRM Configurations",
24918 "title": "Example usage:",
24919 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
24923 "name": "GetSugarCRM_Configurations",
24924 "group": "SugarCRM_Configurations",
24925 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24926 "version": "0.0.0",
24927 "filename": "server/api/intSugarcrmConfiguration/index.js",
24928 "groupTitle": "SugarCRM_Configurations"
24932 "url": "/api/integrations/sugarcrm/configurations/{id}",
24933 "title": "Gets a single SugarCRM Configuration",
24936 "title": "Example usage:",
24937 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
24941 "name": "ShowSugarCRM_Configurations",
24942 "group": "SugarCRM_Configurations",
24943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24944 "version": "0.0.0",
24945 "filename": "server/api/intSugarcrmConfiguration/index.js",
24946 "groupTitle": "SugarCRM_Configurations"
24950 "url": "/api/integrations/sugarcrm/configurations/{id}",
24951 "title": "Update an existing SugarCRM Configuration",
24954 "title": "Example usage:",
24955 "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",
24959 "name": "updateSugarCRM_Configurations",
24960 "group": "SugarCRM_Configurations",
24961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24962 "version": "0.0.0",
24963 "filename": "server/api/intSugarcrmConfiguration/index.js",
24964 "groupTitle": "SugarCRM_Configurations"
24968 "url": "/api/integrations/sugarcrm/accounts",
24969 "title": "Creates a new Sugarcrm Account",
24972 "title": "Example usage:",
24973 "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",
24977 "name": "CreateSugarcrm_Accounts",
24978 "group": "Sugarcrm_Accounts",
24993 "field": "description",
25000 "field": "username",
25007 "field": "password",
25014 "field": "remoteUri",
25021 "field": "serverUrl",
25027 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25028 "version": "0.0.0",
25029 "filename": "server/api/intSugarcrmAccount/index.js",
25030 "groupTitle": "Sugarcrm_Accounts"
25034 "url": "/api/integrations/sugarcrm/accounts/{id}",
25035 "title": "Deletes a Sugarcrm Account",
25038 "title": "Example usage:",
25039 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25043 "name": "DeleteSugarcrm_Accounts",
25044 "group": "Sugarcrm_Accounts",
25045 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25046 "version": "0.0.0",
25047 "filename": "server/api/intSugarcrmAccount/index.js",
25048 "groupTitle": "Sugarcrm_Accounts"
25052 "url": "/api/integrations/sugarcrm/accounts",
25053 "title": "Gets a list of Sugarcrm Accounts",
25056 "title": "Example usage:",
25057 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25061 "name": "GetSugarcrm_Accounts",
25062 "group": "Sugarcrm_Accounts",
25063 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25064 "version": "0.0.0",
25065 "filename": "server/api/intSugarcrmAccount/index.js",
25066 "groupTitle": "Sugarcrm_Accounts"
25070 "url": "/api/integrations/sugarcrm/accounts/{id}",
25071 "title": "Gets a single Sugarcrm Account",
25074 "title": "Example usage:",
25075 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25079 "name": "ShowSugarcrm_Accounts",
25080 "group": "Sugarcrm_Accounts",
25081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25082 "version": "0.0.0",
25083 "filename": "server/api/intSugarcrmAccount/index.js",
25084 "groupTitle": "Sugarcrm_Accounts"
25088 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25089 "title": "Creates new configuration",
25092 "title": "Example usage:",
25093 "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",
25097 "name": "addConfiguration",
25098 "group": "Sugarcrm_Accounts",
25099 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25100 "version": "0.0.0",
25101 "filename": "server/api/intSugarcrmAccount/index.js",
25102 "groupTitle": "Sugarcrm_Accounts"
25106 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25107 "title": "Gets account configurations",
25110 "title": "Example usage:",
25111 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25115 "name": "getConfigurations",
25116 "group": "Sugarcrm_Accounts",
25117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25118 "version": "0.0.0",
25119 "filename": "server/api/intSugarcrmAccount/index.js",
25120 "groupTitle": "Sugarcrm_Accounts"
25124 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25125 "title": "Gets account fields",
25128 "title": "Example usage:",
25129 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25133 "name": "getFields",
25134 "group": "Sugarcrm_Accounts",
25135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25136 "version": "0.0.0",
25137 "filename": "server/api/intSugarcrmAccount/index.js",
25138 "groupTitle": "Sugarcrm_Accounts"
25142 "url": "/api/integrations/sugarcrm/accounts/{id}",
25143 "title": "Update an existing Sugarcrm Account",
25146 "title": "Example usage:",
25147 "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",
25151 "name": "updateSugarcrm_Accounts",
25152 "group": "Sugarcrm_Accounts",
25153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25154 "version": "0.0.0",
25155 "filename": "server/api/intSugarcrmAccount/index.js",
25156 "groupTitle": "Sugarcrm_Accounts"
25160 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25161 "title": "Gets configurations descriptions",
25164 "title": "Example usage:",
25165 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25169 "name": "getDescriptions",
25170 "group": "Sugarcrm_Configurations",
25171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25172 "version": "0.0.0",
25173 "filename": "server/api/intSugarcrmConfiguration/index.js",
25174 "groupTitle": "Sugarcrm_Configurations"
25178 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25179 "title": "Gets configurations fields",
25182 "title": "Example usage:",
25183 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25187 "name": "getFields",
25188 "group": "Sugarcrm_Configurations",
25189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25190 "version": "0.0.0",
25191 "filename": "server/api/intSugarcrmConfiguration/index.js",
25192 "groupTitle": "Sugarcrm_Configurations"
25196 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25197 "title": "Gets configurations subjects",
25200 "title": "Example usage:",
25201 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25205 "name": "getSubjects",
25206 "group": "Sugarcrm_Configurations",
25207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25208 "version": "0.0.0",
25209 "filename": "server/api/intSugarcrmConfiguration/index.js",
25210 "groupTitle": "Sugarcrm_Configurations"
25214 "url": "/api/integrations/sugarcrm/fields",
25215 "title": "Creates a new Sugarcrm Field",
25218 "title": "Example usage:",
25219 "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",
25223 "name": "CreateSugarcrm_Fields",
25224 "group": "Sugarcrm_Fields",
25234 "\"customVariable\"",
25245 "field": "content",
25261 "\"customVariable\""
25264 "field": "keyType",
25271 "field": "keyContent",
25278 "field": "idField",
25285 "field": "nameField",
25292 "field": "customField",
25299 "field": "variableName",
25305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25306 "version": "0.0.0",
25307 "filename": "server/api/intSugarcrmField/index.js",
25308 "groupTitle": "Sugarcrm_Fields"
25312 "url": "/api/integrations/sugarcrm/fields/{id}",
25313 "title": "Deletes a Sugarcrm Field",
25316 "title": "Example usage:",
25317 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25321 "name": "DeleteSugarcrm_Fields",
25322 "group": "Sugarcrm_Fields",
25323 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25324 "version": "0.0.0",
25325 "filename": "server/api/intSugarcrmField/index.js",
25326 "groupTitle": "Sugarcrm_Fields"
25330 "url": "/api/integrations/sugarcrm/fields",
25331 "title": "Gets a list of Sugarcrm Fields",
25334 "title": "Example usage:",
25335 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25339 "name": "GetSugarcrm_Fields",
25340 "group": "Sugarcrm_Fields",
25341 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25342 "version": "0.0.0",
25343 "filename": "server/api/intSugarcrmField/index.js",
25344 "groupTitle": "Sugarcrm_Fields"
25348 "url": "/api/integrations/sugarcrm/fields/{id}",
25349 "title": "Gets a single Sugarcrm Field",
25352 "title": "Example usage:",
25353 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25357 "name": "ShowSugarcrm_Fields",
25358 "group": "Sugarcrm_Fields",
25359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25360 "version": "0.0.0",
25361 "filename": "server/api/intSugarcrmField/index.js",
25362 "groupTitle": "Sugarcrm_Fields"
25366 "url": "/api/integrations/sugarcrm/fields/{id}",
25367 "title": "Update an existing Sugarcrm Field",
25370 "title": "Example usage:",
25371 "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",
25375 "name": "updateSugarcrm_Fields",
25376 "group": "Sugarcrm_Fields",
25377 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25378 "version": "0.0.0",
25379 "filename": "server/api/intSugarcrmField/index.js",
25380 "groupTitle": "Sugarcrm_Fields"
25384 "url": "/api/system",
25385 "title": "Gets system information",
25388 "title": "Example usage:",
25389 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25393 "name": "GetSystemInformation",
25394 "group": "System_Information",
25395 "description": "<p>Motion returns the system information.</p>",
25396 "version": "0.0.0",
25397 "filename": "server/api/system/index.js",
25398 "groupTitle": "System_Information"
25402 "url": "/api/system/process",
25403 "title": "Gets system information",
25406 "title": "Example usage:",
25407 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25411 "name": "GetSystemInformation",
25412 "group": "System_Information",
25413 "description": "<p>Motion returns the system information.</p>",
25414 "version": "0.0.0",
25415 "filename": "server/api/system/index.js",
25416 "groupTitle": "System_Information"
25420 "url": "/api/tags",
25421 "title": "Creates a new Tag",
25424 "title": "Example usage:",
25425 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25429 "name": "CreateTags",
25452 "field": "description",
25458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25459 "version": "0.0.0",
25460 "filename": "server/api/tag/index.js",
25461 "groupTitle": "Tags"
25465 "url": "/api/tags/{id}",
25466 "title": "Deletes a Tag",
25469 "title": "Example usage:",
25470 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25474 "name": "DeleteTags",
25476 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25477 "version": "0.0.0",
25478 "filename": "server/api/tag/index.js",
25479 "groupTitle": "Tags"
25483 "url": "/api/tags",
25484 "title": "Gets a list of Tags",
25487 "title": "Example usage:",
25488 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25494 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25495 "version": "0.0.0",
25496 "filename": "server/api/tag/index.js",
25497 "groupTitle": "Tags"
25501 "url": "/api/tags/{id}",
25502 "title": "Gets a single Tag",
25505 "title": "Example usage:",
25506 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25510 "name": "ShowTags",
25512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25513 "version": "0.0.0",
25514 "filename": "server/api/tag/index.js",
25515 "groupTitle": "Tags"
25519 "url": "/api/tags/{id}",
25520 "title": "Update an existing Tag",
25523 "title": "Example usage:",
25524 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25528 "name": "updateTags",
25530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25531 "version": "0.0.0",
25532 "filename": "server/api/tag/index.js",
25533 "groupTitle": "Tags"
25537 "url": "/api/teams/{id}/queues",
25538 "title": "Add queues to a team",
25541 "title": "Example usage:",
25542 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25546 "name": "AddQueues",
25548 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25549 "version": "0.0.0",
25550 "filename": "server/api/team/index.js",
25551 "groupTitle": "Teams"
25555 "url": "/api/teams",
25556 "title": "Creates a new Team",
25559 "title": "Example usage:",
25560 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25564 "name": "CreateTeams",
25580 "field": "description",
25586 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25587 "version": "0.0.0",
25588 "filename": "server/api/team/index.js",
25589 "groupTitle": "Teams"
25593 "url": "/api/teams/{id}",
25594 "title": "Deletes a Team",
25597 "title": "Example usage:",
25598 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25602 "name": "DeleteTeams",
25604 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25605 "version": "0.0.0",
25606 "filename": "server/api/team/index.js",
25607 "groupTitle": "Teams"
25611 "url": "/api/teams/{id}/users",
25612 "title": "Gets agents from team",
25615 "title": "Example usage:",
25616 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25620 "name": "GetAgents",
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/team/index.js",
25625 "groupTitle": "Teams"
25629 "url": "/api/teams/{id}/queues?channel={channel}",
25630 "title": "Gets Queues list",
25633 "title": "Example usage:",
25634 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
25638 "name": "GetQueues",
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/team/index.js",
25643 "groupTitle": "Teams"
25647 "url": "/api/teams",
25648 "title": "Gets a list of Teams",
25651 "title": "Example usage:",
25652 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
25656 "name": "GetTeams",
25658 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25659 "version": "0.0.0",
25660 "filename": "server/api/team/index.js",
25661 "groupTitle": "Teams"
25665 "url": "/api/teams/{id}/users",
25666 "title": "Removes agents from a team",
25669 "title": "Example usage:",
25670 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25674 "name": "RemoveAgents",
25676 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25677 "version": "0.0.0",
25678 "filename": "server/api/team/index.js",
25679 "groupTitle": "Teams"
25683 "url": "/api/teams/{id}/queues",
25684 "title": "Remove queues to a team",
25687 "title": "Example usage:",
25688 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25692 "name": "RemoveQueues",
25694 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25695 "version": "0.0.0",
25696 "filename": "server/api/team/index.js",
25697 "groupTitle": "Teams"
25701 "url": "/api/mail/queues/{id}/teams",
25702 "title": "Remove teams from a queue",
25705 "title": "Example usage:",
25706 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25710 "name": "RemoveTeams",
25712 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25713 "version": "0.0.0",
25714 "filename": "server/api/mailQueue/index.js",
25715 "groupTitle": "Teams"
25719 "url": "/api/openchannel/queues/{id}/teams",
25720 "title": "Remove teams from a queue",
25723 "title": "Example usage:",
25724 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25728 "name": "RemoveTeams",
25730 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25731 "version": "0.0.0",
25732 "filename": "server/api/openchannelQueue/index.js",
25733 "groupTitle": "Teams"
25737 "url": "/api/whatsapp/queues/{id}/teams",
25738 "title": "Remove teams from a queue",
25741 "title": "Example usage:",
25742 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25746 "name": "RemoveTeams",
25748 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25749 "version": "0.0.0",
25750 "filename": "server/api/whatsappQueue/index.js",
25751 "groupTitle": "Teams"
25755 "url": "/api/sms/queues/{id}/teams",
25756 "title": "Remove teams from a queue",
25759 "title": "Example usage:",
25760 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25764 "name": "RemoveTeams",
25766 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25767 "version": "0.0.0",
25768 "filename": "server/api/smsQueue/index.js",
25769 "groupTitle": "Teams"
25773 "url": "/api/voice/queues/{id}/teams",
25774 "title": "Remove teams from a queue",
25777 "title": "Example usage:",
25778 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25782 "name": "RemoveTeams",
25784 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25785 "version": "0.0.0",
25786 "filename": "server/api/voiceQueue/index.js",
25787 "groupTitle": "Teams"
25791 "url": "/api/chat/queues/{id}/teams",
25792 "title": "Remove teams from a queue",
25795 "title": "Example usage:",
25796 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25800 "name": "RemoveTeams",
25802 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25803 "version": "0.0.0",
25804 "filename": "server/api/chatQueue/index.js",
25805 "groupTitle": "Teams"
25809 "url": "/api/fax/queues/{id}/teams",
25810 "title": "Remove teams from a queue",
25813 "title": "Example usage:",
25814 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25818 "name": "RemoveTeams",
25820 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25821 "version": "0.0.0",
25822 "filename": "server/api/faxQueue/index.js",
25823 "groupTitle": "Teams"
25827 "url": "/api/teams/{id}",
25828 "title": "Gets a single Team",
25831 "title": "Example usage:",
25832 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
25836 "name": "ShowTeams",
25838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25839 "version": "0.0.0",
25840 "filename": "server/api/team/index.js",
25841 "groupTitle": "Teams"
25845 "url": "/api/teams/{id}/users",
25846 "title": "Adds agents to a team",
25849 "title": "Example usage:",
25850 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25854 "name": "addAgents",
25856 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25857 "version": "0.0.0",
25858 "filename": "server/api/team/index.js",
25859 "groupTitle": "Teams"
25863 "url": "/api/teams/{id}",
25864 "title": "Update an existing Team",
25867 "title": "Example usage:",
25868 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25872 "name": "updateTeams",
25874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25875 "version": "0.0.0",
25876 "filename": "server/api/team/index.js",
25877 "groupTitle": "Teams"
25881 "url": "/api/templates",
25882 "title": "Creates a new Template",
25885 "title": "Example usage:",
25886 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25890 "name": "CreateTemplates",
25891 "group": "Templates",
25906 "field": "description",
25919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25920 "version": "0.0.0",
25921 "filename": "server/api/template/index.js",
25922 "groupTitle": "Templates"
25926 "url": "/api/templates/{id}",
25927 "title": "Deletes a Template",
25930 "title": "Example usage:",
25931 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
25935 "name": "DeleteTemplates",
25936 "group": "Templates",
25937 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25938 "version": "0.0.0",
25939 "filename": "server/api/template/index.js",
25940 "groupTitle": "Templates"
25944 "url": "/api/templates",
25945 "title": "Gets a list of Templates",
25948 "title": "Example usage:",
25949 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
25953 "name": "GetTemplates",
25954 "group": "Templates",
25955 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25956 "version": "0.0.0",
25957 "filename": "server/api/template/index.js",
25958 "groupTitle": "Templates"
25962 "url": "/api/templates/{id}",
25963 "title": "Gets a single Template",
25966 "title": "Example usage:",
25967 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
25971 "name": "ShowTemplates",
25972 "group": "Templates",
25973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25974 "version": "0.0.0",
25975 "filename": "server/api/template/index.js",
25976 "groupTitle": "Templates"
25980 "url": "/api/templates/{id}",
25981 "title": "Update an existing Template",
25984 "title": "Example usage:",
25985 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25989 "name": "updateTemplates",
25990 "group": "Templates",
25991 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25992 "version": "0.0.0",
25993 "filename": "server/api/template/index.js",
25994 "groupTitle": "Templates"
25998 "url": "/api/triggers",
25999 "title": "Creates a new Trigger",
26002 "title": "Example usage:",
26003 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26007 "name": "CreateTriggers",
26008 "group": "Triggers",
26023 "field": "channel",
26030 "field": "description",
26043 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26044 "version": "0.0.0",
26045 "filename": "server/api/trigger/index.js",
26046 "groupTitle": "Triggers"
26050 "url": "/api/triggers/{id}",
26051 "title": "Deletes a Trigger",
26054 "title": "Example usage:",
26055 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26059 "name": "DeleteTriggers",
26060 "group": "Triggers",
26061 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26062 "version": "0.0.0",
26063 "filename": "server/api/trigger/index.js",
26064 "groupTitle": "Triggers"
26068 "url": "/api/triggers",
26069 "title": "Gets a list of Triggers",
26072 "title": "Example usage:",
26073 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26077 "name": "GetTriggers",
26078 "group": "Triggers",
26079 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26080 "version": "0.0.0",
26081 "filename": "server/api/trigger/index.js",
26082 "groupTitle": "Triggers"
26086 "url": "/api/triggers/{id}",
26087 "title": "Gets a single Trigger",
26090 "title": "Example usage:",
26091 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26095 "name": "ShowTriggers",
26096 "group": "Triggers",
26097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26098 "version": "0.0.0",
26099 "filename": "server/api/trigger/index.js",
26100 "groupTitle": "Triggers"
26104 "url": "/api/triggers/{id}/actions",
26105 "title": "Creates new actions",
26108 "title": "Example usage:",
26109 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26113 "name": "addAction",
26114 "group": "Triggers",
26130 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26137 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26144 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26151 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26185 "version": "0.0.0",
26186 "filename": "server/api/trigger/index.js",
26187 "groupTitle": "Triggers"
26191 "url": "/api/triggers/{id}/all_conditions",
26192 "title": "Creates a new \"AND\"condition",
26195 "title": "Example usage:",
26196 "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",
26200 "name": "addAllCondition",
26201 "group": "Triggers",
26223 "field": "operator",
26236 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26237 "version": "0.0.0",
26238 "filename": "server/api/trigger/index.js",
26239 "groupTitle": "Triggers"
26243 "url": "/api/triggers/{id}/any_conditions",
26244 "title": "Creates a new \"OR\"condition",
26247 "title": "Example usage:",
26248 "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",
26252 "name": "addAnyCondition",
26253 "group": "Triggers",
26275 "field": "operator",
26288 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26289 "version": "0.0.0",
26290 "filename": "server/api/trigger/index.js",
26291 "groupTitle": "Triggers"
26295 "url": "/api/triggers/{id}/actions",
26296 "title": "Gets Trigger Actions",
26299 "title": "Example usage:",
26300 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26304 "name": "getActions",
26305 "group": "Triggers",
26306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/all_conditions",
26314 "title": "Gets \"AND\" Trigger Conditions",
26317 "title": "Example usage:",
26318 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26322 "name": "getAllConditions",
26323 "group": "Triggers",
26324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/{id}/any_conditions",
26332 "title": "Gets \"OR\" Trigger Conditions",
26335 "title": "Example usage:",
26336 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26340 "name": "getAnyConditions",
26341 "group": "Triggers",
26342 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26343 "version": "0.0.0",
26344 "filename": "server/api/trigger/index.js",
26345 "groupTitle": "Triggers"
26349 "url": "/api/triggers/{id}",
26350 "title": "Update an existing Trigger",
26353 "title": "Example usage:",
26354 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26358 "name": "updateTriggers",
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/trunks/clone",
26368 "title": "Clone an existing Trunk",
26371 "title": "Example usage:",
26372 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26376 "name": "CloneTrunks",
26378 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26379 "version": "0.0.0",
26380 "filename": "server/api/trunk/index.js",
26381 "groupTitle": "Trunks"
26385 "url": "/api/trunks",
26386 "title": "Create a new trunk",
26389 "title": "Example usage:",
26390 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26422 "field": "context",
26429 "\"ALLOWED_NOT_SCREENED\"",
26430 "\"ALLOWED_PASSED_SCREEN\"",
26431 "\"ALLOWED_FAILED_SCREEN\"",
26433 "\"PROHIB_NOT_SCREENED\"",
26434 "\"PROHIB_PASSED_SCREEN\"",
26435 "\"PROHIB_FAILED_SCREEN\"",
26439 "field": "callingpres",
26467 "field": "md5secret",
26474 "field": "remotesecret",
26481 "field": "transport",
26482 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26495 "field": "dtmfmode",
26509 "field": "directmedia",
26520 "field": "directrtpsetup",
26527 "field": "directmediapermit",
26534 "field": "directmediadeny",
26542 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
26548 "field": "callgroup",
26555 "field": "namedcallgroup",
26562 "field": "pickupgroup",
26569 "field": "namedpickupgroup",
26576 "field": "language",
26583 "field": "tonezone",
26590 "field": "disallow",
26598 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
26608 "field": "autoframing",
26615 "field": "insecure",
26616 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
26626 "field": "trustrpid",
26637 "field": "trust_id_outbound",
26649 "field": "progressinband",
26660 "field": "promiscredir",
26671 "field": "useclientcode",
26678 "field": "accountcode",
26692 "field": "callerid",
26699 "field": "amaflags",
26710 "field": "callcounter",
26717 "field": "busylevel",
26728 "field": "allowoverlap",
26739 "field": "allowsubscribe",
26750 "field": "allowtransfer",
26761 "field": "ignoresdpversion",
26768 "field": "subscribecontext",
26775 "field": "template",
26787 "field": "videosupport",
26794 "field": "maxcallbitrate",
26805 "field": "rfc2833compensate",
26812 "field": "mailbox",
26824 "field": "session_timers",
26831 "field": "session_expires",
26838 "field": "session_minse",
26849 "field": "session_refresher",
26856 "field": "t38pt_usertpsource",
26863 "field": "regexten",
26870 "field": "fromdomain",
26877 "field": "fromuser",
26895 "field": "qualify",
26902 "field": "keepalive",
26909 "field": "defaultip",
26916 "field": "defaultuser",
26923 "field": "rtptimeout",
26930 "field": "rtpholdtimeout",
26937 "field": "rtpkeepalive",
26949 "field": "sendrpid",
26956 "field": "outboundproxy",
26963 "field": "callbackextension",
26970 "field": "timert1",
26984 "field": "qualifyfreq",
26991 "field": "contactpermit",
26998 "field": "contactdeny",
27005 "field": "contactacl",
27012 "field": "unsolicited_mailbox",
27019 "field": "use_q850_reason",
27026 "field": "maxforwards",
27037 "field": "encryption",
27059 "field": "force_avp",
27070 "field": "icesupport",
27081 "field": "dtlsenable",
27094 "field": "dtlsverify",
27101 "field": "dtlsrekey",
27108 "field": "dtlscertfile",
27115 "field": "dtlsprivatekey",
27122 "field": "dtlscipher",
27129 "field": "dtlscafile",
27136 "field": "dtlscapath",
27148 "field": "dtlssetup",
27155 "field": "dtlsfingerprint",
27166 "field": "usereqphone",
27173 "field": "recordonfeature",
27180 "field": "recordofffeature",
27187 "field": "call_limit",
27198 "field": "registertrying",
27209 "field": "subscribemwi",
27216 "field": "vmexten",
27223 "field": "mohinterpret",
27230 "field": "mohsuggest",
27237 "field": "parkinglot",
27244 "field": "description",
27265 "field": "canreinvite",
27272 "field": "registry",
27279 "field": "otherFields",
27293 "field": "t38pt_udptl",
27299 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27300 "version": "0.0.0",
27301 "filename": "server/api/trunk/index.js",
27302 "groupTitle": "Trunks"
27306 "url": "/api/trunks/{id}",
27307 "title": "Deletes a trunk",
27310 "title": "Example usage:",
27311 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27317 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27318 "version": "0.0.0",
27319 "filename": "server/api/trunk/index.js",
27320 "groupTitle": "Trunks"
27324 "url": "/api/trunks",
27325 "title": "Gets a list of Trunks",
27328 "title": "Example usage:",
27329 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27333 "name": "GetTrunks",
27335 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27336 "version": "0.0.0",
27337 "filename": "server/api/trunk/index.js",
27338 "groupTitle": "Trunks"
27342 "url": "/api/trunks/{id}",
27343 "title": "Gets a single Trunk",
27346 "title": "Example usage:",
27347 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27351 "name": "ShowTrunks",
27353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27354 "version": "0.0.0",
27355 "filename": "server/api/trunk/index.js",
27356 "groupTitle": "Trunks"
27360 "url": "/api/trunks/{id}",
27361 "title": "Update an existing trunk",
27364 "title": "Example usage:",
27365 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27372 "version": "0.0.0",
27373 "filename": "server/api/trunk/index.js",
27374 "groupTitle": "Trunks"
27378 "url": "/api/userProfile/resources",
27379 "title": "Creates a new User Profile Resource",
27382 "title": "Example usage:",
27383 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27387 "name": "CreateUser_Profile_Resources",
27388 "group": "User_Profile_Resources",
27403 "field": "resourceId",
27416 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27417 "version": "0.0.0",
27418 "filename": "server/api/userProfileResource/index.js",
27419 "groupTitle": "User_Profile_Resources"
27423 "url": "/api/userProfile/resources/{id}",
27424 "title": "Deletes a User Profile Resource",
27427 "title": "Example usage:",
27428 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27432 "name": "DeleteUser_Profile_Resources",
27433 "group": "User_Profile_Resources",
27434 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27435 "version": "0.0.0",
27436 "filename": "server/api/userProfileResource/index.js",
27437 "groupTitle": "User_Profile_Resources"
27441 "url": "/api/userProfile/resources/describe",
27442 "title": "Gets table info about User Profile Resources",
27445 "title": "Example usage:",
27446 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27450 "name": "DescribeUser_Profile_Resources",
27451 "group": "User_Profile_Resources",
27452 "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>",
27453 "version": "0.0.0",
27454 "filename": "server/api/userProfileResource/index.js",
27455 "groupTitle": "User_Profile_Resources"
27459 "url": "/api/userProfile/resources",
27460 "title": "Gets a list of User Profile Resources",
27463 "title": "Example usage:",
27464 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27468 "name": "GetUser_Profile_Resources",
27469 "group": "User_Profile_Resources",
27470 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27471 "version": "0.0.0",
27472 "filename": "server/api/userProfileResource/index.js",
27473 "groupTitle": "User_Profile_Resources"
27477 "url": "/api/userProfile/resources/{id}",
27478 "title": "Gets a single User Profile Resource",
27481 "title": "Example usage:",
27482 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27486 "name": "ShowUser_Profile_Resources",
27487 "group": "User_Profile_Resources",
27488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27489 "version": "0.0.0",
27490 "filename": "server/api/userProfileResource/index.js",
27491 "groupTitle": "User_Profile_Resources"
27495 "url": "/api/userProfile/resources/{id}",
27496 "title": "Update an existing User Profile Resource",
27499 "title": "Example usage:",
27500 "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",
27504 "name": "updateUser_Profile_Resources",
27505 "group": "User_Profile_Resources",
27506 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27507 "version": "0.0.0",
27508 "filename": "server/api/userProfileResource/index.js",
27509 "groupTitle": "User_Profile_Resources"
27513 "url": "/api/userProfile/sections",
27514 "title": "Creates a new User Profile Section",
27517 "title": "Example usage:",
27518 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27522 "name": "CreateUser_Profile_Sections",
27523 "group": "User_Profile_Sections",
27538 "field": "category",
27545 "field": "sectionId",
27552 "field": "enabled",
27559 "field": "autoAssociation",
27566 "field": "crudPermissions",
27572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27573 "version": "0.0.0",
27574 "filename": "server/api/userProfileSection/index.js",
27575 "groupTitle": "User_Profile_Sections"
27579 "url": "/api/userProfile/sections/{id}",
27580 "title": "Deletes a User Profile Section",
27583 "title": "Example usage:",
27584 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27588 "name": "DeleteUser_Profile_Sections",
27589 "group": "User_Profile_Sections",
27590 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27591 "version": "0.0.0",
27592 "filename": "server/api/userProfileSection/index.js",
27593 "groupTitle": "User_Profile_Sections"
27597 "url": "/api/userProfile/sections/describe",
27598 "title": "Gets table info about User Profile Sections",
27601 "title": "Example usage:",
27602 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27606 "name": "DescribeUser_Profile_Sections",
27607 "group": "User_Profile_Sections",
27608 "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>",
27609 "version": "0.0.0",
27610 "filename": "server/api/userProfileSection/index.js",
27611 "groupTitle": "User_Profile_Sections"
27615 "url": "/api/userProfile/sections",
27616 "title": "Gets a list of User Profile Sections",
27619 "title": "Example usage:",
27620 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
27624 "name": "GetUser_Profile_Sections",
27625 "group": "User_Profile_Sections",
27626 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27627 "version": "0.0.0",
27628 "filename": "server/api/userProfileSection/index.js",
27629 "groupTitle": "User_Profile_Sections"
27633 "url": "/api/userProfile/sections/{id}",
27634 "title": "Gets a single User Profile Section",
27637 "title": "Example usage:",
27638 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
27642 "name": "ShowUser_Profile_Sections",
27643 "group": "User_Profile_Sections",
27644 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27645 "version": "0.0.0",
27646 "filename": "server/api/userProfileSection/index.js",
27647 "groupTitle": "User_Profile_Sections"
27651 "url": "/api/userProfile/sections/{id}",
27652 "title": "Update an existing User Profile Section",
27655 "title": "Example usage:",
27656 "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",
27660 "name": "updateUser_Profile_Sections",
27661 "group": "User_Profile_Sections",
27662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27663 "version": "0.0.0",
27664 "filename": "server/api/userProfileSection/index.js",
27665 "groupTitle": "User_Profile_Sections"
27669 "url": "/api/userProfiles/{id}/resources",
27670 "title": "Add resources' permissions to User Profile",
27673 "title": "Example usage:",
27674 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27678 "name": "AddResources",
27679 "group": "User_Profiles",
27680 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27681 "version": "0.0.0",
27682 "filename": "server/api/userProfile/index.js",
27683 "groupTitle": "User_Profiles"
27687 "url": "/api/userProfiles/{id}/sections",
27688 "title": "Add sections' permissions to User Profile",
27691 "title": "Example usage:",
27692 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27696 "name": "AddSections",
27697 "group": "User_Profiles",
27698 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27699 "version": "0.0.0",
27700 "filename": "server/api/userProfile/index.js",
27701 "groupTitle": "User_Profiles"
27705 "url": "/api/userProfiles/clone",
27706 "title": "Clone an existing User Profile",
27709 "title": "Example usage:",
27710 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27714 "name": "CloneUser_Profiles",
27715 "group": "User_Profiles",
27716 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27717 "version": "0.0.0",
27718 "filename": "server/api/userProfile/index.js",
27719 "groupTitle": "User_Profiles"
27723 "url": "/api/userProfiles",
27724 "title": "Creates a new User Profile",
27727 "title": "Example usage:",
27728 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27732 "name": "CreateUser_Profiles",
27733 "group": "User_Profiles",
27748 "field": "crudPermissions",
27755 "field": "description",
27761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27762 "version": "0.0.0",
27763 "filename": "server/api/userProfile/index.js",
27764 "groupTitle": "User_Profiles"
27768 "url": "/api/userProfiles/{id}",
27769 "title": "Deletes a User Profile",
27772 "title": "Example usage:",
27773 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
27777 "name": "DeleteUser_Profiles",
27778 "group": "User_Profiles",
27779 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27780 "version": "0.0.0",
27781 "filename": "server/api/userProfile/index.js",
27782 "groupTitle": "User_Profiles"
27786 "url": "/api/userProfiles/describe",
27787 "title": "Gets table info about User Profiles",
27790 "title": "Example usage:",
27791 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
27795 "name": "DescribeUser_Profiles",
27796 "group": "User_Profiles",
27797 "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>",
27798 "version": "0.0.0",
27799 "filename": "server/api/userProfile/index.js",
27800 "groupTitle": "User_Profiles"
27804 "url": "/api/userProfiles/{id}/resources?section={section}",
27805 "title": "Get Resources assigned to a Section",
27808 "title": "Example usage:",
27809 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
27813 "name": "GetResources",
27814 "group": "User_Profiles",
27815 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27816 "version": "0.0.0",
27817 "filename": "server/api/userProfile/index.js",
27818 "groupTitle": "User_Profiles"
27822 "url": "/api/userProfiles/{id}/sections",
27823 "title": "Get sections associated to a User Profile",
27826 "title": "Example usage:",
27827 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
27831 "name": "GetSections",
27832 "group": "User_Profiles",
27833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27834 "version": "0.0.0",
27835 "filename": "server/api/userProfile/index.js",
27836 "groupTitle": "User_Profiles"
27840 "url": "/api/userProfiles",
27841 "title": "Gets a list of User Profiles",
27844 "title": "Example usage:",
27845 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
27849 "name": "GetUser_Profiles",
27850 "group": "User_Profiles",
27851 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27852 "version": "0.0.0",
27853 "filename": "server/api/userProfile/index.js",
27854 "groupTitle": "User_Profiles"
27858 "url": "/api/userProfiles/{id}/resources",
27859 "title": "Removes resources' permissions from User Profile",
27862 "title": "Example usage:",
27863 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27867 "name": "RemoveResources",
27868 "group": "User_Profiles",
27869 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27870 "version": "0.0.0",
27871 "filename": "server/api/userProfile/index.js",
27872 "groupTitle": "User_Profiles"
27876 "url": "/api/userProfiles/{id}/sections",
27877 "title": "Removes sections' permissions from User Profile",
27880 "title": "Example usage:",
27881 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27885 "name": "RemoveSections",
27886 "group": "User_Profiles",
27887 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27888 "version": "0.0.0",
27889 "filename": "server/api/userProfile/index.js",
27890 "groupTitle": "User_Profiles"
27894 "url": "/api/userProfiles/{id}",
27895 "title": "Gets a single User Profile",
27898 "title": "Example usage:",
27899 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
27903 "name": "ShowUser_Profiles",
27904 "group": "User_Profiles",
27905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27906 "version": "0.0.0",
27907 "filename": "server/api/userProfile/index.js",
27908 "groupTitle": "User_Profiles"
27912 "url": "/api/userProfiles/{id}",
27913 "title": "Update an existing User Profile",
27916 "title": "Example usage:",
27917 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27921 "name": "updateUser_Profiles",
27922 "group": "User_Profiles",
27923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27924 "version": "0.0.0",
27925 "filename": "server/api/userProfile/index.js",
27926 "groupTitle": "User_Profiles"
27930 "url": "/api/users/{id}/chat_interactions",
27931 "title": "Add chat interaction tabs to an agent",
27934 "title": "Example usage:",
27935 "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",
27939 "name": "AddChatInteractions",
27941 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27942 "version": "0.0.0",
27943 "filename": "server/api/user/index.js",
27944 "groupTitle": "Users"
27948 "url": "/api/users/{id}/chat_websites",
27949 "title": "Add a Chat Website to a user",
27952 "title": "Example usage:",
27953 "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",
27957 "name": "AddChatWebsites",
27959 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27960 "version": "0.0.0",
27961 "filename": "server/api/user/index.js",
27962 "groupTitle": "Users"
27966 "url": "/api/users/{id}/contacts",
27967 "title": "Add contacts to a user",
27970 "title": "Example usage:",
27971 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27975 "name": "AddContacts",
27977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27978 "version": "0.0.0",
27979 "filename": "server/api/user/index.js",
27980 "groupTitle": "Users"
27984 "url": "/api/users/{id}/fax_accounts",
27985 "title": "Add a Fax Account to a user",
27988 "title": "Example usage:",
27989 "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",
27993 "name": "AddFaxAccounts",
27995 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27996 "version": "0.0.0",
27997 "filename": "server/api/user/index.js",
27998 "groupTitle": "Users"
28002 "url": "/api/users/{id}/fax_interactions",
28003 "title": "Add fax interaction tabs to an agent",
28006 "title": "Example usage:",
28007 "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",
28011 "name": "AddFaxInteractions",
28013 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28014 "version": "0.0.0",
28015 "filename": "server/api/user/index.js",
28016 "groupTitle": "Users"
28020 "url": "/api/users/{id}/mail_accounts",
28021 "title": "Add a Mail Account to a user",
28024 "title": "Example usage:",
28025 "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",
28029 "name": "AddMailAccounts",
28031 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28032 "version": "0.0.0",
28033 "filename": "server/api/user/index.js",
28034 "groupTitle": "Users"
28038 "url": "/api/users/{id}/mail_interactions",
28039 "title": "Add mail interaction tabs to an agent",
28042 "title": "Example usage:",
28043 "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",
28047 "name": "AddMailInteractions",
28049 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28050 "version": "0.0.0",
28051 "filename": "server/api/user/index.js",
28052 "groupTitle": "Users"
28056 "url": "/api/users/{id}/openchannel_accounts",
28057 "title": "Add a Open Channel Account to a user",
28060 "title": "Example usage:",
28061 "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",
28065 "name": "AddOpenchannelAccounts",
28067 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28068 "version": "0.0.0",
28069 "filename": "server/api/user/index.js",
28070 "groupTitle": "Users"
28074 "url": "/api/users/{id}/openchannel_interactions",
28075 "title": "Add openchannel interaction tabs to an agent",
28078 "title": "Example usage:",
28079 "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",
28083 "name": "AddOpenchannelInteractions",
28085 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28086 "version": "0.0.0",
28087 "filename": "server/api/user/index.js",
28088 "groupTitle": "Users"
28092 "url": "/api/users/{id}/queues",
28093 "title": "Add queues to an agent",
28096 "title": "Example usage:",
28097 "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",
28101 "name": "AddQueues",
28103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28104 "version": "0.0.0",
28105 "filename": "server/api/user/index.js",
28106 "groupTitle": "Users"
28110 "url": "/api/users/{id}/sms_accounts",
28111 "title": "Add a Sms Account to a user",
28114 "title": "Example usage:",
28115 "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",
28119 "name": "AddSmsAccounts",
28121 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28122 "version": "0.0.0",
28123 "filename": "server/api/user/index.js",
28124 "groupTitle": "Users"
28128 "url": "/api/users/{id}/sms_interactions",
28129 "title": "Add sms interaction tabs to an agent",
28132 "title": "Example usage:",
28133 "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",
28137 "name": "AddSmsInteractions",
28139 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28140 "version": "0.0.0",
28141 "filename": "server/api/user/index.js",
28142 "groupTitle": "Users"
28146 "url": "/api/users/{id}/square_projects",
28147 "title": "Add a Square Project to a user",
28150 "title": "Example usage:",
28151 "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",
28155 "name": "AddSquareProjects",
28157 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28158 "version": "0.0.0",
28159 "filename": "server/api/user/index.js",
28160 "groupTitle": "Users"
28164 "url": "/api/users/{id}/teams",
28165 "title": "Add teams to an agent",
28168 "title": "Example usage:",
28169 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28173 "name": "AddTeams",
28175 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28176 "version": "0.0.0",
28177 "filename": "server/api/user/index.js",
28178 "groupTitle": "Users"
28182 "url": "/api/users/{id}/whatsapp_accounts",
28183 "title": "Add a Whatsapp Account to a user",
28186 "title": "Example usage:",
28187 "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",
28191 "name": "AddWhatsappAccounts",
28193 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28194 "version": "0.0.0",
28195 "filename": "server/api/user/index.js",
28196 "groupTitle": "Users"
28200 "url": "/api/users/{id}/whatsapp_interactions",
28201 "title": "Add Whatsapp interaction tabs to an agent",
28204 "title": "Example usage:",
28205 "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",
28209 "name": "AddWhatsappInteractions",
28211 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28212 "version": "0.0.0",
28213 "filename": "server/api/user/index.js",
28214 "groupTitle": "Users"
28218 "url": "/api/users/create_many",
28219 "title": "Creates many Users",
28222 "title": "Example usage:",
28223 "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28227 "name": "BulkCreateUsers",
28237 "description": "<p>The name of the user</p>"
28243 "field": "fullname",
28277 "field": "password",
28284 "field": "provider",
28291 "field": "internal",
28319 "field": "address",
28326 "field": "zipcode",
28333 "field": "userpic",
28347 "field": "country",
28361 "field": "lastLoginAt",
28368 "field": "voicePause",
28375 "field": "chatPause",
28382 "field": "mailPause",
28389 "field": "faxPause",
28396 "field": "smsPause",
28403 "field": "whatsappPause",
28410 "field": "openchannelPause",
28417 "field": "pauseType",
28424 "field": "lastPauseAt",
28431 "field": "chatCapacity",
28438 "field": "mailCapacity",
28445 "field": "faxCapacity",
28452 "field": "smsCapacity",
28459 "field": "whatsappCapacity",
28466 "field": "openchannelCapacity",
28473 "field": "phoneBarAutoAnswer",
28480 "field": "phoneBarEnableSettings",
28487 "field": "phoneBarListenPort",
28494 "field": "phoneBarExpires",
28501 "field": "phoneBarRemoteControl",
28508 "field": "phoneBarRemoteControlPort",
28515 "field": "phoneBarEnableRecording",
28522 "field": "phoneBarRingInUse",
28529 "field": "chanspy",
28536 "field": "description",
28564 "field": "regseconds",
28571 "field": "fullcontact",
28578 "field": "regserver",
28585 "field": "useragent",
28611 "field": "context",
28618 "\"ALLOWED_NOT_SCREENED\"",
28619 "\"ALLOWED_PASSED_SCREEN\"",
28620 "\"ALLOWED_FAILED_SCREEN\"",
28622 "\"PROHIB_NOT_SCREENED\"",
28623 "\"PROHIB_PASSED_SCREEN\"",
28624 "\"PROHIB_FAILED_SCREEN\"",
28628 "field": "callingpres",
28656 "field": "md5secret",
28663 "field": "remotesecret",
28670 "field": "transport",
28671 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
28684 "field": "dtmfmode",
28698 "field": "directmedia",
28709 "field": "directrtpsetup",
28716 "field": "directmediapermit",
28723 "field": "directmediadeny",
28731 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
28737 "field": "callgroup",
28744 "field": "namedcallgroup",
28751 "field": "pickupgroup",
28758 "field": "namedpickupgroup",
28765 "field": "language",
28772 "field": "tonezone",
28779 "field": "disallow",
28787 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "gsm"]</p>"
28797 "field": "autoframing",
28804 "field": "insecure",
28805 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
28815 "field": "trustrpid",
28826 "field": "trust_id_outbound",
28838 "field": "progressinband",
28849 "field": "promiscredir",
28860 "field": "useclientcode",
28867 "field": "accountcode",
28881 "field": "callerid",
28888 "field": "amaflags",
28899 "field": "callcounter",
28906 "field": "busylevel",
28917 "field": "allowoverlap",
28928 "field": "allowsubscribe",
28939 "field": "allowtransfer",
28950 "field": "ignoresdpversion",
28957 "field": "subscribecontext",
28964 "field": "template",
28976 "field": "videosupport",
28983 "field": "maxcallbitrate",
28994 "field": "rfc2833compensate",
29001 "field": "mailbox",
29013 "field": "session_timers",
29020 "field": "session_expires",
29027 "field": "session_minse",
29038 "field": "session_refresher",
29045 "field": "t38pt_usertpsource",
29052 "field": "regexten",
29059 "field": "fromdomain",
29066 "field": "fromuser",
29077 "field": "qualify",
29084 "field": "keepalive",
29091 "field": "defaultip",
29098 "field": "defaultuser",
29105 "field": "rtptimeout",
29112 "field": "rtpholdtimeout",
29119 "field": "rtpkeepalive",
29130 "field": "sendrpid",
29137 "field": "outboundproxy",
29144 "field": "callbackextension",
29151 "field": "timert1",
29165 "field": "qualifyfreq",
29172 "field": "contactpermit",
29179 "field": "contactdeny",
29186 "field": "contactacl",
29193 "field": "unsolicited_mailbox",
29200 "field": "use_q850_reason",
29207 "field": "maxforwards",
29218 "field": "encryption",
29240 "field": "force_avp",
29251 "field": "icesupport",
29262 "field": "dtlsenable",
29275 "field": "dtlsverify",
29282 "field": "dtlsrekey",
29289 "field": "dtlscertfile",
29296 "field": "dtlsprivatekey",
29303 "field": "dtlscipher",
29310 "field": "dtlscafile",
29317 "field": "dtlscapath",
29329 "field": "dtlssetup",
29336 "field": "dtlsfingerprint",
29347 "field": "usereqphone",
29354 "field": "recordonfeature",
29361 "field": "recordofffeature",
29368 "field": "call_limit",
29379 "field": "registertrying",
29390 "field": "subscribemwi",
29397 "field": "vmexten",
29404 "field": "mohinterpret",
29411 "field": "mohsuggest",
29418 "field": "parkinglot",
29432 "field": "canreinvite",
29439 "field": "loginInPause",
29446 "field": "resetPasswordToken",
29453 "field": "resetPasswordExpires",
29460 "field": "showWebBar",
29467 "field": "permissions",
29474 "field": "phoneBarUnconditionalNumber",
29481 "field": "phoneBarNoReplyNumber",
29488 "field": "phoneBarBusyNumber",
29495 "field": "phoneBarUnconditional",
29502 "field": "phoneBarNoReply",
29509 "field": "phoneBarBusy",
29516 "field": "phoneBarDnd",
29523 "field": "phoneBarUnansweredCallBadge",
29530 "field": "phoneBarEnableDtmfTone",
29537 "field": "phoneBarAutoAnswerDelay",
29544 "field": "extensionMonitor",
29551 "field": "crudPermissions",
29562 "field": "rtcp_mux",
29569 "field": "allowmessenger",
29576 "field": "phoneBarOutboundProxy",
29583 "field": "passwordResetAt",
29590 "field": "phoneBarEnableJaws",
29597 "field": "phoneBarEnableScreenRecordingByAgent",
29604 "field": "phoneBarEnableVideoRecording",
29611 "field": "phoneBarEnableAutomaticScreenRecording",
29618 "field": "phoneBarPrefixRequired",
29625 "field": "hotdesk",
29632 "field": "interface",
29639 "field": "privacyEnabled",
29646 "field": "apiKeyNonce",
29653 "field": "apiKeyIat",
29660 "field": "screenrecording",
29667 "field": "blocked",
29674 "field": "blockedAt",
29681 "field": "loginAttempts",
29688 "field": "disabled",
29694 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29695 "version": "0.0.0",
29696 "filename": "server/api/user/index.js",
29697 "groupTitle": "Users"
29701 "url": "/api/users/{id}/password",
29702 "title": "Change user password",
29705 "title": "Example usage:",
29706 "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",
29710 "name": "ChangePwd",
29712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29713 "version": "0.0.0",
29714 "filename": "server/api/user/index.js",
29715 "groupTitle": "Users"
29719 "url": "/api/users",
29720 "title": "Create a new user",
29723 "title": "Example usage:",
29724 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29731 "version": "0.0.0",
29732 "filename": "server/api/user/index.js",
29733 "groupTitle": "Users"
29737 "url": "/api/users/{id}/api_key",
29738 "title": "Create a new API access key for the user",
29741 "title": "Example usage:",
29742 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29746 "name": "CreateApiKey",
29748 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29749 "version": "0.0.0",
29750 "filename": "server/api/user/index.js",
29751 "groupTitle": "Users"
29755 "url": "/api/users/{id}",
29756 "title": "Deletes a user",
29759 "title": "Example usage:",
29760 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29766 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29767 "version": "0.0.0",
29768 "filename": "server/api/user/index.js",
29769 "groupTitle": "Users"
29773 "url": "/api/users/describe",
29774 "title": "Gets table info about Users",
29777 "title": "Example usage:",
29778 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29782 "name": "DescribeUsers",
29784 "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>",
29785 "version": "0.0.0",
29786 "filename": "server/api/user/index.js",
29787 "groupTitle": "Users"
29791 "url": "/api/users/{id}/agents",
29792 "title": "GetAgents",
29795 "title": "Example usage:",
29796 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29800 "name": "GetAgents",
29802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29803 "version": "0.0.0",
29804 "filename": "server/api/user/index.js",
29805 "groupTitle": "Users"
29809 "url": "/api/users/{id}/api_key",
29810 "title": "Get the API access key for the user",
29813 "title": "Example usage:",
29814 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29818 "name": "GetApiKey",
29820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29821 "version": "0.0.0",
29822 "filename": "server/api/user/index.js",
29823 "groupTitle": "Users"
29827 "url": "/api/users/{id}/groups",
29828 "title": "GetChatGroups",
29831 "title": "Example usage:",
29832 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29836 "name": "GetChatGroups",
29838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29839 "version": "0.0.0",
29840 "filename": "server/api/user/index.js",
29841 "groupTitle": "Users"
29845 "url": "/api/users/{id}/chat/interactions",
29846 "title": "GetChatInteractions",
29849 "title": "Example usage:",
29850 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29854 "name": "GetChatInteractions",
29856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29857 "version": "0.0.0",
29858 "filename": "server/api/user/index.js",
29859 "groupTitle": "Users"
29863 "url": "/api/users/{id}/chat_websites",
29864 "title": "GetChatWebsites",
29867 "title": "Example usage:",
29868 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29872 "name": "GetChatWebsites",
29874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29875 "version": "0.0.0",
29876 "filename": "server/api/user/index.js",
29877 "groupTitle": "Users"
29881 "url": "/api/users/{id}/contacts",
29882 "title": "GetContacts",
29885 "title": "Example usage:",
29886 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29890 "name": "GetContacts",
29892 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29893 "version": "0.0.0",
29894 "filename": "server/api/user/index.js",
29895 "groupTitle": "Users"
29899 "url": "/api/users/{id}/fax_accounts",
29900 "title": "GetFaxAccounts",
29903 "title": "Example usage:",
29904 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29908 "name": "GetFaxAccounts",
29910 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29911 "version": "0.0.0",
29912 "filename": "server/api/user/index.js",
29913 "groupTitle": "Users"
29917 "url": "/api/users/{id}/fax/interactions",
29918 "title": "GetFaxInteractions",
29921 "title": "Example usage:",
29922 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29926 "name": "GetFaxInteractions",
29928 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29929 "version": "0.0.0",
29930 "filename": "server/api/user/index.js",
29931 "groupTitle": "Users"
29935 "url": "/api/users/{id}/lists",
29936 "title": "GetLists",
29939 "title": "Example usage:",
29940 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29944 "name": "GetLists",
29946 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29947 "version": "0.0.0",
29948 "filename": "server/api/user/index.js",
29949 "groupTitle": "Users"
29953 "url": "/api/users/{id}/mail_accounts",
29954 "title": "GetMailAccounts",
29957 "title": "Example usage:",
29958 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29962 "name": "GetMailAccounts",
29964 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29965 "version": "0.0.0",
29966 "filename": "server/api/user/index.js",
29967 "groupTitle": "Users"
29971 "url": "/api/users/{id}/mail/interactions",
29972 "title": "GetMailInteractions",
29975 "title": "Example usage:",
29976 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29980 "name": "GetMailInteractions",
29982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29983 "version": "0.0.0",
29984 "filename": "server/api/user/index.js",
29985 "groupTitle": "Users"
29989 "url": "/api/users/{id}/openchannel_accounts",
29990 "title": "GetOpenchannelAccounts",
29993 "title": "Example usage:",
29994 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29998 "name": "GetOpenchannelAccounts",
30000 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30001 "version": "0.0.0",
30002 "filename": "server/api/user/index.js",
30003 "groupTitle": "Users"
30007 "url": "/api/users/{id}/openchannel/interactions",
30008 "title": "GetOpenchannelInteractions",
30011 "title": "Example usage:",
30012 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
30016 "name": "GetOpenchannelInteractions",
30018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30019 "version": "0.0.0",
30020 "filename": "server/api/user/index.js",
30021 "groupTitle": "Users"
30025 "url": "/api/users/{id}/prefixes",
30026 "title": "GetPrefixes",
30029 "title": "Example usage:",
30030 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
30034 "name": "GetPrefixes",
30036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30037 "version": "0.0.0",
30038 "filename": "server/api/user/index.js",
30039 "groupTitle": "Users"
30043 "url": "/api/users/{id}/queues?channel={channel}",
30044 "title": "Gets Queues list",
30047 "title": "Example usage:",
30048 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
30052 "name": "GetQueues",
30054 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30055 "version": "0.0.0",
30056 "filename": "server/api/user/index.js",
30057 "groupTitle": "Users"
30061 "url": "/api/users/{id}/recordings",
30062 "title": "GetRecordings",
30065 "title": "Example usage:",
30066 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
30070 "name": "GetRecordings",
30072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30073 "version": "0.0.0",
30074 "filename": "server/api/user/index.js",
30075 "groupTitle": "Users"
30079 "url": "/api/users/{id}/scheduled_calls",
30080 "title": "GetScheduledCalls",
30083 "title": "Example usage:",
30084 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
30088 "name": "GetScheduledCalls",
30090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30091 "version": "0.0.0",
30092 "filename": "server/api/user/index.js",
30093 "groupTitle": "Users"
30097 "url": "/api/users/{id}/screen_recordings",
30098 "title": "GetScreenRecordings",
30101 "title": "Example usage:",
30102 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
30106 "name": "GetScreenRecordings",
30108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30109 "version": "0.0.0",
30110 "filename": "server/api/user/index.js",
30111 "groupTitle": "Users"
30115 "url": "/api/users/{id}/sms_accounts",
30116 "title": "GetSmsAccounts",
30119 "title": "Example usage:",
30120 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
30124 "name": "GetSmsAccounts",
30126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30127 "version": "0.0.0",
30128 "filename": "server/api/user/index.js",
30129 "groupTitle": "Users"
30133 "url": "/api/users/{id}/sms/interactions",
30134 "title": "GetSmsInteractions",
30137 "title": "Example usage:",
30138 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
30142 "name": "GetSmsInteractions",
30144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30145 "version": "0.0.0",
30146 "filename": "server/api/user/index.js",
30147 "groupTitle": "Users"
30151 "url": "/api/users/{id}/square_projects",
30152 "title": "GetSquareProjects",
30155 "title": "Example usage:",
30156 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
30160 "name": "GetSquareProjects",
30162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30163 "version": "0.0.0",
30164 "filename": "server/api/user/index.js",
30165 "groupTitle": "Users"
30169 "url": "/api/users/{id}/teams",
30170 "title": "GetTeams",
30173 "title": "Example usage:",
30174 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30178 "name": "GetTeams",
30180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30181 "version": "0.0.0",
30182 "filename": "server/api/user/index.js",
30183 "groupTitle": "Users"
30187 "url": "/api/users",
30188 "title": "Gets a list of Users",
30191 "title": "Example usage:",
30192 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30196 "name": "GetUsers",
30198 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30199 "version": "0.0.0",
30200 "filename": "server/api/user/index.js",
30201 "groupTitle": "Users"
30205 "url": "/api/users/{id}/queues_rt",
30206 "title": "GetVoiceQueuesRt",
30209 "title": "Example usage:",
30210 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30214 "name": "GetVoiceQueuesRt",
30216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30217 "version": "0.0.0",
30218 "filename": "server/api/user/index.js",
30219 "groupTitle": "Users"
30223 "url": "/api/users/{id}/whatsapp_accounts",
30224 "title": "GetWhatsappAccounts",
30227 "title": "Example usage:",
30228 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30232 "name": "GetWhatsappAccounts",
30234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30235 "version": "0.0.0",
30236 "filename": "server/api/user/index.js",
30237 "groupTitle": "Users"
30241 "url": "/api/users/{id}/whatsapp/interactions",
30242 "title": "GetWhatsappInteractions",
30245 "title": "Example usage:",
30246 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30250 "name": "GetWhatsappInteractions",
30252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30253 "version": "0.0.0",
30254 "filename": "server/api/user/index.js",
30255 "groupTitle": "Users"
30259 "url": "/api/users/{id}/login",
30263 "title": "Example usage:",
30264 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
30270 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30271 "version": "0.0.0",
30272 "filename": "server/api/user/index.js",
30273 "groupTitle": "Users"
30277 "url": "/api/users/{id}/logout",
30281 "title": "Example usage:",
30282 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30288 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30289 "version": "0.0.0",
30290 "filename": "server/api/user/index.js",
30291 "groupTitle": "Users"
30295 "url": "/api/users/{id}/pause",
30299 "title": "Example usage:",
30300 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30306 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30307 "version": "0.0.0",
30308 "filename": "server/api/user/index.js",
30309 "groupTitle": "Users"
30313 "url": "/api/users/{id}/api_key",
30314 "title": "Remove API access key for the user",
30317 "title": "Example usage:",
30318 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30322 "name": "RemoveApiKey",
30324 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30325 "version": "0.0.0",
30326 "filename": "server/api/user/index.js",
30327 "groupTitle": "Users"
30331 "url": "/api/users/{id}/chat_interactions",
30332 "title": "Removes interactions from an agent",
30335 "title": "Example usage:",
30336 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30340 "name": "RemoveChatInteractions",
30342 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30343 "version": "0.0.0",
30344 "filename": "server/api/user/index.js",
30345 "groupTitle": "Users"
30349 "url": "/api/users/{id}/chat_websites",
30350 "title": "Removes a Chat Website from a user",
30353 "title": "Example usage:",
30354 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30358 "name": "RemoveChatWebsites",
30360 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30361 "version": "0.0.0",
30362 "filename": "server/api/user/index.js",
30363 "groupTitle": "Users"
30367 "url": "/api/users/{id}/fax_accounts",
30368 "title": "Removes a Fax Account from a user",
30371 "title": "Example usage:",
30372 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30376 "name": "RemoveFaxAccounts",
30378 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30379 "version": "0.0.0",
30380 "filename": "server/api/user/index.js",
30381 "groupTitle": "Users"
30385 "url": "/api/users/{id}/fax_interactions",
30386 "title": "Removes interactions from an agent",
30389 "title": "Example usage:",
30390 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30394 "name": "RemoveFaxInteractions",
30396 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30397 "version": "0.0.0",
30398 "filename": "server/api/user/index.js",
30399 "groupTitle": "Users"
30403 "url": "/api/users/{id}/mail_accounts",
30404 "title": "Removes a Mail Account from a user",
30407 "title": "Example usage:",
30408 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30412 "name": "RemoveMailAccounts",
30414 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30415 "version": "0.0.0",
30416 "filename": "server/api/user/index.js",
30417 "groupTitle": "Users"
30421 "url": "/api/users/{id}/mail_interactions",
30422 "title": "Removes interactions from an agent",
30425 "title": "Example usage:",
30426 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30430 "name": "RemoveMailInteractions",
30432 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30433 "version": "0.0.0",
30434 "filename": "server/api/user/index.js",
30435 "groupTitle": "Users"
30439 "url": "/api/users/{id}/openchannel_accounts",
30440 "title": "Removes a Open Channel Account from a user",
30443 "title": "Example usage:",
30444 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30448 "name": "RemoveOpenchannelAccounts",
30450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30451 "version": "0.0.0",
30452 "filename": "server/api/user/index.js",
30453 "groupTitle": "Users"
30457 "url": "/api/users/{id}/openchannel_interactions",
30458 "title": "Removes openchannel interactions from an agent",
30461 "title": "Example usage:",
30462 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30466 "name": "RemoveOpenchannelInteractions",
30468 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30469 "version": "0.0.0",
30470 "filename": "server/api/user/index.js",
30471 "groupTitle": "Users"
30475 "url": "/api/users/{id}/queues",
30476 "title": "Remove queues to an agent",
30479 "title": "Example usage:",
30480 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30484 "name": "RemoveQueues",
30486 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30487 "version": "0.0.0",
30488 "filename": "server/api/user/index.js",
30489 "groupTitle": "Users"
30493 "url": "/api/users/{id}/sms_accounts",
30494 "title": "Removes a Sms Account from a user",
30497 "title": "Example usage:",
30498 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30502 "name": "RemoveSmsAccounts",
30504 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30505 "version": "0.0.0",
30506 "filename": "server/api/user/index.js",
30507 "groupTitle": "Users"
30511 "url": "/api/users/{id}/sms_interactions",
30512 "title": "Removes interactions from an agent",
30515 "title": "Example usage:",
30516 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30520 "name": "RemoveSmsInteractions",
30522 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30523 "version": "0.0.0",
30524 "filename": "server/api/user/index.js",
30525 "groupTitle": "Users"
30529 "url": "/api/users/{id}/square_projects",
30530 "title": "Removes a Square Project from a user",
30533 "title": "Example usage:",
30534 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30538 "name": "RemoveSquareProjects",
30540 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30541 "version": "0.0.0",
30542 "filename": "server/api/user/index.js",
30543 "groupTitle": "Users"
30547 "url": "/api/users/{id}/teams",
30548 "title": "Removes teams from an agent",
30551 "title": "Example usage:",
30552 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30556 "name": "RemoveTeams",
30558 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30559 "version": "0.0.0",
30560 "filename": "server/api/user/index.js",
30561 "groupTitle": "Users"
30565 "url": "/api/users/{id}/whatsapp_accounts",
30566 "title": "Removes a Whatsapp Account from a user",
30569 "title": "Example usage:",
30570 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30574 "name": "RemoveWhatsappAccounts",
30576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30577 "version": "0.0.0",
30578 "filename": "server/api/user/index.js",
30579 "groupTitle": "Users"
30583 "url": "/api/users/{id}/whatsapp_interactions",
30584 "title": "Removes Whatsapp interactions from an agent",
30587 "title": "Example usage:",
30588 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30592 "name": "RemoveWhatsappInteractions",
30594 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30595 "version": "0.0.0",
30596 "filename": "server/api/user/index.js",
30597 "groupTitle": "Users"
30601 "url": "/api/users/{id}",
30602 "title": "Gets a single User",
30605 "title": "Example usage:",
30606 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30610 "name": "ShowUsers",
30612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30613 "version": "0.0.0",
30614 "filename": "server/api/user/index.js",
30615 "groupTitle": "Users"
30619 "url": "/api/users/{id}/unpause",
30620 "title": "Unpause",
30623 "title": "Example usage:",
30624 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30631 "version": "0.0.0",
30632 "filename": "server/api/user/index.js",
30633 "groupTitle": "Users"
30637 "url": "/api/users/whoami",
30641 "title": "Example usage:",
30642 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30649 "version": "0.0.0",
30650 "filename": "server/api/user/index.js",
30651 "groupTitle": "Users"
30655 "url": "/api/users/{id}/avatar",
30656 "title": "Add avatar",
30659 "title": "Example usage:",
30660 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30664 "name": "addAvatar",
30666 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30667 "version": "0.0.0",
30668 "filename": "server/api/user/index.js",
30669 "groupTitle": "Users"
30673 "url": "/api/users/{id}/avatar",
30674 "title": "Get avatar",
30677 "title": "Example usage:",
30678 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30682 "name": "getAvatar",
30684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30685 "version": "0.0.0",
30686 "filename": "server/api/user/index.js",
30687 "groupTitle": "Users"
30691 "url": "/api/users/{id}",
30692 "title": "Update an existing User",
30695 "title": "Example usage:",
30696 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30700 "name": "updateUsers",
30702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30703 "version": "0.0.0",
30704 "filename": "server/api/user/index.js",
30705 "groupTitle": "Users"
30709 "url": "/api/variables",
30710 "title": "Creates a new Variable",
30713 "title": "Example usage:",
30714 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30718 "name": "CreateVariables",
30719 "group": "Variables",
30734 "field": "description",
30740 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30741 "version": "0.0.0",
30742 "filename": "server/api/variable/index.js",
30743 "groupTitle": "Variables"
30747 "url": "/api/variables/{id}",
30748 "title": "Deletes a Variable",
30751 "title": "Example usage:",
30752 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30756 "name": "DeleteVariables",
30757 "group": "Variables",
30758 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30759 "version": "0.0.0",
30760 "filename": "server/api/variable/index.js",
30761 "groupTitle": "Variables"
30765 "url": "/api/variables",
30766 "title": "Gets a list of Variables",
30769 "title": "Example usage:",
30770 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30774 "name": "GetVariables",
30775 "group": "Variables",
30776 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30777 "version": "0.0.0",
30778 "filename": "server/api/variable/index.js",
30779 "groupTitle": "Variables"
30783 "url": "/api/variables/{id}",
30784 "title": "Gets a single Variable",
30787 "title": "Example usage:",
30788 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30792 "name": "ShowVariables",
30793 "group": "Variables",
30794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30795 "version": "0.0.0",
30796 "filename": "server/api/variable/index.js",
30797 "groupTitle": "Variables"
30801 "url": "/api/variables/{id}",
30802 "title": "Update an existing Variable",
30805 "title": "Example usage:",
30806 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30810 "name": "updateVariables",
30811 "group": "Variables",
30812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30813 "version": "0.0.0",
30814 "filename": "server/api/variable/index.js",
30815 "groupTitle": "Variables"
30819 "url": "/api/version/fetch",
30820 "title": "Fetch git version",
30823 "title": "Example usage:",
30824 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30828 "name": "FetchVersion",
30829 "group": "Version",
30830 "description": "<p>Motion run the following command: git fetch origin master</p>",
30831 "version": "0.0.0",
30832 "filename": "server/api/version/index.js",
30833 "groupTitle": "Version"
30837 "url": "/api/version",
30838 "title": "Gets version",
30841 "title": "Example usage:",
30842 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30846 "name": "GetVersion",
30847 "group": "Version",
30848 "description": "<p>Motion returns the current and latest motion version.</p>",
30849 "version": "0.0.0",
30850 "filename": "server/api/version/index.js",
30851 "groupTitle": "Version"
30855 "url": "/api/version/migrations",
30856 "title": "Launch database migrations",
30859 "title": "Example usage:",
30860 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30864 "name": "MigrateVersion",
30865 "group": "Version",
30866 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30867 "version": "0.0.0",
30868 "filename": "server/api/version/index.js",
30869 "groupTitle": "Version"
30873 "url": "/api/version/pull",
30874 "title": "Pull git version",
30877 "title": "Example usage:",
30878 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30882 "name": "PullVersion",
30883 "group": "Version",
30884 "description": "<p>Motion run the following command: git pull</p>",
30885 "version": "0.0.0",
30886 "filename": "server/api/version/index.js",
30887 "groupTitle": "Version"
30891 "url": "/api/version/reset",
30892 "title": "Reset git version",
30895 "title": "Example usage:",
30896 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30900 "name": "ResetVersion",
30901 "group": "Version",
30902 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30903 "version": "0.0.0",
30904 "filename": "server/api/version/index.js",
30905 "groupTitle": "Version"
30909 "url": "/api/version/restart",
30910 "title": "Restart motion2 after update",
30913 "title": "Example usage:",
30914 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30918 "name": "RestartVersion",
30919 "group": "Version",
30920 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30921 "version": "0.0.0",
30922 "filename": "server/api/version/index.js",
30923 "groupTitle": "Version"
30927 "url": "/api/voice/agents/reports/describe",
30928 "title": "Gets table info about Agent Reports",
30931 "title": "Example usage:",
30932 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30936 "name": "DescribeAgent_Reports",
30937 "group": "Voice_Agent_Reports",
30938 "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>",
30939 "version": "0.0.0",
30940 "filename": "server/api/voiceAgentReport/index.js",
30941 "groupTitle": "Voice_Agent_Reports"
30945 "url": "/api/voice/agents/reports",
30946 "title": "Gets a list of Agent Reports",
30949 "title": "Example usage:",
30950 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30954 "name": "GetAgent_Reports",
30955 "group": "Voice_Agent_Reports",
30956 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30957 "version": "0.0.0",
30958 "filename": "server/api/voiceAgentReport/index.js",
30959 "groupTitle": "Voice_Agent_Reports"
30963 "url": "/api/voice/agents/reports/{id}",
30964 "title": "Gets a single Agent Report",
30967 "title": "Example usage:",
30968 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30972 "name": "ShowAgent_Reports",
30973 "group": "Voice_Agent_Reports",
30974 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30975 "version": "0.0.0",
30976 "filename": "server/api/voiceAgentReport/index.js",
30977 "groupTitle": "Voice_Agent_Reports"
30981 "url": "/api/voice/calls/reports/describe",
30982 "title": "Gets table info about Call Reports",
30985 "title": "Example usage:",
30986 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30990 "name": "DescribeCall_Reports",
30991 "group": "Voice_Call_Reports",
30992 "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>",
30993 "version": "0.0.0",
30994 "filename": "server/api/voiceCallReport/index.js",
30995 "groupTitle": "Voice_Call_Reports"
30999 "url": "/api/voice/calls/reports",
31000 "title": "Gets a list of Call Reports",
31003 "title": "Example usage:",
31004 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
31008 "name": "GetCall_Reports",
31009 "group": "Voice_Call_Reports",
31010 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31011 "version": "0.0.0",
31012 "filename": "server/api/voiceCallReport/index.js",
31013 "groupTitle": "Voice_Call_Reports"
31017 "url": "/api/voice/calls/reports/{id}",
31018 "title": "Gets a single Call Report",
31021 "title": "Example usage:",
31022 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
31026 "name": "ShowCall_Reports",
31027 "group": "Voice_Call_Reports",
31028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31029 "version": "0.0.0",
31030 "filename": "server/api/voiceCallReport/index.js",
31031 "groupTitle": "Voice_Call_Reports"
31035 "url": "/api/voice/calls/reports/{id}",
31036 "title": "Update a single cdr",
31039 "title": "Example usage:",
31040 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
31045 "group": "Voice_Call_Reports",
31046 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31047 "version": "0.0.0",
31048 "filename": "server/api/voiceCallReport/index.js",
31049 "groupTitle": "Voice_Call_Reports"
31053 "url": "/api/voice/chanspy",
31054 "title": "Creates a new ChanSpy",
31057 "title": "Example usage:",
31058 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31062 "name": "CreateChanSpy",
31063 "group": "Voice_ChanSpy",
31085 "field": "options",
31099 "field": "password",
31113 "field": "recordingFormat",
31120 "field": "description",
31126 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31127 "version": "0.0.0",
31128 "filename": "server/api/voiceChanSpy/index.js",
31129 "groupTitle": "Voice_ChanSpy"
31133 "url": "/api/voice/chanspy/{id}",
31134 "title": "Deletes a ChanSpy",
31137 "title": "Example usage:",
31138 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31142 "name": "DeleteChanSpy",
31143 "group": "Voice_ChanSpy",
31144 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31145 "version": "0.0.0",
31146 "filename": "server/api/voiceChanSpy/index.js",
31147 "groupTitle": "Voice_ChanSpy"
31151 "url": "/api/voice/chanspy",
31152 "title": "Gets a list of ChanSpy",
31155 "title": "Example usage:",
31156 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31160 "name": "GetChanSpy",
31161 "group": "Voice_ChanSpy",
31162 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31163 "version": "0.0.0",
31164 "filename": "server/api/voiceChanSpy/index.js",
31165 "groupTitle": "Voice_ChanSpy"
31169 "url": "/api/voice/chanspy/{id}",
31170 "title": "Gets a single ChanSpy",
31173 "title": "Example usage:",
31174 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31178 "name": "ShowChanSpy",
31179 "group": "Voice_ChanSpy",
31180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31181 "version": "0.0.0",
31182 "filename": "server/api/voiceChanSpy/index.js",
31183 "groupTitle": "Voice_ChanSpy"
31187 "url": "/api/voice/chanspy/{id}",
31188 "title": "Update an existing ChanSpy",
31191 "title": "Example usage:",
31192 "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",
31196 "name": "updateChanSpy",
31197 "group": "Voice_ChanSpy",
31198 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31199 "version": "0.0.0",
31200 "filename": "server/api/voiceChanSpy/index.js",
31201 "groupTitle": "Voice_ChanSpy"
31205 "url": "/api/voice/contexts",
31206 "title": "Create a new context",
31209 "title": "Example usage:",
31210 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31215 "group": "Voice_Contexts",
31230 "field": "description",
31237 "field": "defaultEntry",
31243 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31244 "version": "0.0.0",
31245 "filename": "server/api/voiceContext/index.js",
31246 "groupTitle": "Voice_Contexts"
31250 "url": "/api/voice/contexts/{id}",
31251 "title": "Deletes a context",
31254 "title": "Example usage:",
31255 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31260 "group": "Voice_Contexts",
31261 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31262 "version": "0.0.0",
31263 "filename": "server/api/voiceContext/index.js",
31264 "groupTitle": "Voice_Contexts"
31268 "url": "/api/voice/contexts",
31269 "title": "Gets a list of Contexts",
31272 "title": "Example usage:",
31273 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31277 "name": "GetContexts",
31278 "group": "Voice_Contexts",
31279 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31280 "version": "0.0.0",
31281 "filename": "server/api/voiceContext/index.js",
31282 "groupTitle": "Voice_Contexts"
31286 "url": "/api/voice/contexts/{id}",
31287 "title": "Gets a single Context",
31290 "title": "Example usage:",
31291 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31295 "name": "ShowContexts",
31296 "group": "Voice_Contexts",
31297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31298 "version": "0.0.0",
31299 "filename": "server/api/voiceContext/index.js",
31300 "groupTitle": "Voice_Contexts"
31304 "url": "/api/voice/contexts/{id}",
31305 "title": "Update an existing context",
31308 "title": "Example usage:",
31309 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31314 "group": "Voice_Contexts",
31315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31316 "version": "0.0.0",
31317 "filename": "server/api/voiceContext/index.js",
31318 "groupTitle": "Voice_Contexts"
31322 "url": "/api/voice/dials/reports/describe",
31323 "title": "Gets table info about Dial Reports",
31326 "title": "Example usage:",
31327 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31331 "name": "DescribeDial_Reports",
31332 "group": "Voice_Dial_Reports",
31333 "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>",
31334 "version": "0.0.0",
31335 "filename": "server/api/voiceDialReport/index.js",
31336 "groupTitle": "Voice_Dial_Reports"
31340 "url": "/api/voice/dials/reports",
31341 "title": "Gets a list of Dial Reports",
31344 "title": "Example usage:",
31345 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31349 "name": "GetDial_Reports",
31350 "group": "Voice_Dial_Reports",
31351 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31352 "version": "0.0.0",
31353 "filename": "server/api/voiceDialReport/index.js",
31354 "groupTitle": "Voice_Dial_Reports"
31358 "url": "/api/voice/dials/reports/{id}",
31359 "title": "Gets a single Dial Report",
31362 "title": "Example usage:",
31363 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31367 "name": "ShowDial_Reports",
31368 "group": "Voice_Dial_Reports",
31369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31370 "version": "0.0.0",
31371 "filename": "server/api/voiceDialReport/index.js",
31372 "groupTitle": "Voice_Dial_Reports"
31376 "url": "/api/voice/extensions/{id}",
31377 "title": "Deletes a Extension",
31380 "title": "Example usage:",
31381 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31385 "name": "DeleteExtensions",
31386 "group": "Voice_Extensions",
31387 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31388 "version": "0.0.0",
31389 "filename": "server/api/voiceExtension/index.js",
31390 "groupTitle": "Voice_Extensions"
31394 "url": "/api/voice/extensions",
31395 "title": "Gets a list of Extensions",
31398 "title": "Example usage:",
31399 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31403 "name": "GetExtensions",
31404 "group": "Voice_Extensions",
31405 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31406 "version": "0.0.0",
31407 "filename": "server/api/voiceExtension/index.js",
31408 "groupTitle": "Voice_Extensions"
31412 "url": "/api/voice/extensions/{id}",
31413 "title": "Gets a single Extension",
31416 "title": "Example usage:",
31417 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31421 "name": "ShowExtensions",
31422 "group": "Voice_Extensions",
31423 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31424 "version": "0.0.0",
31425 "filename": "server/api/voiceExtension/index.js",
31426 "groupTitle": "Voice_Extensions"
31430 "url": "/api/voice/extensions",
31431 "title": "Create new applications",
31434 "title": "Example usage:",
31435 "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",
31439 "name": "addApplications",
31440 "group": "Voice_Extensions",
31441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31442 "version": "0.0.0",
31443 "filename": "server/api/voiceExtension/index.js",
31444 "groupTitle": "Voice_Extensions"
31448 "url": "/api/voice/extensions",
31449 "title": "Create an extension",
31452 "title": "Example usage:",
31453 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31458 "group": "Voice_Extensions",
31459 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31460 "version": "0.0.0",
31461 "filename": "server/api/voiceExtension/index.js",
31462 "groupTitle": "Voice_Extensions"
31466 "url": "/api/voice/extensions/{id}",
31467 "title": "Update an extension",
31470 "title": "Example usage:",
31471 "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",
31476 "group": "Voice_Extensions",
31477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31478 "version": "0.0.0",
31479 "filename": "server/api/voiceExtension/index.js",
31480 "groupTitle": "Voice_Extensions"
31484 "url": "/api/voice/mohs",
31485 "title": "Create a new a new MOH",
31488 "title": "Example usage:",
31489 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31494 "group": "Voice_MOHs",
31495 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31496 "version": "0.0.0",
31497 "filename": "server/api/voiceMusicOnHold/index.js",
31498 "groupTitle": "Voice_MOHs"
31502 "url": "/api/voice/mohs/{id}/sounds",
31503 "title": "Add sound to MOH",
31506 "title": "Example usage:",
31507 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31511 "name": "AddSound",
31512 "group": "Voice_MOHs",
31513 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31514 "version": "0.0.0",
31515 "filename": "server/api/voiceMusicOnHold/index.js",
31516 "groupTitle": "Voice_MOHs"
31520 "url": "/api/voice/mohs/{id}",
31521 "title": "Deletes an MOH",
31524 "title": "Example usage:",
31525 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31529 "name": "DestroyMoh",
31530 "group": "Voice_MOHs",
31531 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31532 "version": "0.0.0",
31533 "filename": "server/api/voiceMusicOnHold/index.js",
31534 "groupTitle": "Voice_MOHs"
31538 "url": "/api/voice/mohs",
31539 "title": "Gets a list of Music On Holds",
31542 "title": "Example usage:",
31543 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31547 "name": "GetMusic_On_Holds",
31548 "group": "Voice_MOHs",
31549 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31550 "version": "0.0.0",
31551 "filename": "server/api/voiceMusicOnHold/index.js",
31552 "groupTitle": "Voice_MOHs"
31556 "url": "/api/voice/mohs/{id}/sounds",
31557 "title": "Gets sounds from MOH",
31560 "title": "Example usage:",
31561 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31565 "name": "GetSounds",
31566 "group": "Voice_MOHs",
31567 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31568 "version": "0.0.0",
31569 "filename": "server/api/voiceMusicOnHold/index.js",
31570 "groupTitle": "Voice_MOHs"
31574 "url": "/api/voice/mohs/{id}/sounds/{id2}",
31575 "title": "Remove sound from MOH",
31578 "title": "Example usage:",
31579 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31583 "name": "RemoveSound",
31584 "group": "Voice_MOHs",
31585 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31586 "version": "0.0.0",
31587 "filename": "server/api/voiceMusicOnHold/index.js",
31588 "groupTitle": "Voice_MOHs"
31592 "url": "/api/voice/mohs/{id}",
31593 "title": "Gets a single Music On Hold",
31596 "title": "Example usage:",
31597 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31601 "name": "ShowMusic_On_Holds",
31602 "group": "Voice_MOHs",
31603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31604 "version": "0.0.0",
31605 "filename": "server/api/voiceMusicOnHold/index.js",
31606 "groupTitle": "Voice_MOHs"
31610 "url": "/api/voice/mohs/{id}",
31611 "title": "Update an existing Music On Hold",
31614 "title": "Example usage:",
31615 "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",
31619 "name": "updateMusic_On_Holds",
31620 "group": "Voice_MOHs",
31621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31622 "version": "0.0.0",
31623 "filename": "server/api/voiceMusicOnHold/index.js",
31624 "groupTitle": "Voice_MOHs"
31628 "url": "/api/voice/mails",
31629 "title": "Creates a new Mail",
31632 "title": "Example usage:",
31633 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31637 "name": "CreateMails",
31638 "group": "Voice_Mails",
31646 "field": "customer_id",
31653 "field": "context",
31660 "field": "mailbox",
31667 "field": "password",
31674 "field": "fullname",
31724 "field": "dialout",
31731 "field": "callback",
31753 "field": "operator",
31764 "field": "envelope",
31775 "field": "sayduration",
31782 "field": "saydurationm",
31793 "field": "sendvoicemail",
31815 "field": "nextaftercmd",
31826 "field": "forcename",
31837 "field": "forcegreetings",
31848 "field": "hidefromdir",
31862 "field": "emailsubject",
31869 "field": "emailbody",
31876 "field": "maxsecs",
31896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31897 "version": "0.0.0",
31898 "filename": "server/api/voiceMail/index.js",
31899 "groupTitle": "Voice_Mails"
31903 "url": "/api/voice/mails/{id}",
31904 "title": "Deletes a Mail",
31907 "title": "Example usage:",
31908 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31912 "name": "DeleteMails",
31913 "group": "Voice_Mails",
31914 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31915 "version": "0.0.0",
31916 "filename": "server/api/voiceMail/index.js",
31917 "groupTitle": "Voice_Mails"
31921 "url": "/api/voice/mails",
31922 "title": "Gets a list of Mails",
31925 "title": "Example usage:",
31926 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31930 "name": "GetMails",
31931 "group": "Voice_Mails",
31932 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31933 "version": "0.0.0",
31934 "filename": "server/api/voiceMail/index.js",
31935 "groupTitle": "Voice_Mails"
31939 "url": "/api/voice/mails/{id}",
31940 "title": "Gets a single Mail",
31943 "title": "Example usage:",
31944 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31948 "name": "ShowMails",
31949 "group": "Voice_Mails",
31950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31951 "version": "0.0.0",
31952 "filename": "server/api/voiceMail/index.js",
31953 "groupTitle": "Voice_Mails"
31957 "url": "/api/voice/mails/{id}/messages",
31958 "title": "Gets voice mail messages",
31961 "title": "Example usage:",
31962 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31966 "name": "getMessages",
31967 "group": "Voice_Mails",
31968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31969 "version": "0.0.0",
31970 "filename": "server/api/voiceMail/index.js",
31971 "groupTitle": "Voice_Mails"
31975 "url": "/api/voice/mails/{id}",
31976 "title": "Update an existing Mail",
31979 "title": "Example usage:",
31980 "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",
31984 "name": "updateMails",
31985 "group": "Voice_Mails",
31986 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31987 "version": "0.0.0",
31988 "filename": "server/api/voiceMail/index.js",
31989 "groupTitle": "Voice_Mails"
31993 "url": "/api/voice/mails/messages",
31994 "title": "Creates a new Message",
31997 "title": "Example usage:",
31998 "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",
32002 "name": "CreateMessages",
32003 "group": "Voice_Messages",
32032 "field": "context",
32039 "field": "macrocontext",
32046 "field": "callerid",
32053 "field": "origtime",
32060 "field": "duration",
32067 "field": "mailboxuser",
32074 "field": "mailboxcontext",
32081 "field": "recording",
32108 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32109 "version": "0.0.0",
32110 "filename": "server/api/voiceMailMessage/index.js",
32111 "groupTitle": "Voice_Messages"
32115 "url": "/api/voice/mails/messages/{id}",
32116 "title": "Deletes a Message",
32119 "title": "Example usage:",
32120 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
32124 "name": "DeleteMessages",
32125 "group": "Voice_Messages",
32126 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32127 "version": "0.0.0",
32128 "filename": "server/api/voiceMailMessage/index.js",
32129 "groupTitle": "Voice_Messages"
32133 "url": "/api/voice/mails/messages",
32134 "title": "Gets a list of Messages",
32137 "title": "Example usage:",
32138 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32142 "name": "GetMessages",
32143 "group": "Voice_Messages",
32144 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32145 "version": "0.0.0",
32146 "filename": "server/api/voiceMailMessage/index.js",
32147 "groupTitle": "Voice_Messages"
32151 "url": "/api/voice/mails/messages/{id}",
32152 "title": "Gets a single Message",
32155 "title": "Example usage:",
32156 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32160 "name": "ShowMessages",
32161 "group": "Voice_Messages",
32162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32163 "version": "0.0.0",
32164 "filename": "server/api/voiceMailMessage/index.js",
32165 "groupTitle": "Voice_Messages"
32169 "url": "voice/mails/messages/{id}/download",
32170 "title": "Download Voice Message",
32173 "title": "Example usage:",
32174 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32178 "name": "download",
32179 "group": "Voice_Messages",
32180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32181 "version": "0.0.0",
32182 "filename": "server/api/voiceMailMessage/index.js",
32183 "groupTitle": "Voice_Messages"
32187 "url": "/api/voice/mails/messages/{id}",
32188 "title": "Update an existing Message",
32191 "title": "Example usage:",
32192 "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",
32196 "name": "updateMessages",
32197 "group": "Voice_Messages",
32198 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32199 "version": "0.0.0",
32200 "filename": "server/api/voiceMailMessage/index.js",
32201 "groupTitle": "Voice_Messages"
32205 "url": "/api/voice/prefixes/{id}/users",
32206 "title": "Add agents to a prefix",
32209 "title": "Example usage:",
32210 "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",
32214 "name": "AddAgents",
32215 "group": "Voice_Prefixes",
32216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32217 "version": "0.0.0",
32218 "filename": "server/api/voicePrefix/index.js",
32219 "groupTitle": "Voice_Prefixes"
32223 "url": "/api/voice/prefixes/{id}",
32224 "title": "Deletes a Prefix",
32227 "title": "Example usage:",
32228 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32232 "name": "DeletePrefixes",
32233 "group": "Voice_Prefixes",
32234 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32235 "version": "0.0.0",
32236 "filename": "server/api/voicePrefix/index.js",
32237 "groupTitle": "Voice_Prefixes"
32241 "url": "/api/voice/prefixes/describe",
32242 "title": "Gets table info about Prefixes",
32245 "title": "Example usage:",
32246 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32250 "name": "DescribePrefixes",
32251 "group": "Voice_Prefixes",
32252 "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>",
32253 "version": "0.0.0",
32254 "filename": "server/api/voicePrefix/index.js",
32255 "groupTitle": "Voice_Prefixes"
32259 "url": "/api/voice/prefixes/{id}/users",
32260 "title": "Gets agents from prefix",
32263 "title": "Example usage:",
32264 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32268 "name": "GetAgents",
32269 "group": "Voice_Prefixes",
32270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32271 "version": "0.0.0",
32272 "filename": "server/api/voicePrefix/index.js",
32273 "groupTitle": "Voice_Prefixes"
32277 "url": "/api/voice/prefixes",
32278 "title": "Gets a list of Prefixes",
32281 "title": "Example usage:",
32282 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32286 "name": "GetPrefixes",
32287 "group": "Voice_Prefixes",
32288 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32289 "version": "0.0.0",
32290 "filename": "server/api/voicePrefix/index.js",
32291 "groupTitle": "Voice_Prefixes"
32295 "url": "/api/voice/prefixes/{id}/users",
32296 "title": "Removes agents from a prefix",
32299 "title": "Example usage:",
32300 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32304 "name": "RemoveAgents",
32305 "group": "Voice_Prefixes",
32306 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32307 "version": "0.0.0",
32308 "filename": "server/api/voicePrefix/index.js",
32309 "groupTitle": "Voice_Prefixes"
32313 "url": "/api/voice/prefixes/{id}",
32314 "title": "Gets a single Prefix",
32317 "title": "Example usage:",
32318 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32322 "name": "ShowPrefixes",
32323 "group": "Voice_Prefixes",
32324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32325 "version": "0.0.0",
32326 "filename": "server/api/voicePrefix/index.js",
32327 "groupTitle": "Voice_Prefixes"
32331 "url": "/api/voice/prefixes/{id}",
32332 "title": "Update an existing prefix",
32335 "title": "Example usage:",
32336 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32341 "group": "Voice_Prefixes",
32342 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32343 "version": "0.0.0",
32344 "filename": "server/api/voicePrefix/index.js",
32345 "groupTitle": "Voice_Prefixes"
32349 "url": "/api/voice/prefixes",
32350 "title": "Create a prefix",
32353 "title": "Example usage:",
32354 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32359 "group": "Voice_Prefixes",
32360 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32361 "version": "0.0.0",
32362 "filename": "server/api/voicePrefix/index.js",
32363 "groupTitle": "Voice_Prefixes"
32367 "url": "/api/voice/queues/reports/describe",
32368 "title": "Gets table info about Queue Reports",
32371 "title": "Example usage:",
32372 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32376 "name": "DescribeQueue_Reports",
32377 "group": "Voice_Queue_Reports",
32378 "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>",
32379 "version": "0.0.0",
32380 "filename": "server/api/voiceQueueReport/index.js",
32381 "groupTitle": "Voice_Queue_Reports"
32385 "url": "/api/voice/queues/reports",
32386 "title": "Gets a list of Queue Reports",
32389 "title": "Example usage:",
32390 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32394 "name": "GetQueue_Reports",
32395 "group": "Voice_Queue_Reports",
32396 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32397 "version": "0.0.0",
32398 "filename": "server/api/voiceQueueReport/index.js",
32399 "groupTitle": "Voice_Queue_Reports"
32403 "url": "/api/voice/queues/reports/{id}",
32404 "title": "Gets a single Queue Report",
32407 "title": "Example usage:",
32408 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32412 "name": "ShowQueue_Reports",
32413 "group": "Voice_Queue_Reports",
32414 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32415 "version": "0.0.0",
32416 "filename": "server/api/voiceQueueReport/index.js",
32417 "groupTitle": "Voice_Queue_Reports"
32421 "url": "/api/voice/queues/reports/index",
32422 "title": "Get Voice Queues Report",
32425 "title": "Example usage:",
32426 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32430 "name": "getVoiceQueuesReport",
32431 "group": "Voice_Queue_Reports",
32432 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32433 "version": "0.0.0",
32434 "filename": "server/api/voiceQueueReport/index.js",
32435 "groupTitle": "Voice_Queue_Reports"
32439 "url": "/api/voice/queues/{id}/users",
32440 "title": "Add agents to queue",
32443 "title": "Example usage:",
32444 "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",
32448 "name": "AddAgents",
32449 "group": "Voice_Queues",
32450 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32451 "version": "0.0.0",
32452 "filename": "server/api/voiceQueue/index.js",
32453 "groupTitle": "Voice_Queues"
32457 "url": "/api/voice/queues/{id}/blacklists",
32458 "title": "Add blacklists to a queue",
32461 "title": "Example usage:",
32462 "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",
32466 "name": "AddBlackLists",
32467 "group": "Voice_Queues",
32468 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32469 "version": "0.0.0",
32470 "filename": "server/api/voiceQueue/index.js",
32471 "groupTitle": "Voice_Queues"
32475 "url": "/api/voice/queues/{id}/lists",
32476 "title": "Add lists to a queue",
32479 "title": "Example usage:",
32480 "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",
32484 "name": "AddLists",
32485 "group": "Voice_Queues",
32486 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32487 "version": "0.0.0",
32488 "filename": "server/api/voiceQueue/index.js",
32489 "groupTitle": "Voice_Queues"
32493 "url": "/api/voice/queues/{id}/teams",
32494 "title": "Add teams to queue",
32497 "title": "Example usage:",
32498 "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",
32502 "name": "AddTeams",
32503 "group": "Voice_Queues",
32504 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32505 "version": "0.0.0",
32506 "filename": "server/api/voiceQueue/index.js",
32507 "groupTitle": "Voice_Queues"
32511 "url": "/api/voice/queues/clone",
32512 "title": "Clone an existing Queue",
32515 "title": "Example usage:",
32516 "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",
32520 "name": "CloneQueues",
32521 "group": "Voice_Queues",
32522 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32523 "version": "0.0.0",
32524 "filename": "server/api/voiceQueue/index.js",
32525 "groupTitle": "Voice_Queues"
32529 "url": "/api/voice/queues",
32530 "title": "Creates a new Queue",
32533 "title": "Example usage:",
32534 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32538 "name": "CreateQueues",
32539 "group": "Voice_Queues",
32565 "field": "musiconhold",
32572 "field": "announce",
32590 "field": "strategy",
32597 "field": "servicelevel",
32604 "field": "context",
32611 "field": "penaltymemberslimit",
32618 "field": "timeout",
32632 "field": "timeoutpriority",
32646 "field": "wrapuptime",
32657 "field": "autofill",
32669 "field": "autopause",
32676 "field": "autopausedelay",
32687 "field": "autopausebusy",
32698 "field": "autopauseunavail",
32716 "field": "setinterfacevar",
32727 "field": "setqueueentryvar",
32738 "field": "setqueuevar",
32749 "field": "eventmemberstatus",
32756 "field": "membermacro",
32763 "field": "membergosub",
32770 "field": "announce_frequency",
32777 "field": "min_announce_frequency",
32784 "field": "periodic_announce_frequency",
32795 "field": "random_periodic_announce",
32806 "field": "relative_periodic_announce",
32818 "field": "announce_holdtime",
32825 "field": "announce_position",
32836 "field": "announce_to_first_user",
32843 "field": "announce_position_limit",
32858 "field": "announce_round_seconds",
32865 "field": "monitor_format",
32872 "field": "monitor_type",
32879 "field": "queue_youarenext",
32886 "field": "queue_thereare",
32893 "field": "queue_callswaiting",
32900 "field": "queue_holdtime",
32907 "field": "queue_minute",
32914 "field": "queue_minutes",
32921 "field": "queue_seconds",
32928 "field": "queue_thankyou",
32935 "field": "queue_reporthold",
32942 "field": "queue_quantity1",
32949 "field": "queue_quantity2",
32956 "field": "queue_periodic_announce",
32963 "field": "queue_less_than",
32970 "field": "periodic_announce",
32977 "field": "joinempty",
32984 "field": "leavewhenempty",
32995 "field": "reportholdtime",
33006 "field": "ringinuse",
33013 "field": "memberdelay",
33024 "field": "timeoutrestart",
33031 "field": "defaultrule",
33038 "field": "description",
33052 "field": "acwTimeout",
33059 "field": "dialActive",
33060 "description": "<p>Active/Disactive Campaign</p>"
33073 "field": "dialMethod",
33074 "description": "<p>Dial Method.</p>"
33080 "field": "dialLimitChannel",
33081 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
33087 "field": "dialLimitQueue",
33088 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
33094 "field": "dialPowerLevel",
33095 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33101 "\"agentBusyFactor\"",
33105 "field": "dialPredictiveOptimization",
33106 "description": "<p>Only for predictive method.</p>"
33112 "field": "dialPredictiveOptimizationPercentage",
33113 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33119 "field": "dialPredictiveInterval",
33120 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33126 "field": "dialOriginateCallerIdName",
33133 "field": "dialOriginateCallerIdNumber",
33140 "field": "dialOriginateTimeout",
33141 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33147 "field": "dialQueueOptions",
33148 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33154 "field": "dialQueueTimeout",
33155 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33161 "field": "dialQueueProject",
33162 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33168 "field": "dialCongestionMaxRetry",
33169 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33175 "field": "dialCongestionRetryFrequency",
33176 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33182 "field": "dialBusyMaxRetry",
33183 "description": "<p>#Busy Retry (min:1, max:999)</p>"
33189 "field": "dialBusyRetryFrequency",
33190 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33196 "field": "dialNoAnswerMaxRetry",
33197 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33203 "field": "dialNoAnswerRetryFrequency",
33204 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33210 "field": "dialGlobalMaxRetry",
33211 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33217 "field": "dialTimezone",
33224 "field": "dialGlobalInterval",
33231 "field": "dialPrefix",
33243 "field": "dialCheckDuplicateType",
33250 "field": "dialAMDActive",
33251 "description": "<p>Active/Disactive AMD</p>"
33257 "field": "dialAMDInitialSilence",
33258 "description": "<p>#AMD Initial Silence</p>"
33264 "field": "dialAMDGreeting",
33265 "description": "<p>#AMD Greeting</p>"
33271 "field": "dialAMDAfterGreetingSilence",
33272 "description": "<p>#AMD After Greeting Silence</p>"
33278 "field": "dialAMDTotalAnalysisTime",
33279 "description": "<p>#AMD Total Analysis Time</p>"
33285 "field": "dialAMDMinWordLength",
33286 "description": "<p>#AMD Min Word Length</p>"
33292 "field": "dialAMDBetweenWordsSilence",
33293 "description": "<p>#AMD Between Words Silence</p>"
33299 "field": "dialAMDMaximumNumberOfWords",
33300 "description": "<p>#AMD Maximum Number Of Words</p>"
33306 "field": "dialAMDSilenceThreshold",
33307 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33313 "field": "dialAMDMaximumWordLength",
33314 "description": "<p>#AMD Maximum Word Length</p>"
33320 "field": "dialRecallMeTimeout",
33321 "description": "<p>#RecallMe Timeout (min:1)</p>"
33327 "field": "dialRecallInQueue",
33328 "description": "<p>Active/Disactive Recall In Queue</p>"
33338 "field": "dialOrderByScheduledAt",
33345 "field": "dialQueueProject2",
33346 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33352 "field": "dialAgiAfterHangupClient",
33359 "field": "dialAgiAfterHangupAgent",
33366 "field": "dialRandomLastDigitCallerIdNumber",
33367 "description": "<p>Random Last Digit (min:1, max:15)</p>"
33373 "field": "dialCutDigit",
33374 "description": "<p>Cut Digit (min:1, max:15)</p>"
33380 "field": "dialNoSuchNumberMaxRetry",
33381 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33387 "field": "dialNoSuchNumberRetryFrequency",
33388 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33394 "field": "dialDropMaxRetry",
33395 "description": "<p>#Drop Retry (min:1, max:999)</p>"
33401 "field": "dialDropRetryFrequency",
33402 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33408 "field": "dialAbandonedMaxRetry",
33409 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33415 "field": "dialAbandonedRetryFrequency",
33416 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33422 "field": "dialMachineMaxRetry",
33423 "description": "<p>#Machine Retry (min:1, max:999)</p>"
33429 "field": "dialMachineRetryFrequency",
33430 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33436 "field": "dialAgentRejectMaxRetry",
33437 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33443 "field": "dialAgentRejectRetryFrequency",
33444 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33450 "field": "mandatoryDispositionPauseId",
33451 "description": "<p>Status to put when mandatory disposition is enabled</p>"
33457 "field": "mandatoryDisposition",
33458 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33464 "field": "dialPredictiveIntervalMaxThreshold",
33471 "field": "dialPredictiveIntervalMinThreshold",
33477 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33478 "version": "0.0.0",
33479 "filename": "server/api/voiceQueue/index.js",
33480 "groupTitle": "Voice_Queues"
33484 "url": "/api/voice/queues/{id}",
33485 "title": "Deletes a Queue",
33488 "title": "Example usage:",
33489 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33493 "name": "DeleteQueues",
33494 "group": "Voice_Queues",
33495 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33496 "version": "0.0.0",
33497 "filename": "server/api/voiceQueue/index.js",
33498 "groupTitle": "Voice_Queues"
33502 "url": "/api/voice/queues/{id}/users",
33503 "title": "Gets queue agents",
33506 "title": "Example usage:",
33507 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33511 "name": "GetAgents",
33512 "group": "Voice_Queues",
33513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33514 "version": "0.0.0",
33515 "filename": "server/api/voiceQueue/index.js",
33516 "groupTitle": "Voice_Queues"
33520 "url": "/api/voice/queues/{id}/blacklists",
33521 "title": "Get queue blacklists",
33524 "title": "Example usage:",
33525 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33529 "name": "GetBlackLists",
33530 "group": "Voice_Queues",
33531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33532 "version": "0.0.0",
33533 "filename": "server/api/voiceQueue/index.js",
33534 "groupTitle": "Voice_Queues"
33538 "url": "/api/voice/queues/{id}/finals",
33539 "title": "Gets queue hopper finals",
33542 "title": "Example usage:",
33543 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
33547 "name": "GetHopperFinals",
33548 "group": "Voice_Queues",
33549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33550 "version": "0.0.0",
33551 "filename": "server/api/voiceQueue/index.js",
33552 "groupTitle": "Voice_Queues"
33556 "url": "/api/voice/queues/{id}/hopper_histories",
33557 "title": "Gets queue hopper histories",
33560 "title": "Example usage:",
33561 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33565 "name": "GetHopperHistories",
33566 "group": "Voice_Queues",
33567 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33568 "version": "0.0.0",
33569 "filename": "server/api/voiceQueue/index.js",
33570 "groupTitle": "Voice_Queues"
33574 "url": "/api/voice/queues/{id}/hoppers",
33575 "title": "Gets queue hoppers",
33578 "title": "Example usage:",
33579 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33583 "name": "GetHoppers",
33584 "group": "Voice_Queues",
33585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33586 "version": "0.0.0",
33587 "filename": "server/api/voiceQueue/index.js",
33588 "groupTitle": "Voice_Queues"
33592 "url": "/api/voice/queues/{id}/lists",
33593 "title": "Get queue lists",
33596 "title": "Example usage:",
33597 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33601 "name": "GetLists",
33602 "group": "Voice_Queues",
33603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33604 "version": "0.0.0",
33605 "filename": "server/api/voiceQueue/index.js",
33606 "groupTitle": "Voice_Queues"
33610 "url": "/api/voice/queues/{id}/members",
33611 "title": "Gets queue members",
33614 "title": "Example usage:",
33615 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33619 "name": "GetMembers",
33620 "group": "Voice_Queues",
33621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33622 "version": "0.0.0",
33623 "filename": "server/api/voiceQueue/index.js",
33624 "groupTitle": "Voice_Queues"
33628 "url": "/api/voice/queues",
33629 "title": "Gets a list of Queues",
33632 "title": "Example usage:",
33633 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33637 "name": "GetQueues",
33638 "group": "Voice_Queues",
33639 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33640 "version": "0.0.0",
33641 "filename": "server/api/voiceQueue/index.js",
33642 "groupTitle": "Voice_Queues"
33646 "url": "/api/voice/queues/{id}/teams",
33647 "title": "Gets queue team",
33650 "title": "Example usage:",
33651 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33655 "name": "GetTeams",
33656 "group": "Voice_Queues",
33657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33658 "version": "0.0.0",
33659 "filename": "server/api/voiceQueue/index.js",
33660 "groupTitle": "Voice_Queues"
33664 "url": "/api/voice/queues/{id}/users",
33665 "title": "Removes agents from a queue",
33668 "title": "Example usage:",
33669 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33673 "name": "RemoveAgents",
33674 "group": "Voice_Queues",
33675 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33676 "version": "0.0.0",
33677 "filename": "server/api/voiceQueue/index.js",
33678 "groupTitle": "Voice_Queues"
33682 "url": "/api/voice/queues/{id}/blacklists",
33683 "title": "Remove blacklists from a queue",
33686 "title": "Example usage:",
33687 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33691 "name": "RemoveBlackLists",
33692 "group": "Voice_Queues",
33693 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33694 "version": "0.0.0",
33695 "filename": "server/api/voiceQueue/index.js",
33696 "groupTitle": "Voice_Queues"
33700 "url": "/api/voice/queues/{id}/lists",
33701 "title": "Remove lists from a queue",
33704 "title": "Example usage:",
33705 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33709 "name": "RemoveLists",
33710 "group": "Voice_Queues",
33711 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33712 "version": "0.0.0",
33713 "filename": "server/api/voiceQueue/index.js",
33714 "groupTitle": "Voice_Queues"
33718 "url": "/api/voice/queues/{id}",
33719 "title": "Gets a single Queue",
33722 "title": "Example usage:",
33723 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33727 "name": "ShowQueues",
33728 "group": "Voice_Queues",
33729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33730 "version": "0.0.0",
33731 "filename": "server/api/voiceQueue/index.js",
33732 "groupTitle": "Voice_Queues"
33736 "url": "/api/voice/queues/{id}/blacks",
33737 "title": "Gets queue hopper blacks",
33740 "title": "Example usage:",
33741 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33745 "name": "getHopperBlacks",
33746 "group": "Voice_Queues",
33747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33748 "version": "0.0.0",
33749 "filename": "server/api/voiceQueue/index.js",
33750 "groupTitle": "Voice_Queues"
33754 "url": "/api/voice/queues/{id}",
33755 "title": "Update an existing Queue",
33758 "title": "Example usage:",
33759 "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",
33763 "name": "updateQueues",
33764 "group": "Voice_Queues",
33765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33766 "version": "0.0.0",
33767 "filename": "server/api/voiceQueue/index.js",
33768 "groupTitle": "Voice_Queues"
33772 "url": "/api/voice/recordings",
33773 "title": "Creates a new Recording",
33776 "title": "Example usage:",
33777 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33781 "name": "CreateRecordings",
33782 "group": "Voice_Recordings",
33797 "field": "uniqueid",
33804 "field": "channel",
33811 "field": "membername",
33818 "field": "calleridnum",
33825 "field": "calleridname",
33832 "field": "connectedlinenum",
33839 "field": "connectedlinename",
33846 "field": "accountcode",
33853 "field": "context",
33895 "field": "userDisposition",
33902 "field": "location",
33909 "field": "transcribeName",
33916 "field": "transcribeStatus",
33923 "field": "fileUri",
33930 "field": "fileText",
33937 "field": "failureReason",
33944 "field": "sentiment",
33951 "field": "sPositive",
33958 "field": "sNegative",
33965 "field": "sNeutral",
33979 "field": "tempSentiment",
33986 "field": "createdAt",
33993 "field": "updatedAt",
33999 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34000 "version": "0.0.0",
34001 "filename": "server/api/voiceRecording/index.js",
34002 "groupTitle": "Voice_Recordings"
34006 "url": "/api/voice/recordings/describe",
34007 "title": "Gets table info about Recordings",
34010 "title": "Example usage:",
34011 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
34015 "name": "DescribeRecordings",
34016 "group": "Voice_Recordings",
34017 "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>",
34018 "version": "0.0.0",
34019 "filename": "server/api/voiceRecording/index.js",
34020 "groupTitle": "Voice_Recordings"
34024 "url": "/api/voice/recordings",
34025 "title": "Gets a list of Recordings",
34028 "title": "Example usage:",
34029 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
34033 "name": "GetRecordings",
34034 "group": "Voice_Recordings",
34035 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34036 "version": "0.0.0",
34037 "filename": "server/api/voiceRecording/index.js",
34038 "groupTitle": "Voice_Recordings"
34042 "url": "/api/voice/recordings/{id}",
34043 "title": "Gets a single Recording",
34046 "title": "Example usage:",
34047 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
34051 "name": "ShowRecordings",
34052 "group": "Voice_Recordings",
34053 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34054 "version": "0.0.0",
34055 "filename": "server/api/voiceRecording/index.js",
34056 "groupTitle": "Voice_Recordings"
34060 "url": "/api/voice/recordings/{id}",
34061 "title": "Delete voice recording",
34064 "title": "Example usage:",
34065 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
34070 "group": "Voice_Recordings",
34071 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34072 "version": "0.0.0",
34073 "filename": "server/api/voiceRecording/index.js",
34074 "groupTitle": "Voice_Recordings"
34078 "url": "/api/voice/recordings/{id}/download",
34079 "title": "Download Recording",
34082 "title": "Example usage:",
34083 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34087 "name": "download",
34088 "group": "Voice_Recordings",
34089 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34090 "version": "0.0.0",
34091 "filename": "server/api/voiceRecording/index.js",
34092 "groupTitle": "Voice_Recordings"
34096 "url": "/api/voice/recordings/{id}/downloads",
34097 "title": "Download Recording",
34100 "title": "Example usage:",
34101 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34105 "name": "downloads",
34106 "group": "Voice_Recordings",
34107 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34108 "version": "0.0.0",
34109 "filename": "server/api/voiceRecording/index.js",
34110 "groupTitle": "Voice_Recordings"
34114 "url": "/api/voice/recordings/{id}/transcribe",
34115 "title": "Run Transcribe Recording",
34118 "title": "Example usage:",
34119 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34123 "name": "transcribe",
34124 "group": "Voice_Recordings",
34125 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34126 "version": "0.0.0",
34127 "filename": "server/api/voiceRecording/index.js",
34128 "groupTitle": "Voice_Recordings"
34132 "url": "/api/voice/recordings/{id}/transcribe",
34133 "title": "Run Transcribe Recording",
34136 "title": "Example usage:",
34137 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34141 "name": "transcribe",
34142 "group": "Voice_Recordings",
34143 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34144 "version": "0.0.0",
34145 "filename": "server/api/voiceRecording/index.js",
34146 "groupTitle": "Voice_Recordings"
34150 "url": "/api/voice/recordings/{id}",
34151 "title": "Update an existing Recording",
34154 "title": "Example usage:",
34155 "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",
34159 "name": "updateRecordings",
34160 "group": "Voice_Recordings",
34161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34162 "version": "0.0.0",
34163 "filename": "server/api/voiceRecording/index.js",
34164 "groupTitle": "Voice_Recordings"
34168 "url": "/api/voice/transfers/reports",
34169 "title": "Creates a new Transfer Report",
34172 "title": "Example usage:",
34173 "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",
34177 "name": "CreateTransfer_Reports",
34178 "group": "Voice_Transfer_Reports",
34204 "field": "transfererchannel",
34211 "field": "transferercalleridnum",
34218 "field": "transferercalleridname",
34225 "field": "transfererconnectedlinenum",
34232 "field": "transfererconnectedlinename",
34239 "field": "transfereraccountcode",
34246 "field": "transferercontext",
34253 "field": "transfererexten",
34260 "field": "transfererlinkedid",
34267 "field": "transfereechannel",
34274 "field": "transfereecalleridnum",
34281 "field": "transfereecalleridname",
34288 "field": "transfereeconnectedlinenum",
34295 "field": "transfereeconnectedlinename",
34302 "field": "transfereeaccountcode",
34309 "field": "transfereecontext",
34316 "field": "transfereeexten",
34323 "field": "transfereelinkedid",
34334 "field": "isexternal",
34341 "field": "context",
34348 "field": "extension",
34354 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34355 "version": "0.0.0",
34356 "filename": "server/api/voiceTransferReport/index.js",
34357 "groupTitle": "Voice_Transfer_Reports"
34361 "url": "/api/voice/transfers/reports/{id}",
34362 "title": "Deletes a Transfer Report",
34365 "title": "Example usage:",
34366 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34370 "name": "DeleteTransfer_Reports",
34371 "group": "Voice_Transfer_Reports",
34372 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34373 "version": "0.0.0",
34374 "filename": "server/api/voiceTransferReport/index.js",
34375 "groupTitle": "Voice_Transfer_Reports"
34379 "url": "/api/voice/transfers/reports",
34380 "title": "Gets a list of Transfer Reports",
34383 "title": "Example usage:",
34384 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34388 "name": "GetTransfer_Reports",
34389 "group": "Voice_Transfer_Reports",
34390 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34391 "version": "0.0.0",
34392 "filename": "server/api/voiceTransferReport/index.js",
34393 "groupTitle": "Voice_Transfer_Reports"
34397 "url": "/api/voice/transfers/reports/{id}",
34398 "title": "Gets a single Transfer Report",
34401 "title": "Example usage:",
34402 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34406 "name": "ShowTransfer_Reports",
34407 "group": "Voice_Transfer_Reports",
34408 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34409 "version": "0.0.0",
34410 "filename": "server/api/voiceTransferReport/index.js",
34411 "groupTitle": "Voice_Transfer_Reports"
34415 "url": "/api/voice/transfers/reports/{id}",
34416 "title": "Update an existing Transfer Report",
34419 "title": "Example usage:",
34420 "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",
34424 "name": "updateTransfer_Reports",
34425 "group": "Voice_Transfer_Reports",
34426 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34427 "version": "0.0.0",
34428 "filename": "server/api/voiceTransferReport/index.js",
34429 "groupTitle": "Voice_Transfer_Reports"
34433 "url": "/api/integrations/vtiger/accounts",
34434 "title": "Creates a new Vtiger Account",
34437 "title": "Example usage:",
34438 "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",
34442 "name": "CreateVtiger_Accounts",
34443 "group": "Vtiger_Accounts",
34458 "field": "description",
34465 "field": "username",
34472 "field": "moduleName",
34479 "field": "remoteUri",
34486 "field": "serverUrl",
34493 "field": "accessKey",
34499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34500 "version": "0.0.0",
34501 "filename": "server/api/intVtigerAccount/index.js",
34502 "groupTitle": "Vtiger_Accounts"
34506 "url": "/api/integrations/vtiger/accounts/{id}",
34507 "title": "Deletes a Vtiger Account",
34510 "title": "Example usage:",
34511 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34515 "name": "DeleteVtiger_Accounts",
34516 "group": "Vtiger_Accounts",
34517 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34518 "version": "0.0.0",
34519 "filename": "server/api/intVtigerAccount/index.js",
34520 "groupTitle": "Vtiger_Accounts"
34524 "url": "/api/integrations/vtiger/accounts",
34525 "title": "Gets a list of Vtiger Accounts",
34528 "title": "Example usage:",
34529 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34533 "name": "GetVtiger_Accounts",
34534 "group": "Vtiger_Accounts",
34535 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34536 "version": "0.0.0",
34537 "filename": "server/api/intVtigerAccount/index.js",
34538 "groupTitle": "Vtiger_Accounts"
34542 "url": "/api/integrations/vtiger/accounts/{id}",
34543 "title": "Gets a single Vtiger Account",
34546 "title": "Example usage:",
34547 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34551 "name": "ShowVtiger_Accounts",
34552 "group": "Vtiger_Accounts",
34553 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34554 "version": "0.0.0",
34555 "filename": "server/api/intVtigerAccount/index.js",
34556 "groupTitle": "Vtiger_Accounts"
34560 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34561 "title": "Creates new configuration",
34564 "title": "Example usage:",
34565 "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",
34569 "name": "addConfiguration",
34570 "group": "Vtiger_Accounts",
34571 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34572 "version": "0.0.0",
34573 "filename": "server/api/intVtigerAccount/index.js",
34574 "groupTitle": "Vtiger_Accounts"
34578 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34579 "title": "Gets account configurations",
34582 "title": "Example usage:",
34583 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34587 "name": "getConfigurations",
34588 "group": "Vtiger_Accounts",
34589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34590 "version": "0.0.0",
34591 "filename": "server/api/intVtigerAccount/index.js",
34592 "groupTitle": "Vtiger_Accounts"
34596 "url": "/api/integrations/vtiger/accounts/{id}/fields",
34597 "title": "Gets account fields",
34600 "title": "Example usage:",
34601 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34605 "name": "getFields",
34606 "group": "Vtiger_Accounts",
34607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34608 "version": "0.0.0",
34609 "filename": "server/api/intVtigerAccount/index.js",
34610 "groupTitle": "Vtiger_Accounts"
34614 "url": "/api/integrations/vtiger/accounts/{id}",
34615 "title": "Update an existing Vtiger Account",
34618 "title": "Example usage:",
34619 "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",
34623 "name": "updateVtiger_Accounts",
34624 "group": "Vtiger_Accounts",
34625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34626 "version": "0.0.0",
34627 "filename": "server/api/intVtigerAccount/index.js",
34628 "groupTitle": "Vtiger_Accounts"
34632 "url": "/api/integrations/vtiger/configurations",
34633 "title": "Creates a new Vtiger Configuration",
34636 "title": "Example usage:",
34637 "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",
34641 "name": "CreateVtiger_Configurations",
34642 "group": "Vtiger_Configurations",
34657 "field": "description",
34663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34664 "version": "0.0.0",
34665 "filename": "server/api/intVtigerConfiguration/index.js",
34666 "groupTitle": "Vtiger_Configurations"
34670 "url": "/api/integrations/vtiger/configurations/{id}",
34671 "title": "Deletes a Vtiger Configuration",
34674 "title": "Example usage:",
34675 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34679 "name": "DeleteVtiger_Configurations",
34680 "group": "Vtiger_Configurations",
34681 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34682 "version": "0.0.0",
34683 "filename": "server/api/intVtigerConfiguration/index.js",
34684 "groupTitle": "Vtiger_Configurations"
34688 "url": "/api/integrations/vtiger/configurations",
34689 "title": "Gets a list of Vtiger Configurations",
34692 "title": "Example usage:",
34693 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34697 "name": "GetVtiger_Configurations",
34698 "group": "Vtiger_Configurations",
34699 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34700 "version": "0.0.0",
34701 "filename": "server/api/intVtigerConfiguration/index.js",
34702 "groupTitle": "Vtiger_Configurations"
34706 "url": "/api/integrations/vtiger/configurations/{id}",
34707 "title": "Gets a single Vtiger Configuration",
34710 "title": "Example usage:",
34711 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34715 "name": "ShowVtiger_Configurations",
34716 "group": "Vtiger_Configurations",
34717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34718 "version": "0.0.0",
34719 "filename": "server/api/intVtigerConfiguration/index.js",
34720 "groupTitle": "Vtiger_Configurations"
34724 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34725 "title": "Gets configurations descriptions",
34728 "title": "Example usage:",
34729 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34733 "name": "getDescriptions",
34734 "group": "Vtiger_Configurations",
34735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34736 "version": "0.0.0",
34737 "filename": "server/api/intVtigerConfiguration/index.js",
34738 "groupTitle": "Vtiger_Configurations"
34742 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34743 "title": "Gets configurations fields",
34746 "title": "Example usage:",
34747 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34751 "name": "getFields",
34752 "group": "Vtiger_Configurations",
34753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34754 "version": "0.0.0",
34755 "filename": "server/api/intVtigerConfiguration/index.js",
34756 "groupTitle": "Vtiger_Configurations"
34760 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34761 "title": "Gets configurations subjects",
34764 "title": "Example usage:",
34765 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34769 "name": "getSubjects",
34770 "group": "Vtiger_Configurations",
34771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34772 "version": "0.0.0",
34773 "filename": "server/api/intVtigerConfiguration/index.js",
34774 "groupTitle": "Vtiger_Configurations"
34778 "url": "/api/integrations/vtiger/configurations/{id}",
34779 "title": "Update an existing Vtiger Configuration",
34782 "title": "Example usage:",
34783 "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",
34787 "name": "updateVtiger_Configurations",
34788 "group": "Vtiger_Configurations",
34789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34790 "version": "0.0.0",
34791 "filename": "server/api/intVtigerConfiguration/index.js",
34792 "groupTitle": "Vtiger_Configurations"
34796 "url": "/api/integrations/vtiger/fields",
34797 "title": "Creates a new Vtiger Field",
34800 "title": "Example usage:",
34801 "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",
34805 "name": "CreateVtiger_Fields",
34806 "group": "Vtiger_Fields",
34816 "\"customVariable\"",
34827 "field": "content",
34843 "\"customVariable\""
34846 "field": "keyType",
34853 "field": "keyContent",
34860 "field": "idField",
34867 "field": "nameField",
34874 "field": "customField",
34881 "field": "variableName",
34887 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34888 "version": "0.0.0",
34889 "filename": "server/api/intVtigerField/index.js",
34890 "groupTitle": "Vtiger_Fields"
34894 "url": "/api/integrations/vtiger/fields/{id}",
34895 "title": "Deletes a Vtiger Field",
34898 "title": "Example usage:",
34899 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34903 "name": "DeleteVtiger_Fields",
34904 "group": "Vtiger_Fields",
34905 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34906 "version": "0.0.0",
34907 "filename": "server/api/intVtigerField/index.js",
34908 "groupTitle": "Vtiger_Fields"
34912 "url": "/api/integrations/vtiger/fields",
34913 "title": "Gets a list of Vtiger Fields",
34916 "title": "Example usage:",
34917 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34921 "name": "GetVtiger_Fields",
34922 "group": "Vtiger_Fields",
34923 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34924 "version": "0.0.0",
34925 "filename": "server/api/intVtigerField/index.js",
34926 "groupTitle": "Vtiger_Fields"
34930 "url": "/api/integrations/vtiger/fields/{id}",
34931 "title": "Gets a single Vtiger Field",
34934 "title": "Example usage:",
34935 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34939 "name": "ShowVtiger_Fields",
34940 "group": "Vtiger_Fields",
34941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34942 "version": "0.0.0",
34943 "filename": "server/api/intVtigerField/index.js",
34944 "groupTitle": "Vtiger_Fields"
34948 "url": "/api/integrations/vtiger/fields/{id}",
34949 "title": "Update an existing Vtiger Field",
34952 "title": "Example usage:",
34953 "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",
34957 "name": "updateVtiger_Fields",
34958 "group": "Vtiger_Fields",
34959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34960 "version": "0.0.0",
34961 "filename": "server/api/intVtigerField/index.js",
34962 "groupTitle": "Vtiger_Fields"
34966 "url": "/api/webbar/answer",
34967 "title": "answer webrtc call",
34970 "title": "Example usage:",
34971 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34975 "name": "Web_Bar_answer",
34984 "field": "sessionId",
34997 "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>",
34998 "version": "0.0.0",
34999 "filename": "server/api/webbar/index.js",
35000 "groupTitle": "WebBar"
35004 "url": "/api/webbar/calls",
35005 "title": "webrtc call list",
35008 "title": "Example usage:",
35009 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35013 "name": "Web_Bar_calls",
35028 "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>",
35029 "version": "0.0.0",
35030 "filename": "server/api/webbar/index.js",
35031 "groupTitle": "WebBar"
35035 "url": "/api/webbar/hangup",
35036 "title": "hangup webrtc call",
35039 "title": "Example usage:",
35040 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35044 "name": "Web_Bar_hangup",
35053 "field": "sessionId",
35066 "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>",
35067 "version": "0.0.0",
35068 "filename": "server/api/webbar/index.js",
35069 "groupTitle": "WebBar"
35073 "url": "/api/webbar/hold",
35074 "title": "hold webrtc call",
35077 "title": "Example usage:",
35078 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35082 "name": "Web_Bar_hold",
35091 "field": "sessionId",
35104 "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>",
35105 "version": "0.0.0",
35106 "filename": "server/api/webbar/index.js",
35107 "groupTitle": "WebBar"
35111 "url": "/api/webbar/unhold",
35112 "title": "unhold webrtc call",
35115 "title": "Example usage:",
35116 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35120 "name": "Web_Bar_hold",
35129 "field": "sessionId",
35142 "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>",
35143 "version": "0.0.0",
35144 "filename": "server/api/webbar/index.js",
35145 "groupTitle": "WebBar"
35149 "url": "/api/webbar/originate",
35150 "title": "Originate new webrtc call",
35153 "title": "Example usage:",
35154 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35158 "name": "Web_Bar_originate",
35167 "field": "callNumber",
35181 "field": "callerId",
35188 "field": "callbackUrl",
35194 "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>",
35195 "version": "0.0.0",
35196 "filename": "server/api/webbar/index.js",
35197 "groupTitle": "WebBar"
35201 "url": "/api/webbar/transfer",
35202 "title": "blind transfer webrtc call",
35205 "title": "Example usage:",
35206 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35210 "name": "Web_Bar_transfer",
35226 "field": "sessionId",
35233 "field": "transferNumber",
35239 "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>",
35240 "version": "0.0.0",
35241 "filename": "server/api/webbar/index.js",
35242 "groupTitle": "WebBar"
35246 "url": "/api/whatsapp/accounts/{id}/users",
35247 "title": "Add agents to a whatsapp account",
35250 "title": "Example usage:",
35251 "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",
35255 "name": "AddAgents",
35256 "group": "Whatsapp_Accounts",
35257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35258 "version": "0.0.0",
35259 "filename": "server/api/whatsappAccount/index.js",
35260 "groupTitle": "Whatsapp_Accounts"
35264 "url": "/api/whatsapp/accounts",
35265 "title": "Creates a new Account",
35268 "title": "Example usage:",
35269 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35273 "name": "CreateAccounts",
35274 "group": "Whatsapp_Accounts",
35327 "field": "accountSid",
35334 "field": "authToken",
35341 "field": "notificationTemplate",
35348 "field": "notificationSound",
35355 "field": "notificationShake",
35362 "field": "waitForTheAssignedAgent",
35369 "field": "queueTransfer",
35376 "field": "queueTransferTimeout",
35383 "field": "agentTransfer",
35390 "field": "agentTransferTimeout",
35397 "field": "mandatoryDispositionPauseId",
35398 "description": "<p>Status to put when mandatory disposition is enabled</p>"
35404 "field": "mandatoryDisposition",
35405 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35411 "field": "description",
35417 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35418 "version": "0.0.0",
35419 "filename": "server/api/whatsappAccount/index.js",
35420 "groupTitle": "Whatsapp_Accounts"
35424 "url": "/api/whatsapp/accounts/{id}",
35425 "title": "Deletes a Account",
35428 "title": "Example usage:",
35429 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35433 "name": "DeleteAccounts",
35434 "group": "Whatsapp_Accounts",
35435 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35436 "version": "0.0.0",
35437 "filename": "server/api/whatsappAccount/index.js",
35438 "groupTitle": "Whatsapp_Accounts"
35442 "url": "/api/whatsapp/accounts/describe",
35443 "title": "Gets table info about Accounts",
35446 "title": "Example usage:",
35447 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35451 "name": "DescribeAccounts",
35452 "group": "Whatsapp_Accounts",
35453 "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>",
35454 "version": "0.0.0",
35455 "filename": "server/api/whatsappAccount/index.js",
35456 "groupTitle": "Whatsapp_Accounts"
35460 "url": "/api/whatsapp/accounts",
35461 "title": "Gets a list of Accounts",
35464 "title": "Example usage:",
35465 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35469 "name": "GetAccounts",
35470 "group": "Whatsapp_Accounts",
35471 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35472 "version": "0.0.0",
35473 "filename": "server/api/whatsappAccount/index.js",
35474 "groupTitle": "Whatsapp_Accounts"
35478 "url": "/api/whatsapp/accounts/{id}/users",
35479 "title": "Gets agents from whatsapp account",
35482 "title": "Example usage:",
35483 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35487 "name": "GetAgents",
35488 "group": "Whatsapp_Accounts",
35489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35490 "version": "0.0.0",
35491 "filename": "server/api/whatsappAccount/index.js",
35492 "groupTitle": "Whatsapp_Accounts"
35496 "url": "/api/whatsapp/accounts/{id}/users",
35497 "title": "Removes agents from a whatsapp account",
35500 "title": "Example usage:",
35501 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35505 "name": "RemoveAgents",
35506 "group": "Whatsapp_Accounts",
35507 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35508 "version": "0.0.0",
35509 "filename": "server/api/whatsappAccount/index.js",
35510 "groupTitle": "Whatsapp_Accounts"
35514 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35515 "title": "Removes canned answers from account",
35518 "title": "Example usage:",
35519 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35523 "name": "RemoveAnswers",
35524 "group": "Whatsapp_Accounts",
35525 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35526 "version": "0.0.0",
35527 "filename": "server/api/whatsappAccount/index.js",
35528 "groupTitle": "Whatsapp_Accounts"
35532 "url": "/api/whatsapp/accounts/{id}/dispositions",
35533 "title": "Removes dispositions from account",
35536 "title": "Example usage:",
35537 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35541 "name": "RemoveDispositions",
35542 "group": "Whatsapp_Accounts",
35543 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35544 "version": "0.0.0",
35545 "filename": "server/api/whatsappAccount/index.js",
35546 "groupTitle": "Whatsapp_Accounts"
35550 "url": "/api/whatsapp/accounts/{id}",
35551 "title": "Gets a single Account",
35554 "title": "Example usage:",
35555 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35559 "name": "ShowAccounts",
35560 "group": "Whatsapp_Accounts",
35561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35562 "version": "0.0.0",
35563 "filename": "server/api/whatsappAccount/index.js",
35564 "groupTitle": "Whatsapp_Accounts"
35568 "url": "/api/whatsapp/messages/{id}/accept",
35569 "title": "Accepts message",
35572 "title": "Example usage:",
35573 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35577 "name": "acceptMessage",
35578 "group": "Whatsapp_Accounts",
35579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35580 "version": "0.0.0",
35581 "filename": "server/api/whatsappMessage/index.js",
35582 "groupTitle": "Whatsapp_Accounts"
35586 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35587 "title": "Creates new canned answer",
35590 "title": "Example usage:",
35591 "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",
35595 "name": "addAnswer",
35596 "group": "Whatsapp_Accounts",
35618 "field": "description",
35631 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35632 "version": "0.0.0",
35633 "filename": "server/api/whatsappAccount/index.js",
35634 "groupTitle": "Whatsapp_Accounts"
35638 "url": "/api/whatsapp/accounts/{id}/applications",
35639 "title": "Creates new applications",
35642 "title": "Example usage:",
35643 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35647 "name": "addApplications",
35648 "group": "Whatsapp_Accounts",
35656 "field": "priority",
35670 "field": "appdata",
35677 "field": "description",
35684 "field": "interval",
35690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35691 "version": "0.0.0",
35692 "filename": "server/api/whatsappAccount/index.js",
35693 "groupTitle": "Whatsapp_Accounts"
35697 "url": "/api/whatsapp/accounts/{id}/dispositions",
35698 "title": "Creates new disposition",
35701 "title": "Example usage:",
35702 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35706 "name": "addDisposition",
35707 "group": "Whatsapp_Accounts",
35721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35722 "version": "0.0.0",
35723 "filename": "server/api/whatsappAccount/index.js",
35724 "groupTitle": "Whatsapp_Accounts"
35728 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35729 "title": "Gets account canned answers",
35732 "title": "Example usage:",
35733 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35737 "name": "getAnswers",
35738 "group": "Whatsapp_Accounts",
35739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35740 "version": "0.0.0",
35741 "filename": "server/api/whatsappAccount/index.js",
35742 "groupTitle": "Whatsapp_Accounts"
35746 "url": "/api/whatsapp/accounts/{id}/applications",
35747 "title": "Gets account applications",
35750 "title": "Example usage:",
35751 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35755 "name": "getApplications",
35756 "group": "Whatsapp_Accounts",
35757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35758 "version": "0.0.0",
35759 "filename": "server/api/whatsappAccount/index.js",
35760 "groupTitle": "Whatsapp_Accounts"
35764 "url": "/api/whatsapp/accounts/{id}/dispositions",
35765 "title": "Gets account dispositions",
35768 "title": "Example usage:",
35769 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35773 "name": "getDispositions",
35774 "group": "Whatsapp_Accounts",
35775 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35776 "version": "0.0.0",
35777 "filename": "server/api/whatsappAccount/index.js",
35778 "groupTitle": "Whatsapp_Accounts"
35782 "url": "/api/whatsapp/accounts/{id}/notify",
35783 "title": "Notify new message",
35786 "title": "Example usage:",
35787 "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",
35792 "group": "Whatsapp_Accounts",
35793 "description": "<p>Motion 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>",
35794 "version": "0.0.0",
35795 "filename": "server/api/whatsappAccount/index.js",
35796 "groupTitle": "Whatsapp_Accounts"
35800 "url": "/api/whatsapp/messages/{id}/reject",
35801 "title": "Rejects message",
35804 "title": "Example usage:",
35805 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35809 "name": "rejectMessage",
35810 "group": "Whatsapp_Accounts",
35811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35812 "version": "0.0.0",
35813 "filename": "server/api/whatsappMessage/index.js",
35814 "groupTitle": "Whatsapp_Accounts"
35818 "url": "/api/whatsapp/accounts/{id}/send",
35819 "title": "Send new whatsapp message",
35822 "title": "Example usage:",
35823 "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",
35827 "name": "sendWhatsapp",
35828 "group": "Whatsapp_Accounts",
35829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35830 "version": "0.0.0",
35831 "filename": "server/api/whatsappAccount/index.js",
35832 "groupTitle": "Whatsapp_Accounts"
35836 "url": "/api/whatsapp/messages/{id}/status",
35837 "title": "Receive message status",
35840 "title": "Example usage:",
35841 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35845 "name": "statusMessage",
35846 "group": "Whatsapp_Accounts",
35847 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35848 "version": "0.0.0",
35849 "filename": "server/api/whatsappMessage/index.js",
35850 "groupTitle": "Whatsapp_Accounts"
35854 "url": "/api/whatsapp/accounts/{id}",
35855 "title": "Update an existing Account",
35858 "title": "Example usage:",
35859 "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",
35863 "name": "updateAccounts",
35864 "group": "Whatsapp_Accounts",
35865 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35866 "version": "0.0.0",
35867 "filename": "server/api/whatsappAccount/index.js",
35868 "groupTitle": "Whatsapp_Accounts"
35872 "url": "/api/whatsapp/applications",
35873 "title": "Creates a new Application",
35876 "title": "Example usage:",
35877 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35881 "name": "CreateApplications",
35882 "group": "Whatsapp_Applications",
35890 "field": "priority",
35904 "field": "appdata",
35911 "field": "description",
35918 "field": "interval",
35924 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35925 "version": "0.0.0",
35926 "filename": "server/api/whatsappApplication/index.js",
35927 "groupTitle": "Whatsapp_Applications"
35931 "url": "/api/whatsapp/applications/{id}",
35932 "title": "Deletes a Application",
35935 "title": "Example usage:",
35936 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35940 "name": "DeleteApplications",
35941 "group": "Whatsapp_Applications",
35942 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35943 "version": "0.0.0",
35944 "filename": "server/api/whatsappApplication/index.js",
35945 "groupTitle": "Whatsapp_Applications"
35949 "url": "/api/whatsapp/applications",
35950 "title": "Gets a list of Applications",
35953 "title": "Example usage:",
35954 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35958 "name": "GetApplications",
35959 "group": "Whatsapp_Applications",
35960 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35961 "version": "0.0.0",
35962 "filename": "server/api/whatsappApplication/index.js",
35963 "groupTitle": "Whatsapp_Applications"
35967 "url": "/api/whatsapp/applications/{id}",
35968 "title": "Gets a single Application",
35971 "title": "Example usage:",
35972 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35976 "name": "ShowApplications",
35977 "group": "Whatsapp_Applications",
35978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35979 "version": "0.0.0",
35980 "filename": "server/api/whatsappApplication/index.js",
35981 "groupTitle": "Whatsapp_Applications"
35985 "url": "/api/whatsapp/applications/{id}",
35986 "title": "Update an existing Application",
35989 "title": "Example usage:",
35990 "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",
35994 "name": "updateApplications",
35995 "group": "Whatsapp_Applications",
35996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35997 "version": "0.0.0",
35998 "filename": "server/api/whatsappApplication/index.js",
35999 "groupTitle": "Whatsapp_Applications"
36003 "url": "/api/whatsapp/interactions/{id}/tags",
36004 "title": "Add tags to the interaction",
36007 "title": "Example usage:",
36008 "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",
36013 "group": "Whatsapp_Interactions",
36014 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36015 "version": "0.0.0",
36016 "filename": "server/api/whatsappInteraction/index.js",
36017 "groupTitle": "Whatsapp_Interactions"
36021 "url": "/api/whatsapp/interactions",
36022 "title": "Creates a new Interaction",
36025 "title": "Example usage:",
36026 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36030 "name": "CreateInteractions",
36031 "group": "Whatsapp_Interactions",
36046 "field": "closedAt",
36053 "field": "disposition",
36074 "field": "read1stAt",
36085 "field": "firstMsgDirection",
36092 "field": "lastMsgAt",
36103 "field": "lastMsgDirection",
36109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36110 "version": "0.0.0",
36111 "filename": "server/api/whatsappInteraction/index.js",
36112 "groupTitle": "Whatsapp_Interactions"
36116 "url": "/api/whatsapp/interactions/{id}",
36117 "title": "Deletes a Interaction",
36120 "title": "Example usage:",
36121 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36125 "name": "DeleteInteractions",
36126 "group": "Whatsapp_Interactions",
36127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36128 "version": "0.0.0",
36129 "filename": "server/api/whatsappInteraction/index.js",
36130 "groupTitle": "Whatsapp_Interactions"
36134 "url": "/api/whatsapp/interactions/describe",
36135 "title": "Gets table info about Interactions",
36138 "title": "Example usage:",
36139 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36143 "name": "DescribeInteractions",
36144 "group": "Whatsapp_Interactions",
36145 "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>",
36146 "version": "0.0.0",
36147 "filename": "server/api/whatsappInteraction/index.js",
36148 "groupTitle": "Whatsapp_Interactions"
36152 "url": "/api/whatsapp/interactions",
36153 "title": "Gets a list of Interactions",
36156 "title": "Example usage:",
36157 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36161 "name": "GetInteractions",
36162 "group": "Whatsapp_Interactions",
36163 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36164 "version": "0.0.0",
36165 "filename": "server/api/whatsappInteraction/index.js",
36166 "groupTitle": "Whatsapp_Interactions"
36170 "url": "/api/whatsapp/interactions/{id}/tags",
36171 "title": "Removes tags from interaction",
36174 "title": "Example usage:",
36175 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36179 "name": "RemoveTags",
36180 "group": "Whatsapp_Interactions",
36181 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36182 "version": "0.0.0",
36183 "filename": "server/api/whatsappInteraction/index.js",
36184 "groupTitle": "Whatsapp_Interactions"
36188 "url": "/api/whatsapp/interactions/{id}",
36189 "title": "Gets a single Interaction",
36192 "title": "Example usage:",
36193 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36197 "name": "ShowInteractions",
36198 "group": "Whatsapp_Interactions",
36199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36200 "version": "0.0.0",
36201 "filename": "server/api/whatsappInteraction/index.js",
36202 "groupTitle": "Whatsapp_Interactions"
36206 "url": "/api/whatsapp/interactions/{id}/messages",
36207 "title": "Creates new messages",
36210 "title": "Example usage:",
36211 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36215 "name": "addMessage",
36216 "group": "Whatsapp_Interactions",
36242 "field": "direction",
36249 "field": "messageId",
36276 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36277 "version": "0.0.0",
36278 "filename": "server/api/whatsappInteraction/index.js",
36279 "groupTitle": "Whatsapp_Interactions"
36283 "url": "/api/whatsapp/interactions/{id}/download",
36284 "title": "Gets interaction",
36287 "title": "Example usage:",
36288 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36292 "name": "download",
36293 "group": "Whatsapp_Interactions",
36294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36295 "version": "0.0.0",
36296 "filename": "server/api/whatsappInteraction/index.js",
36297 "groupTitle": "Whatsapp_Interactions"
36301 "url": "/api/whatsapp/interactions/{id}/messages",
36302 "title": "Gets interaction messages",
36305 "title": "Example usage:",
36306 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36310 "name": "getMessages",
36311 "group": "Whatsapp_Interactions",
36312 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36313 "version": "0.0.0",
36314 "filename": "server/api/whatsappInteraction/index.js",
36315 "groupTitle": "Whatsapp_Interactions"
36319 "url": "/api/whatsapp/interactions/{id}",
36320 "title": "Update an existing Interaction",
36323 "title": "Example usage:",
36324 "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",
36328 "name": "updateInteractions",
36329 "group": "Whatsapp_Interactions",
36330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36331 "version": "0.0.0",
36332 "filename": "server/api/whatsappInteraction/index.js",
36333 "groupTitle": "Whatsapp_Interactions"
36337 "url": "/api/whatsapp/messages",
36338 "title": "Creates a new Message",
36341 "title": "Example usage:",
36342 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36346 "name": "CreateMessages",
36347 "group": "Whatsapp_Messages",
36373 "field": "direction",
36380 "field": "messageId",
36407 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36408 "version": "0.0.0",
36409 "filename": "server/api/whatsappMessage/index.js",
36410 "groupTitle": "Whatsapp_Messages"
36414 "url": "/api/whatsapp/messages/{id}",
36415 "title": "Deletes a Message",
36418 "title": "Example usage:",
36419 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36423 "name": "DeleteMessages",
36424 "group": "Whatsapp_Messages",
36425 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36426 "version": "0.0.0",
36427 "filename": "server/api/whatsappMessage/index.js",
36428 "groupTitle": "Whatsapp_Messages"
36432 "url": "/api/whatsapp/messages/describe",
36433 "title": "Gets table info about Messages",
36436 "title": "Example usage:",
36437 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36441 "name": "DescribeMessages",
36442 "group": "Whatsapp_Messages",
36443 "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>",
36444 "version": "0.0.0",
36445 "filename": "server/api/whatsappMessage/index.js",
36446 "groupTitle": "Whatsapp_Messages"
36450 "url": "/api/whatsapp/messages",
36451 "title": "Gets a list of Messages",
36454 "title": "Example usage:",
36455 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36459 "name": "GetMessages",
36460 "group": "Whatsapp_Messages",
36461 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36462 "version": "0.0.0",
36463 "filename": "server/api/whatsappMessage/index.js",
36464 "groupTitle": "Whatsapp_Messages"
36468 "url": "/api/whatsapp/messages/{id}",
36469 "title": "Gets a single Message",
36472 "title": "Example usage:",
36473 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36477 "name": "ShowMessages",
36478 "group": "Whatsapp_Messages",
36479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36480 "version": "0.0.0",
36481 "filename": "server/api/whatsappMessage/index.js",
36482 "groupTitle": "Whatsapp_Messages"
36486 "url": "/api/whatsapp/messages/{id}",
36487 "title": "Update an existing Message",
36490 "title": "Example usage:",
36491 "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",
36495 "name": "updateMessages",
36496 "group": "Whatsapp_Messages",
36497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36498 "version": "0.0.0",
36499 "filename": "server/api/whatsappMessage/index.js",
36500 "groupTitle": "Whatsapp_Messages"
36504 "url": "/api/whatsapp/reports/queue",
36505 "title": "Creates a new Whatsapp Queue Report",
36508 "title": "Example usage:",
36509 "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",
36513 "name": "CreateWhatsapp_Queue_Reports",
36514 "group": "Whatsapp_Queue_Reports",
36522 "field": "uniqueid",
36543 "field": "leaveAt",
36550 "field": "acceptAt",
36570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36571 "version": "0.0.0",
36572 "filename": "server/api/whatsappQueueReport/index.js",
36573 "groupTitle": "Whatsapp_Queue_Reports"
36577 "url": "/api/whatsapp/reports/queue/{id}",
36578 "title": "Deletes a Whatsapp Queue Report",
36581 "title": "Example usage:",
36582 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36586 "name": "DeleteWhatsapp_Queue_Reports",
36587 "group": "Whatsapp_Queue_Reports",
36588 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36589 "version": "0.0.0",
36590 "filename": "server/api/whatsappQueueReport/index.js",
36591 "groupTitle": "Whatsapp_Queue_Reports"
36595 "url": "/api/whatsapp/reports/queue/describe",
36596 "title": "Gets table info about Whatsapp Queue Reports",
36599 "title": "Example usage:",
36600 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36604 "name": "DescribeWhatsapp_Queue_Reports",
36605 "group": "Whatsapp_Queue_Reports",
36606 "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>",
36607 "version": "0.0.0",
36608 "filename": "server/api/whatsappQueueReport/index.js",
36609 "groupTitle": "Whatsapp_Queue_Reports"
36613 "url": "/api/whatsapp/reports/queue",
36614 "title": "Gets a list of Whatsapp Queue Reports",
36617 "title": "Example usage:",
36618 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36622 "name": "GetWhatsapp_Queue_Reports",
36623 "group": "Whatsapp_Queue_Reports",
36624 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36625 "version": "0.0.0",
36626 "filename": "server/api/whatsappQueueReport/index.js",
36627 "groupTitle": "Whatsapp_Queue_Reports"
36631 "url": "/api/whatsapp/reports/queue/{id}",
36632 "title": "Gets a single Whatsapp Queue Report",
36635 "title": "Example usage:",
36636 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36640 "name": "ShowWhatsapp_Queue_Reports",
36641 "group": "Whatsapp_Queue_Reports",
36642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36643 "version": "0.0.0",
36644 "filename": "server/api/whatsappQueueReport/index.js",
36645 "groupTitle": "Whatsapp_Queue_Reports"
36649 "url": "/api/whatsapp/reports/queue/{id}",
36650 "title": "Update an existing Whatsapp Queue Report",
36653 "title": "Example usage:",
36654 "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",
36658 "name": "updateWhatsapp_Queue_Reports",
36659 "group": "Whatsapp_Queue_Reports",
36660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36661 "version": "0.0.0",
36662 "filename": "server/api/whatsappQueueReport/index.js",
36663 "groupTitle": "Whatsapp_Queue_Reports"
36667 "url": "/api/whatsapp/queues/{id}/users",
36668 "title": "Add agents to a queue",
36671 "title": "Example usage:",
36672 "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",
36676 "name": "AddAgents",
36677 "group": "Whatsapp_Queues",
36678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36679 "version": "0.0.0",
36680 "filename": "server/api/whatsappQueue/index.js",
36681 "groupTitle": "Whatsapp_Queues"
36685 "url": "/api/whatsapp/queues/{id}/teams",
36686 "title": "Add teams to a queue",
36689 "title": "Example usage:",
36690 "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",
36694 "name": "AddTeams",
36695 "group": "Whatsapp_Queues",
36696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36697 "version": "0.0.0",
36698 "filename": "server/api/whatsappQueue/index.js",
36699 "groupTitle": "Whatsapp_Queues"
36703 "url": "/api/whatsapp/queues",
36704 "title": "Creates a new Queue",
36707 "title": "Example usage:",
36708 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36712 "name": "CreateQueues",
36713 "group": "Whatsapp_Queues",
36728 "field": "timeout",
36740 "field": "strategy",
36747 "field": "description",
36753 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36754 "version": "0.0.0",
36755 "filename": "server/api/whatsappQueue/index.js",
36756 "groupTitle": "Whatsapp_Queues"
36760 "url": "/api/whatsapp/queues/{id}",
36761 "title": "Deletes a Queue",
36764 "title": "Example usage:",
36765 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36769 "name": "DeleteQueues",
36770 "group": "Whatsapp_Queues",
36771 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36772 "version": "0.0.0",
36773 "filename": "server/api/whatsappQueue/index.js",
36774 "groupTitle": "Whatsapp_Queues"
36778 "url": "/api/whatsapp/queues/describe",
36779 "title": "Gets table info about Queues",
36782 "title": "Example usage:",
36783 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36787 "name": "DescribeQueues",
36788 "group": "Whatsapp_Queues",
36789 "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>",
36790 "version": "0.0.0",
36791 "filename": "server/api/whatsappQueue/index.js",
36792 "groupTitle": "Whatsapp_Queues"
36796 "url": "/api/whatsapp/queues/{id}/users",
36797 "title": "Gets queue agents",
36800 "title": "Example usage:",
36801 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36805 "name": "GetAgents",
36806 "group": "Whatsapp_Queues",
36807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36808 "version": "0.0.0",
36809 "filename": "server/api/whatsappQueue/index.js",
36810 "groupTitle": "Whatsapp_Queues"
36814 "url": "/api/whatsapp/queues/{id}/members",
36815 "title": "GetMembers",
36818 "title": "Example usage:",
36819 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36823 "name": "GetMembers",
36824 "group": "Whatsapp_Queues",
36825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36826 "version": "0.0.0",
36827 "filename": "server/api/whatsappQueue/index.js",
36828 "groupTitle": "Whatsapp_Queues"
36832 "url": "/api/whatsapp/queues",
36833 "title": "Gets a list of Queues",
36836 "title": "Example usage:",
36837 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36841 "name": "GetQueues",
36842 "group": "Whatsapp_Queues",
36843 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36844 "version": "0.0.0",
36845 "filename": "server/api/whatsappQueue/index.js",
36846 "groupTitle": "Whatsapp_Queues"
36850 "url": "/api/whatsapp/queues/{id}/teams",
36851 "title": "Gets queues list",
36854 "title": "Example usage:",
36855 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36859 "name": "GetTeams",
36860 "group": "Whatsapp_Queues",
36861 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36862 "version": "0.0.0",
36863 "filename": "server/api/whatsappQueue/index.js",
36864 "groupTitle": "Whatsapp_Queues"
36868 "url": "/api/whatsapp/queues/{id}/users",
36869 "title": "Removes agents from a queue",
36872 "title": "Example usage:",
36873 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36877 "name": "RemoveAgents",
36878 "group": "Whatsapp_Queues",
36879 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36880 "version": "0.0.0",
36881 "filename": "server/api/whatsappQueue/index.js",
36882 "groupTitle": "Whatsapp_Queues"
36886 "url": "/api/whatsapp/queues/{id}",
36887 "title": "Gets a single Queue",
36890 "title": "Example usage:",
36891 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36895 "name": "ShowQueues",
36896 "group": "Whatsapp_Queues",
36897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36898 "version": "0.0.0",
36899 "filename": "server/api/whatsappQueue/index.js",
36900 "groupTitle": "Whatsapp_Queues"
36904 "url": "/api/whatsapp/queues/{id}",
36905 "title": "Update an existing Queue",
36908 "title": "Example usage:",
36909 "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",
36913 "name": "updateQueues",
36914 "group": "Whatsapp_Queues",
36915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36916 "version": "0.0.0",
36917 "filename": "server/api/whatsappQueue/index.js",
36918 "groupTitle": "Whatsapp_Queues"
36922 "url": "/api/whatsapp/reports/transfer",
36923 "title": "Creates a new Whatsapp Transfer Report",
36926 "title": "Example usage:",
36927 "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",
36931 "name": "CreateWhatsapp_Transfer_Reports",
36932 "group": "Whatsapp_Transfer_Reports",
36940 "field": "uniqueid",
36959 "field": "transferredAt",
36965 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36966 "version": "0.0.0",
36967 "filename": "server/api/whatsappTransferReport/index.js",
36968 "groupTitle": "Whatsapp_Transfer_Reports"
36972 "url": "/api/whatsapp/reports/transfer/{id}",
36973 "title": "Deletes a Whatsapp Transfer Report",
36976 "title": "Example usage:",
36977 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36981 "name": "DeleteWhatsapp_Transfer_Reports",
36982 "group": "Whatsapp_Transfer_Reports",
36983 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36984 "version": "0.0.0",
36985 "filename": "server/api/whatsappTransferReport/index.js",
36986 "groupTitle": "Whatsapp_Transfer_Reports"
36990 "url": "/api/whatsapp/reports/transfer/describe",
36991 "title": "Gets table info about Whatsapp Transfer Reports",
36994 "title": "Example usage:",
36995 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36999 "name": "DescribeWhatsapp_Transfer_Reports",
37000 "group": "Whatsapp_Transfer_Reports",
37001 "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>",
37002 "version": "0.0.0",
37003 "filename": "server/api/whatsappTransferReport/index.js",
37004 "groupTitle": "Whatsapp_Transfer_Reports"
37008 "url": "/api/whatsapp/reports/transfer",
37009 "title": "Gets a list of Whatsapp Transfer Reports",
37012 "title": "Example usage:",
37013 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37017 "name": "GetWhatsapp_Transfer_Reports",
37018 "group": "Whatsapp_Transfer_Reports",
37019 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37020 "version": "0.0.0",
37021 "filename": "server/api/whatsappTransferReport/index.js",
37022 "groupTitle": "Whatsapp_Transfer_Reports"
37026 "url": "/api/whatsapp/reports/transfer/{id}",
37027 "title": "Gets a single Whatsapp Transfer Report",
37030 "title": "Example usage:",
37031 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37035 "name": "ShowWhatsapp_Transfer_Reports",
37036 "group": "Whatsapp_Transfer_Reports",
37037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37038 "version": "0.0.0",
37039 "filename": "server/api/whatsappTransferReport/index.js",
37040 "groupTitle": "Whatsapp_Transfer_Reports"
37044 "url": "/api/whatsapp/reports/transfer/{id}",
37045 "title": "Update an existing Whatsapp Transfer Report",
37048 "title": "Example usage:",
37049 "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",
37053 "name": "updateWhatsapp_Transfer_Reports",
37054 "group": "Whatsapp_Transfer_Reports",
37055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37056 "version": "0.0.0",
37057 "filename": "server/api/whatsappTransferReport/index.js",
37058 "groupTitle": "Whatsapp_Transfer_Reports"
37062 "url": "/api/integrations/zendesk/accounts",
37063 "title": "Creates a new Zendesk Account",
37066 "title": "Example usage:",
37067 "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",
37071 "name": "CreateZendesk_Accounts",
37072 "group": "Zendesk_Accounts",
37087 "field": "description",
37094 "field": "username",
37101 "field": "password",
37115 "field": "remoteUri",
37126 "field": "authType",
37133 "field": "serverUrl",
37140 "\"integrationTab\"",
37150 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37151 "version": "0.0.0",
37152 "filename": "server/api/intZendeskAccount/index.js",
37153 "groupTitle": "Zendesk_Accounts"
37157 "url": "/api/integrations/zendesk/accounts/{id}",
37158 "title": "Deletes a Zendesk Account",
37161 "title": "Example usage:",
37162 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37166 "name": "DeleteZendesk_Accounts",
37167 "group": "Zendesk_Accounts",
37168 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37169 "version": "0.0.0",
37170 "filename": "server/api/intZendeskAccount/index.js",
37171 "groupTitle": "Zendesk_Accounts"
37175 "url": "/api/integrations/zendesk/accounts",
37176 "title": "Gets a list of Zendesk Accounts",
37179 "title": "Example usage:",
37180 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37184 "name": "GetZendesk_Accounts",
37185 "group": "Zendesk_Accounts",
37186 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37187 "version": "0.0.0",
37188 "filename": "server/api/intZendeskAccount/index.js",
37189 "groupTitle": "Zendesk_Accounts"
37193 "url": "/api/integrations/zendesk/accounts/{id}",
37194 "title": "Gets a single Zendesk Account",
37197 "title": "Example usage:",
37198 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37202 "name": "ShowZendesk_Accounts",
37203 "group": "Zendesk_Accounts",
37204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37205 "version": "0.0.0",
37206 "filename": "server/api/intZendeskAccount/index.js",
37207 "groupTitle": "Zendesk_Accounts"
37211 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37212 "title": "Creates new configuration",
37215 "title": "Example usage:",
37216 "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",
37220 "name": "addConfiguration",
37221 "group": "Zendesk_Accounts",
37222 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37223 "version": "0.0.0",
37224 "filename": "server/api/intZendeskAccount/index.js",
37225 "groupTitle": "Zendesk_Accounts"
37229 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37230 "title": "Gets account configurations",
37233 "title": "Example usage:",
37234 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37238 "name": "getConfigurations",
37239 "group": "Zendesk_Accounts",
37240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37241 "version": "0.0.0",
37242 "filename": "server/api/intZendeskAccount/index.js",
37243 "groupTitle": "Zendesk_Accounts"
37247 "url": "/api/integrations/zendesk/accounts/{id}/fields",
37248 "title": "Gets account fields",
37251 "title": "Example usage:",
37252 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37256 "name": "getFields",
37257 "group": "Zendesk_Accounts",
37258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37259 "version": "0.0.0",
37260 "filename": "server/api/intZendeskAccount/index.js",
37261 "groupTitle": "Zendesk_Accounts"
37265 "url": "/api/integrations/zendesk/accounts/{id}",
37266 "title": "Update an existing Zendesk Account",
37269 "title": "Example usage:",
37270 "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",
37274 "name": "updateZendesk_Accounts",
37275 "group": "Zendesk_Accounts",
37276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37277 "version": "0.0.0",
37278 "filename": "server/api/intZendeskAccount/index.js",
37279 "groupTitle": "Zendesk_Accounts"
37283 "url": "/api/integrations/zendesk/configurations",
37284 "title": "Creates a new Zendesk Configuration",
37287 "title": "Example usage:",
37288 "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",
37292 "name": "CreateZendesk_Configurations",
37293 "group": "Zendesk_Configurations",
37308 "field": "description",
37314 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37315 "version": "0.0.0",
37316 "filename": "server/api/intZendeskConfiguration/index.js",
37317 "groupTitle": "Zendesk_Configurations"
37321 "url": "/api/integrations/zendesk/configurations/{id}",
37322 "title": "Deletes a Zendesk Configuration",
37325 "title": "Example usage:",
37326 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37330 "name": "DeleteZendesk_Configurations",
37331 "group": "Zendesk_Configurations",
37332 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37333 "version": "0.0.0",
37334 "filename": "server/api/intZendeskConfiguration/index.js",
37335 "groupTitle": "Zendesk_Configurations"
37339 "url": "/api/integrations/zendesk/configurations",
37340 "title": "Gets a list of Zendesk Configurations",
37343 "title": "Example usage:",
37344 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37348 "name": "GetZendesk_Configurations",
37349 "group": "Zendesk_Configurations",
37350 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37351 "version": "0.0.0",
37352 "filename": "server/api/intZendeskConfiguration/index.js",
37353 "groupTitle": "Zendesk_Configurations"
37357 "url": "/api/integrations/zendesk/configurations/{id}",
37358 "title": "Gets a single Zendesk Configuration",
37361 "title": "Example usage:",
37362 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37366 "name": "ShowZendesk_Configurations",
37367 "group": "Zendesk_Configurations",
37368 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37369 "version": "0.0.0",
37370 "filename": "server/api/intZendeskConfiguration/index.js",
37371 "groupTitle": "Zendesk_Configurations"
37375 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37376 "title": "Gets configurations descriptions",
37379 "title": "Example usage:",
37380 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37384 "name": "getDescriptions",
37385 "group": "Zendesk_Configurations",
37386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37387 "version": "0.0.0",
37388 "filename": "server/api/intZendeskConfiguration/index.js",
37389 "groupTitle": "Zendesk_Configurations"
37393 "url": "/api/integrations/zendesk/configurations/{id}/fields",
37394 "title": "Gets configurations fields",
37397 "title": "Example usage:",
37398 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37402 "name": "getFields",
37403 "group": "Zendesk_Configurations",
37404 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37405 "version": "0.0.0",
37406 "filename": "server/api/intZendeskConfiguration/index.js",
37407 "groupTitle": "Zendesk_Configurations"
37411 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37412 "title": "Gets configurations subjects",
37415 "title": "Example usage:",
37416 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37420 "name": "getSubjects",
37421 "group": "Zendesk_Configurations",
37422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37423 "version": "0.0.0",
37424 "filename": "server/api/intZendeskConfiguration/index.js",
37425 "groupTitle": "Zendesk_Configurations"
37429 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37430 "title": "Gets configurations tags",
37433 "title": "Example usage:",
37434 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37439 "group": "Zendesk_Configurations",
37440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37441 "version": "0.0.0",
37442 "filename": "server/api/intZendeskConfiguration/index.js",
37443 "groupTitle": "Zendesk_Configurations"
37447 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37448 "title": "Sets new tags",
37451 "title": "Example usage:",
37452 "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",
37457 "group": "Zendesk_Configurations",
37458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37459 "version": "0.0.0",
37460 "filename": "server/api/intZendeskConfiguration/index.js",
37461 "groupTitle": "Zendesk_Configurations"
37465 "url": "/api/integrations/zendesk/configurations/{id}",
37466 "title": "Update an existing Zendesk Configuration",
37469 "title": "Example usage:",
37470 "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",
37474 "name": "updateZendesk_Configurations",
37475 "group": "Zendesk_Configurations",
37476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37477 "version": "0.0.0",
37478 "filename": "server/api/intZendeskConfiguration/index.js",
37479 "groupTitle": "Zendesk_Configurations"
37483 "url": "/api/integrations/zendesk/fields",
37484 "title": "Creates a new Zendesk Field",
37487 "title": "Example usage:",
37488 "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",
37492 "name": "CreateZendesk_Fields",
37493 "group": "Zendesk_Fields",
37503 "\"customVariable\"",
37514 "field": "content",
37530 "\"customVariable\""
37533 "field": "keyType",
37540 "field": "keyContent",
37547 "field": "idField",
37554 "field": "nameField",
37561 "field": "customField",
37568 "field": "variableName",
37574 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37575 "version": "0.0.0",
37576 "filename": "server/api/intZendeskField/index.js",
37577 "groupTitle": "Zendesk_Fields"
37581 "url": "/api/integrations/zendesk/fields/{id}",
37582 "title": "Deletes a Zendesk Field",
37585 "title": "Example usage:",
37586 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37590 "name": "DeleteZendesk_Fields",
37591 "group": "Zendesk_Fields",
37592 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37593 "version": "0.0.0",
37594 "filename": "server/api/intZendeskField/index.js",
37595 "groupTitle": "Zendesk_Fields"
37599 "url": "/api/integrations/zendesk/fields",
37600 "title": "Gets a list of Zendesk Fields",
37603 "title": "Example usage:",
37604 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37608 "name": "GetZendesk_Fields",
37609 "group": "Zendesk_Fields",
37610 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37611 "version": "0.0.0",
37612 "filename": "server/api/intZendeskField/index.js",
37613 "groupTitle": "Zendesk_Fields"
37617 "url": "/api/integrations/zendesk/fields/{id}",
37618 "title": "Gets a single Zendesk Field",
37621 "title": "Example usage:",
37622 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37626 "name": "ShowZendesk_Fields",
37627 "group": "Zendesk_Fields",
37628 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37629 "version": "0.0.0",
37630 "filename": "server/api/intZendeskField/index.js",
37631 "groupTitle": "Zendesk_Fields"
37635 "url": "/api/integrations/zendesk/fields/{id}",
37636 "title": "Update an existing Zendesk Field",
37639 "title": "Example usage:",
37640 "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",
37644 "name": "updateZendesk_Fields",
37645 "group": "Zendesk_Fields",
37646 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37647 "version": "0.0.0",
37648 "filename": "server/api/intZendeskField/index.js",
37649 "groupTitle": "Zendesk_Fields"
37653 "url": "/api/integrations/zoho/accounts",
37654 "title": "Creates a new Zoho Account",
37657 "title": "Example usage:",
37658 "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",
37662 "name": "CreateZoho_Accounts",
37663 "group": "Zoho_Accounts",
37678 "field": "description",
37699 "field": "clientId",
37706 "field": "clientSecret",
37713 "field": "serverUrl",
37727 "field": "refreshToken",
37733 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37734 "version": "0.0.0",
37735 "filename": "server/api/intZohoAccount/index.js",
37736 "groupTitle": "Zoho_Accounts"
37740 "url": "/api/integrations/zoho/accounts/{id}",
37741 "title": "Deletes a Zoho Account",
37744 "title": "Example usage:",
37745 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37749 "name": "DeleteZoho_Accounts",
37750 "group": "Zoho_Accounts",
37751 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37752 "version": "0.0.0",
37753 "filename": "server/api/intZohoAccount/index.js",
37754 "groupTitle": "Zoho_Accounts"
37758 "url": "/api/integrations/zoho/accounts",
37759 "title": "Gets a list of Zoho Accounts",
37762 "title": "Example usage:",
37763 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37767 "name": "GetZoho_Accounts",
37768 "group": "Zoho_Accounts",
37769 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37770 "version": "0.0.0",
37771 "filename": "server/api/intZohoAccount/index.js",
37772 "groupTitle": "Zoho_Accounts"
37776 "url": "/api/integrations/zoho/accounts/{id}",
37777 "title": "Gets a single Zoho Account",
37780 "title": "Example usage:",
37781 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37785 "name": "ShowZoho_Accounts",
37786 "group": "Zoho_Accounts",
37787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37788 "version": "0.0.0",
37789 "filename": "server/api/intZohoAccount/index.js",
37790 "groupTitle": "Zoho_Accounts"
37794 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37795 "title": "Creates new configuration",
37798 "title": "Example usage:",
37799 "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",
37803 "name": "addConfiguration",
37804 "group": "Zoho_Accounts",
37805 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37806 "version": "0.0.0",
37807 "filename": "server/api/intZohoAccount/index.js",
37808 "groupTitle": "Zoho_Accounts"
37812 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37813 "title": "Gets account configurations",
37816 "title": "Example usage:",
37817 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37821 "name": "getConfigurations",
37822 "group": "Zoho_Accounts",
37823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37824 "version": "0.0.0",
37825 "filename": "server/api/intZohoAccount/index.js",
37826 "groupTitle": "Zoho_Accounts"
37830 "url": "/api/integrations/zoho/accounts/{id}/fields",
37831 "title": "Gets account fields",
37834 "title": "Example usage:",
37835 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37839 "name": "getFields",
37840 "group": "Zoho_Accounts",
37841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37842 "version": "0.0.0",
37843 "filename": "server/api/intZohoAccount/index.js",
37844 "groupTitle": "Zoho_Accounts"
37848 "url": "/api/integrations/zoho/accounts/{id}",
37849 "title": "Update an existing Zoho Account",
37852 "title": "Example usage:",
37853 "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",
37857 "name": "updateZoho_Accounts",
37858 "group": "Zoho_Accounts",
37859 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37860 "version": "0.0.0",
37861 "filename": "server/api/intZohoAccount/index.js",
37862 "groupTitle": "Zoho_Accounts"
37866 "url": "/api/integrations/zoho/configurations",
37867 "title": "Creates a new Zoho Configuration",
37870 "title": "Example usage:",
37871 "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",
37875 "name": "CreateZoho_Configurations",
37876 "group": "Zoho_Configurations",
37896 "field": "moduleCreate",
37903 "\"contact_lead\"",
37908 "field": "moduleSearch",
37915 "field": "description",
37921 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37922 "version": "0.0.0",
37923 "filename": "server/api/intZohoConfiguration/index.js",
37924 "groupTitle": "Zoho_Configurations"
37928 "url": "/api/integrations/zoho/configurations/{id}",
37929 "title": "Deletes a Zoho Configuration",
37932 "title": "Example usage:",
37933 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37937 "name": "DeleteZoho_Configurations",
37938 "group": "Zoho_Configurations",
37939 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37940 "version": "0.0.0",
37941 "filename": "server/api/intZohoConfiguration/index.js",
37942 "groupTitle": "Zoho_Configurations"
37946 "url": "/api/integrations/zoho/configurations",
37947 "title": "Gets a list of Zoho Configurations",
37950 "title": "Example usage:",
37951 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37955 "name": "GetZoho_Configurations",
37956 "group": "Zoho_Configurations",
37957 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37958 "version": "0.0.0",
37959 "filename": "server/api/intZohoConfiguration/index.js",
37960 "groupTitle": "Zoho_Configurations"
37964 "url": "/api/integrations/zoho/configurations/{id}",
37965 "title": "Gets a single Zoho Configuration",
37968 "title": "Example usage:",
37969 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37973 "name": "ShowZoho_Configurations",
37974 "group": "Zoho_Configurations",
37975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37976 "version": "0.0.0",
37977 "filename": "server/api/intZohoConfiguration/index.js",
37978 "groupTitle": "Zoho_Configurations"
37982 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37983 "title": "Gets configurations descriptions",
37986 "title": "Example usage:",
37987 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37991 "name": "getDescriptions",
37992 "group": "Zoho_Configurations",
37993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37994 "version": "0.0.0",
37995 "filename": "server/api/intZohoConfiguration/index.js",
37996 "groupTitle": "Zoho_Configurations"
38000 "url": "/api/integrations/zoho/configurations/{id}/fields",
38001 "title": "Gets configurations fields",
38004 "title": "Example usage:",
38005 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38009 "name": "getFields",
38010 "group": "Zoho_Configurations",
38011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38012 "version": "0.0.0",
38013 "filename": "server/api/intZohoConfiguration/index.js",
38014 "groupTitle": "Zoho_Configurations"
38018 "url": "/api/integrations/zoho/configurations/{id}/subjects",
38019 "title": "Gets configurations subjects",
38022 "title": "Example usage:",
38023 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38027 "name": "getSubjects",
38028 "group": "Zoho_Configurations",
38029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38030 "version": "0.0.0",
38031 "filename": "server/api/intZohoConfiguration/index.js",
38032 "groupTitle": "Zoho_Configurations"
38036 "url": "/api/integrations/zoho/configurations/{id}",
38037 "title": "Update an existing Zoho Configuration",
38040 "title": "Example usage:",
38041 "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",
38045 "name": "updateZoho_Configurations",
38046 "group": "Zoho_Configurations",
38047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38048 "version": "0.0.0",
38049 "filename": "server/api/intZohoConfiguration/index.js",
38050 "groupTitle": "Zoho_Configurations"
38054 "url": "/api/integrations/zoho/fields",
38055 "title": "Creates a new Zoho Field",
38058 "title": "Example usage:",
38059 "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",
38063 "name": "CreateZoho_Fields",
38064 "group": "Zoho_Fields",
38074 "\"customVariable\"",
38085 "field": "content",
38101 "\"customVariable\""
38104 "field": "keyType",
38111 "field": "keyContent",
38118 "field": "idField",
38125 "field": "nameField",
38132 "field": "customField",
38139 "field": "variableName",
38145 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38146 "version": "0.0.0",
38147 "filename": "server/api/intZohoField/index.js",
38148 "groupTitle": "Zoho_Fields"
38152 "url": "/api/integrations/zoho/fields/{id}",
38153 "title": "Deletes a Zoho Field",
38156 "title": "Example usage:",
38157 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38161 "name": "DeleteZoho_Fields",
38162 "group": "Zoho_Fields",
38163 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38164 "version": "0.0.0",
38165 "filename": "server/api/intZohoField/index.js",
38166 "groupTitle": "Zoho_Fields"
38170 "url": "/api/integrations/zoho/fields",
38171 "title": "Gets a list of Zoho Fields",
38174 "title": "Example usage:",
38175 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38179 "name": "GetZoho_Fields",
38180 "group": "Zoho_Fields",
38181 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38182 "version": "0.0.0",
38183 "filename": "server/api/intZohoField/index.js",
38184 "groupTitle": "Zoho_Fields"
38188 "url": "/api/integrations/zoho/fields/{id}",
38189 "title": "Gets a single Zoho Field",
38192 "title": "Example usage:",
38193 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38197 "name": "ShowZoho_Fields",
38198 "group": "Zoho_Fields",
38199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38200 "version": "0.0.0",
38201 "filename": "server/api/intZohoField/index.js",
38202 "groupTitle": "Zoho_Fields"
38206 "url": "/api/integrations/zoho/fields/{id}",
38207 "title": "Update an existing Zoho Field",
38210 "title": "Example usage:",
38211 "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",
38215 "name": "updateZoho_Fields",
38216 "group": "Zoho_Fields",
38217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38218 "version": "0.0.0",
38219 "filename": "server/api/intZohoField/index.js",
38220 "groupTitle": "Zoho_Fields"
38225 "title": "Creates a new Cdr",
38228 "title": "Example usage:",
38229 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38233 "name": "CreateCdrs",
38242 "field": "calldate",
38270 "field": "dcontext",
38277 "field": "channel",
38284 "field": "dstchannel",
38291 "field": "lastapp",
38298 "field": "lastdata",
38305 "field": "duration",
38312 "field": "billsec",
38319 "field": "disposition",
38326 "field": "amaflags",
38333 "field": "accountcode",
38340 "field": "userfield",
38347 "field": "uniqueid",
38354 "field": "linkedid",
38361 "field": "sequence",
38368 "field": "peeraccount",
38388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38389 "version": "0.0.0",
38390 "filename": "server/api/cdr/index.js",
38391 "groupTitle": "cdr"
38395 "url": "/api/cdr/{id}",
38396 "title": "Deletes a Cdr",
38399 "title": "Example usage:",
38400 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38404 "name": "DeleteCdrs",
38406 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38407 "version": "0.0.0",
38408 "filename": "server/api/cdr/index.js",
38409 "groupTitle": "cdr"
38413 "url": "/api/cdr/describe",
38414 "title": "Gets table info about Cdrs",
38417 "title": "Example usage:",
38418 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38422 "name": "DescribeCdrs",
38424 "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>",
38425 "version": "0.0.0",
38426 "filename": "server/api/cdr/index.js",
38427 "groupTitle": "cdr"
38432 "title": "Gets a list of Cdrs",
38435 "title": "Example usage:",
38436 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38442 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38443 "version": "0.0.0",
38444 "filename": "server/api/cdr/index.js",
38445 "groupTitle": "cdr"
38449 "url": "/api/cdr/{id}",
38450 "title": "Gets a single Cdr",
38453 "title": "Example usage:",
38454 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38458 "name": "ShowCdrs",
38460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38461 "version": "0.0.0",
38462 "filename": "server/api/cdr/index.js",
38463 "groupTitle": "cdr"
38467 "url": "/api/cdr/{id}",
38468 "title": "Update an existing Cdr",
38471 "title": "Example usage:",
38472 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38476 "name": "updateCdrs",
38478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38479 "version": "0.0.0",
38480 "filename": "server/api/cdr/index.js",
38481 "groupTitle": "cdr"
38485 "url": "/api/voiceQueuesLog",
38486 "title": "Creates a new VoiceQueuesLog",
38489 "title": "Example usage:",
38490 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38494 "name": "CreateVoiceQueuesLogs",
38495 "group": "voiceQueuesLog",
38517 "field": "queuename",
38586 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38587 "version": "0.0.0",
38588 "filename": "server/api/voiceQueuesLog/index.js",
38589 "groupTitle": "voiceQueuesLog"
38593 "url": "/api/voiceQueuesLog/{id}",
38594 "title": "Deletes a VoiceQueuesLog",
38597 "title": "Example usage:",
38598 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38602 "name": "DeleteVoiceQueuesLogs",
38603 "group": "voiceQueuesLog",
38604 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38605 "version": "0.0.0",
38606 "filename": "server/api/voiceQueuesLog/index.js",
38607 "groupTitle": "voiceQueuesLog"
38611 "url": "/api/voiceQueuesLog",
38612 "title": "Gets a list of VoiceQueuesLogs",
38615 "title": "Example usage:",
38616 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38620 "name": "GetVoiceQueuesLogs",
38621 "group": "voiceQueuesLog",
38622 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38623 "version": "0.0.0",
38624 "filename": "server/api/voiceQueuesLog/index.js",
38625 "groupTitle": "voiceQueuesLog"
38629 "url": "/api/voiceQueuesLog/{id}",
38630 "title": "Gets a single VoiceQueuesLog",
38633 "title": "Example usage:",
38634 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38638 "name": "ShowVoiceQueuesLogs",
38639 "group": "voiceQueuesLog",
38640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38641 "version": "0.0.0",
38642 "filename": "server/api/voiceQueuesLog/index.js",
38643 "groupTitle": "voiceQueuesLog"
38647 "url": "/api/voiceQueuesLog/{id}",
38648 "title": "Update an existing VoiceQueuesLog",
38651 "title": "Example usage:",
38652 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38656 "name": "updateVoiceQueuesLogs",
38657 "group": "voiceQueuesLog",
38658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38659 "version": "0.0.0",
38660 "filename": "server/api/voiceQueuesLog/index.js",
38661 "groupTitle": "voiceQueuesLog"