4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/local",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authLocal/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/google",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authGoogle/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/automations",
1381 "title": "Creates a new Automation",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1389 "name": "CreateAutomations",
1390 "group": "Automations",
1412 "field": "description",
1432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1434 "filename": "server/api/automation/index.js",
1435 "groupTitle": "Automations"
1439 "url": "/api/automations/{id}",
1440 "title": "Deletes a Automation",
1443 "title": "Example usage:",
1444 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1448 "name": "DeleteAutomations",
1449 "group": "Automations",
1450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1452 "filename": "server/api/automation/index.js",
1453 "groupTitle": "Automations"
1457 "url": "/api/automations",
1458 "title": "Gets a list of Automations",
1461 "title": "Example usage:",
1462 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1466 "name": "GetAutomations",
1467 "group": "Automations",
1468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1470 "filename": "server/api/automation/index.js",
1471 "groupTitle": "Automations"
1475 "url": "/api/automations/{id}",
1476 "title": "Gets a single Automation",
1479 "title": "Example usage:",
1480 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1484 "name": "ShowAutomations",
1485 "group": "Automations",
1486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488 "filename": "server/api/automation/index.js",
1489 "groupTitle": "Automations"
1493 "url": "/api/automations/{id}/actions",
1494 "title": "Creates new actions",
1497 "title": "Example usage:",
1498 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1502 "name": "addActions",
1503 "group": "Automations",
1519 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1526 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1533 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1540 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1575 "filename": "server/api/automation/index.js",
1576 "groupTitle": "Automations"
1580 "url": "/api/automations/{id}/conditions",
1581 "title": "Creates new conditions",
1584 "title": "Example usage:",
1585 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1589 "name": "addConditions",
1590 "group": "Automations",
1612 "field": "operator",
1625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1627 "filename": "server/api/automation/index.js",
1628 "groupTitle": "Automations"
1632 "url": "/api/automations/{id}/actions",
1633 "title": "Gets Automation Actions",
1636 "title": "Example usage:",
1637 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1641 "name": "getActions",
1642 "group": "Automations",
1643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1645 "filename": "server/api/automation/index.js",
1646 "groupTitle": "Automations"
1650 "url": "/api/automations/{id}/conditions",
1651 "title": "Gets Automation Conditions",
1654 "title": "Example usage:",
1655 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1659 "name": "getConditions",
1660 "group": "Automations",
1661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1663 "filename": "server/api/automation/index.js",
1664 "groupTitle": "Automations"
1668 "url": "/api/automations/{id}",
1669 "title": "Update an existing Automation",
1672 "title": "Example usage:",
1673 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1677 "name": "updateAutomations",
1678 "group": "Automations",
1679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/canned_answers",
1687 "title": "Create a new canned answer",
1690 "title": "Example usage:",
1691 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1696 "group": "Canned_Answers",
1697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699 "filename": "server/api/cannedAnswer/index.js",
1700 "groupTitle": "Canned_Answers"
1704 "url": "/api/canned_answers/{id}",
1705 "title": "Deletes a Canned Answer",
1708 "title": "Example usage:",
1709 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1713 "name": "DeleteCanned_Answers",
1714 "group": "Canned_Answers",
1715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1717 "filename": "server/api/cannedAnswer/index.js",
1718 "groupTitle": "Canned_Answers"
1722 "url": "/api/canned_answers",
1723 "title": "Gets a list of Canned Answers",
1726 "title": "Example usage:",
1727 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1731 "name": "GetCanned_Answers",
1732 "group": "Canned_Answers",
1733 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1735 "filename": "server/api/cannedAnswer/index.js",
1736 "groupTitle": "Canned_Answers"
1740 "url": "/api/canned_answers/{id}",
1741 "title": "Gets a single Canned Answer",
1744 "title": "Example usage:",
1745 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1749 "name": "ShowCanned_Answers",
1750 "group": "Canned_Answers",
1751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753 "filename": "server/api/cannedAnswer/index.js",
1754 "groupTitle": "Canned_Answers"
1758 "url": "/api/canned_answers/{id}",
1759 "title": "Update an existing Canned Answer",
1762 "title": "Example usage:",
1763 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1767 "name": "updateCanned_Answers",
1768 "group": "Canned_Answers",
1769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771 "filename": "server/api/cannedAnswer/index.js",
1772 "groupTitle": "Canned_Answers"
1776 "url": "/chat/internal/users",
1777 "title": "Gets Users Last Messages",
1780 "title": "Example usage:",
1781 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1785 "name": "getLastUsersMessages",
1786 "group": "ChatInternalMessage",
1787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1789 "filename": "server/api/chatInternalMessage/index.js",
1790 "groupTitle": "ChatInternalMessage"
1794 "url": "/api/chat/applications/{id}",
1795 "title": "Deletes a Application",
1798 "title": "Example usage:",
1799 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1803 "name": "DeleteApplications",
1804 "group": "Chat_Applications",
1805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1807 "filename": "server/api/chatApplication/index.js",
1808 "groupTitle": "Chat_Applications"
1812 "url": "/api/chat/applications/{id}",
1813 "title": "Gets a single Application",
1816 "title": "Example usage:",
1817 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1821 "name": "ShowApplications",
1822 "group": "Chat_Applications",
1823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825 "filename": "server/api/chatApplication/index.js",
1826 "groupTitle": "Chat_Applications"
1830 "url": "/api/chat/applications/{id}",
1831 "title": "Update an existing Application",
1834 "title": "Example usage:",
1835 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1839 "name": "updateApplications",
1840 "group": "Chat_Applications",
1841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843 "filename": "server/api/chatApplication/index.js",
1844 "groupTitle": "Chat_Applications"
1848 "url": "/api/chat/groups",
1849 "title": "Creates a new Group",
1852 "title": "Example usage:",
1853 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1857 "name": "CreateGroups",
1858 "group": "Chat_Groups",
1873 "field": "description",
1886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1888 "filename": "server/api/chatGroup/index.js",
1889 "groupTitle": "Chat_Groups"
1893 "url": "/api/chat/groups/{id}",
1894 "title": "Deletes a Group",
1897 "title": "Example usage:",
1898 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1902 "name": "DeleteGroups",
1903 "group": "Chat_Groups",
1904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1906 "filename": "server/api/chatGroup/index.js",
1907 "groupTitle": "Chat_Groups"
1911 "url": "/api/chat/groups/describe",
1912 "title": "Gets table info about Groups",
1915 "title": "Example usage:",
1916 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1920 "name": "DescribeGroups",
1921 "group": "Chat_Groups",
1922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1924 "filename": "server/api/chatGroup/index.js",
1925 "groupTitle": "Chat_Groups"
1929 "url": "/api/chat/groups",
1930 "title": "Gets a list of Groups",
1933 "title": "Example usage:",
1934 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1938 "name": "GetGroups",
1939 "group": "Chat_Groups",
1940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1942 "filename": "server/api/chatGroup/index.js",
1943 "groupTitle": "Chat_Groups"
1947 "url": "/api/chat/groups/{id}/members",
1948 "title": "Removes members from a group",
1951 "title": "Example usage:",
1952 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1956 "name": "RemoveMembers",
1957 "group": "Chat_Groups",
1958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1960 "filename": "server/api/chatGroup/index.js",
1961 "groupTitle": "Chat_Groups"
1965 "url": "/api/chat/groups/{id}",
1966 "title": "Gets a single Group",
1969 "title": "Example usage:",
1970 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1974 "name": "ShowGroups",
1975 "group": "Chat_Groups",
1976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978 "filename": "server/api/chatGroup/index.js",
1979 "groupTitle": "Chat_Groups"
1983 "url": "/api/chat/groups/{id}/members",
1984 "title": "Add members to chat group",
1987 "title": "Example usage:",
1988 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1992 "name": "addMembers",
1993 "group": "Chat_Groups",
1994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1996 "filename": "server/api/chatGroup/index.js",
1997 "groupTitle": "Chat_Groups"
2001 "url": "/api/chat/groups/{id}/messages",
2002 "title": "Creates a new group message",
2005 "title": "Example usage:",
2006 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2010 "name": "addMessage",
2011 "group": "Chat_Groups",
2012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014 "filename": "server/api/chatGroup/index.js",
2015 "groupTitle": "Chat_Groups"
2019 "url": "/api/chat/groups/{id}/members",
2020 "title": "Gets Members",
2023 "title": "Example usage:",
2024 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2028 "name": "getMembers",
2029 "group": "Chat_Groups",
2030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032 "filename": "server/api/chatGroup/index.js",
2033 "groupTitle": "Chat_Groups"
2037 "url": "/api/chat/groups/{id}/messages",
2038 "title": "Gets Messages",
2041 "title": "Example usage:",
2042 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2046 "name": "getMessages",
2047 "group": "Chat_Groups",
2048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050 "filename": "server/api/chatGroup/index.js",
2051 "groupTitle": "Chat_Groups"
2055 "url": "/api/chat/groups/{id}/unread",
2056 "title": "Get unread chat group messages",
2059 "title": "Example usage:",
2060 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2065 "group": "Chat_Groups",
2066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068 "filename": "server/api/chatGroup/index.js",
2069 "groupTitle": "Chat_Groups"
2073 "url": "/api/chat/groups/{id}",
2074 "title": "Update an existing Group",
2077 "title": "Example usage:",
2078 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2082 "name": "updateGroups",
2083 "group": "Chat_Groups",
2084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086 "filename": "server/api/chatGroup/index.js",
2087 "groupTitle": "Chat_Groups"
2091 "url": "/api/chat/interactions/{id}/tags",
2092 "title": "Add tags to the interaction",
2095 "title": "Example usage:",
2096 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2101 "group": "Chat_Interactions",
2102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104 "filename": "server/api/chatInteraction/index.js",
2105 "groupTitle": "Chat_Interactions"
2109 "url": "/api/chat/interactions",
2110 "title": "Creates a new Interaction",
2113 "title": "Example usage:",
2114 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2118 "name": "CreateInteractions",
2119 "group": "Chat_Interactions",
2134 "field": "ratingValue",
2145 "field": "ratingType",
2152 "field": "ratingMessage",
2159 "field": "pathTranscript",
2166 "field": "mailTranscript",
2173 "field": "closedAt",
2180 "field": "disposition",
2187 "field": "secondDisposition",
2194 "field": "thirdDisposition",
2208 "field": "browserName",
2215 "field": "browserVersion",
2229 "field": "osVersion",
2236 "field": "deviceModel",
2243 "field": "deviceVendor",
2250 "field": "deviceType",
2264 "field": "customerIp",
2271 "field": "formData",
2278 "field": "read1stAt",
2285 "field": "lastMsgAt",
2296 "field": "lastMsgDirection",
2303 "field": "closeReason",
2310 "field": "customerPort",
2317 "field": "vidaooSessionId",
2324 "field": "autoreplyExecuted",
2330 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2332 "filename": "server/api/chatInteraction/index.js",
2333 "groupTitle": "Chat_Interactions"
2337 "url": "/api/chat/interactions/{id}",
2338 "title": "Deletes a Interaction",
2341 "title": "Example usage:",
2342 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2346 "name": "DeleteInteractions",
2347 "group": "Chat_Interactions",
2348 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2350 "filename": "server/api/chatInteraction/index.js",
2351 "groupTitle": "Chat_Interactions"
2355 "url": "/api/chat/interactions/describe",
2356 "title": "Gets table info about Interactions",
2359 "title": "Example usage:",
2360 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2364 "name": "DescribeInteractions",
2365 "group": "Chat_Interactions",
2366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2368 "filename": "server/api/chatInteraction/index.js",
2369 "groupTitle": "Chat_Interactions"
2373 "url": "/api/chat/interactions",
2374 "title": "Gets a list of Interactions",
2377 "title": "Example usage:",
2378 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2382 "name": "GetInteractions",
2383 "group": "Chat_Interactions",
2384 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2386 "filename": "server/api/chatInteraction/index.js",
2387 "groupTitle": "Chat_Interactions"
2391 "url": "/api/chat/interactions/{id}/tags",
2392 "title": "Removes tags from interaction",
2395 "title": "Example usage:",
2396 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2400 "name": "RemoveTags",
2401 "group": "Chat_Interactions",
2402 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2404 "filename": "server/api/chatInteraction/index.js",
2405 "groupTitle": "Chat_Interactions"
2409 "url": "/api/chat/interactions/{id}",
2410 "title": "Gets a single Interaction",
2413 "title": "Example usage:",
2414 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2418 "name": "ShowInteractions",
2419 "group": "Chat_Interactions",
2420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2422 "filename": "server/api/chatInteraction/index.js",
2423 "groupTitle": "Chat_Interactions"
2427 "url": "/api/chat/interactions/{id}/abandon",
2428 "title": "Abandon interaction",
2431 "title": "Example usage:",
2432 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2437 "group": "Chat_Interactions",
2438 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2440 "filename": "server/api/chatInteraction/index.js",
2441 "groupTitle": "Chat_Interactions"
2445 "url": "/api/chat/interactions/{id}/messages",
2446 "title": "Creates new messages",
2449 "title": "Example usage:",
2450 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2454 "name": "addMessage",
2455 "group": "Chat_Interactions",
2488 "field": "direction",
2502 "field": "providerName",
2509 "field": "providerResponse",
2515 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2517 "filename": "server/api/chatInteraction/index.js",
2518 "groupTitle": "Chat_Interactions"
2522 "url": "/api/chat/interactions/{id}/close",
2523 "title": "Close Interaction",
2526 "title": "Example usage:",
2527 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2531 "name": "addMessage",
2532 "group": "Chat_Interactions",
2533 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2535 "filename": "server/api/chatInteraction/index.js",
2536 "groupTitle": "Chat_Interactions"
2540 "url": "/api/chat/interactions/{id}/attachment_upload",
2541 "title": "Add attachment",
2544 "title": "Example usage:",
2545 "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",
2549 "name": "attachmentUpload",
2550 "group": "Chat_Interactions",
2551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2553 "filename": "server/api/chatInteraction/index.js",
2554 "groupTitle": "Chat_Interactions"
2558 "url": "/api/chat/interactions/{id}/vidaoo",
2559 "title": "Create Vidaoo Session",
2562 "title": "Example usage:",
2563 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2567 "name": "createVidaooSession",
2568 "group": "Chat_Interactions",
2569 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2571 "filename": "server/api/chatInteraction/index.js",
2572 "groupTitle": "Chat_Interactions"
2576 "url": "/api/chat/interactions/{id}/custom_update",
2577 "title": "Update interaction",
2580 "title": "Example usage:",
2581 "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",
2585 "name": "customUpdate",
2586 "group": "Chat_Interactions",
2587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2589 "filename": "server/api/chatInteraction/index.js",
2590 "groupTitle": "Chat_Interactions"
2594 "url": "/api/chat/interactions/{id}/download",
2595 "title": "Gets interaction",
2598 "title": "Example usage:",
2599 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2604 "group": "Chat_Interactions",
2605 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2607 "filename": "server/api/chatInteraction/index.js",
2608 "groupTitle": "Chat_Interactions"
2612 "url": "/api/chat/interactions/{id}/messages",
2613 "title": "Gets interaction messages",
2616 "title": "Example usage:",
2617 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2621 "name": "getMessages",
2622 "group": "Chat_Interactions",
2623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2625 "filename": "server/api/chatInteraction/index.js",
2626 "groupTitle": "Chat_Interactions"
2630 "url": "/api/chat/interactions/{id}/my_messages",
2631 "title": "Gets interaction messages",
2634 "title": "Example usage:",
2635 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2639 "name": "getMyMessages",
2640 "group": "Chat_Interactions",
2641 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2643 "filename": "server/api/chatInteraction/index.js",
2644 "groupTitle": "Chat_Interactions"
2648 "url": "/api/chat/interactions/{id}",
2649 "title": "Update an existing Interaction",
2652 "title": "Example usage:",
2653 "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",
2657 "name": "updateInteractions",
2658 "group": "Chat_Interactions",
2659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2661 "filename": "server/api/chatInteraction/index.js",
2662 "groupTitle": "Chat_Interactions"
2666 "url": "/api/chat/internal/messages",
2667 "title": "Creates a new Message",
2670 "title": "Example usage:",
2671 "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",
2675 "name": "CreateMessages",
2676 "group": "Chat_Internal_Messages",
2698 "field": "ChatInternalMessageId",
2704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2706 "filename": "server/api/chatInternalMessage/index.js",
2707 "groupTitle": "Chat_Internal_Messages"
2711 "url": "/api/chat/internal/messages/{id}",
2712 "title": "Deletes a Message",
2715 "title": "Example usage:",
2716 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2720 "name": "DeleteMessages",
2721 "group": "Chat_Internal_Messages",
2722 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2724 "filename": "server/api/chatInternalMessage/index.js",
2725 "groupTitle": "Chat_Internal_Messages"
2729 "url": "/api/chat/internal/messages/describe",
2730 "title": "Gets table info about Messages",
2733 "title": "Example usage:",
2734 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2738 "name": "DescribeMessages",
2739 "group": "Chat_Internal_Messages",
2740 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2742 "filename": "server/api/chatInternalMessage/index.js",
2743 "groupTitle": "Chat_Internal_Messages"
2747 "url": "/api/chat/internal/messages",
2748 "title": "Gets a list of Messages",
2751 "title": "Example usage:",
2752 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2756 "name": "GetMessages",
2757 "group": "Chat_Internal_Messages",
2758 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2760 "filename": "server/api/chatInternalMessage/index.js",
2761 "groupTitle": "Chat_Internal_Messages"
2765 "url": "/api/chat/internal/messages/{id}",
2766 "title": "Gets a single Message",
2769 "title": "Example usage:",
2770 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2774 "name": "ShowMessages",
2775 "group": "Chat_Internal_Messages",
2776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2778 "filename": "server/api/chatInternalMessage/index.js",
2779 "groupTitle": "Chat_Internal_Messages"
2783 "url": "/api/chat/internal/messages/{id}",
2784 "title": "Update an existing Message",
2787 "title": "Example usage:",
2788 "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",
2792 "name": "updateMessages",
2793 "group": "Chat_Internal_Messages",
2794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2796 "filename": "server/api/chatInternalMessage/index.js",
2797 "groupTitle": "Chat_Internal_Messages"
2801 "url": "/api/chat/messages",
2802 "title": "Creates a new Message",
2805 "title": "Example usage:",
2806 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2810 "name": "CreateMessages",
2811 "group": "Chat_Messages",
2844 "field": "direction",
2858 "field": "providerName",
2865 "field": "providerResponse",
2871 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2873 "filename": "server/api/chatMessage/index.js",
2874 "groupTitle": "Chat_Messages"
2878 "url": "/api/chat/messages/{id}",
2879 "title": "Deletes a Message",
2882 "title": "Example usage:",
2883 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2887 "name": "DeleteMessages",
2888 "group": "Chat_Messages",
2889 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2891 "filename": "server/api/chatMessage/index.js",
2892 "groupTitle": "Chat_Messages"
2896 "url": "/api/chat/messages/describe",
2897 "title": "Gets table info about Messages",
2900 "title": "Example usage:",
2901 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2905 "name": "DescribeMessages",
2906 "group": "Chat_Messages",
2907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2909 "filename": "server/api/chatMessage/index.js",
2910 "groupTitle": "Chat_Messages"
2914 "url": "/api/chat/messages",
2915 "title": "Gets a list of Messages",
2918 "title": "Example usage:",
2919 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2923 "name": "GetMessages",
2924 "group": "Chat_Messages",
2925 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2927 "filename": "server/api/chatMessage/index.js",
2928 "groupTitle": "Chat_Messages"
2932 "url": "/api/chat/messages/{id}",
2933 "title": "Gets a single Message",
2936 "title": "Example usage:",
2937 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2941 "name": "ShowMessages",
2942 "group": "Chat_Messages",
2943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2945 "filename": "server/api/chatMessage/index.js",
2946 "groupTitle": "Chat_Messages"
2950 "url": "/api/chat/messages/{id}",
2951 "title": "Update an existing Message",
2954 "title": "Example usage:",
2955 "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",
2959 "name": "updateMessages",
2960 "group": "Chat_Messages",
2961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/chatMessage/index.js",
2964 "groupTitle": "Chat_Messages"
2968 "url": "/api/chat/offline_messages",
2969 "title": "Creates a new OfflineMessage",
2972 "title": "Example usage:",
2973 "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",
2977 "name": "CreateOfflineMessages",
2978 "group": "Chat_Offline_Messages",
2992 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2994 "filename": "server/api/chatOfflineMessage/index.js",
2995 "groupTitle": "Chat_Offline_Messages"
2999 "url": "/api/chat/offline_messages/{id}",
3000 "title": "Deletes a OfflineMessage",
3003 "title": "Example usage:",
3004 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3008 "name": "DeleteOfflineMessages",
3009 "group": "Chat_Offline_Messages",
3010 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3012 "filename": "server/api/chatOfflineMessage/index.js",
3013 "groupTitle": "Chat_Offline_Messages"
3017 "url": "/api/chat/offline_messages/describe",
3018 "title": "Gets table info about OfflineMessages",
3021 "title": "Example usage:",
3022 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3026 "name": "DescribeOfflineMessages",
3027 "group": "Chat_Offline_Messages",
3028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3030 "filename": "server/api/chatOfflineMessage/index.js",
3031 "groupTitle": "Chat_Offline_Messages"
3035 "url": "/api/chat/offline_messages",
3036 "title": "Gets a list of OfflineMessages",
3039 "title": "Example usage:",
3040 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3044 "name": "GetOfflineMessages",
3045 "group": "Chat_Offline_Messages",
3046 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3048 "filename": "server/api/chatOfflineMessage/index.js",
3049 "groupTitle": "Chat_Offline_Messages"
3053 "url": "/api/chat/offline_messages/{id}",
3054 "title": "Gets a single OfflineMessage",
3057 "title": "Example usage:",
3058 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3062 "name": "ShowOfflineMessages",
3063 "group": "Chat_Offline_Messages",
3064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3066 "filename": "server/api/chatOfflineMessage/index.js",
3067 "groupTitle": "Chat_Offline_Messages"
3071 "url": "/api/chat/offline_messages/{id}",
3072 "title": "Update an existing OfflineMessage",
3075 "title": "Example usage:",
3076 "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",
3080 "name": "updateOfflineMessages",
3081 "group": "Chat_Offline_Messages",
3082 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3084 "filename": "server/api/chatOfflineMessage/index.js",
3085 "groupTitle": "Chat_Offline_Messages"
3089 "url": "/api/chat/proactive_actions",
3090 "title": "Creates a new Proactive Action",
3093 "title": "Example usage:",
3094 "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",
3098 "name": "CreateProactive_Actions",
3099 "group": "Chat_Proactive_Actions",
3125 "field": "selector",
3138 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3140 "filename": "server/api/chatProactiveAction/index.js",
3141 "groupTitle": "Chat_Proactive_Actions"
3145 "url": "/api/chat/proactive_actions/{id}",
3146 "title": "Deletes a Proactive Action",
3149 "title": "Example usage:",
3150 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3154 "name": "DeleteProactive_Actions",
3155 "group": "Chat_Proactive_Actions",
3156 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3158 "filename": "server/api/chatProactiveAction/index.js",
3159 "groupTitle": "Chat_Proactive_Actions"
3163 "url": "/api/chat/proactive_actions/{id}",
3164 "title": "Gets a single Proactive Action",
3167 "title": "Example usage:",
3168 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3172 "name": "ShowProactive_Actions",
3173 "group": "Chat_Proactive_Actions",
3174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3176 "filename": "server/api/chatProactiveAction/index.js",
3177 "groupTitle": "Chat_Proactive_Actions"
3181 "url": "/api/chat/proactive_actions/{id}",
3182 "title": "Update an existing Proactive Action",
3185 "title": "Example usage:",
3186 "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",
3190 "name": "updateProactive_Actions",
3191 "group": "Chat_Proactive_Actions",
3192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3194 "filename": "server/api/chatProactiveAction/index.js",
3195 "groupTitle": "Chat_Proactive_Actions"
3199 "url": "/api/chat/reports/queue",
3200 "title": "Creates a new Chat Queue Report",
3203 "title": "Example usage:",
3204 "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",
3208 "name": "CreateChat_Queue_Reports",
3209 "group": "Chat_Queue_Reports",
3217 "field": "uniqueid",
3245 "field": "acceptAt",
3265 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3267 "filename": "server/api/chatQueueReport/index.js",
3268 "groupTitle": "Chat_Queue_Reports"
3272 "url": "/api/chat/reports/queue/{id}",
3273 "title": "Deletes a Chat Queue Report",
3276 "title": "Example usage:",
3277 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3281 "name": "DeleteChat_Queue_Reports",
3282 "group": "Chat_Queue_Reports",
3283 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3285 "filename": "server/api/chatQueueReport/index.js",
3286 "groupTitle": "Chat_Queue_Reports"
3290 "url": "/api/chat/reports/queue/describe",
3291 "title": "Gets table info about Chat Queue Reports",
3294 "title": "Example usage:",
3295 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3299 "name": "DescribeChat_Queue_Reports",
3300 "group": "Chat_Queue_Reports",
3301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3303 "filename": "server/api/chatQueueReport/index.js",
3304 "groupTitle": "Chat_Queue_Reports"
3308 "url": "/api/chat/reports/queue",
3309 "title": "Gets a list of Chat Queue Reports",
3312 "title": "Example usage:",
3313 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3317 "name": "GetChat_Queue_Reports",
3318 "group": "Chat_Queue_Reports",
3319 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3321 "filename": "server/api/chatQueueReport/index.js",
3322 "groupTitle": "Chat_Queue_Reports"
3326 "url": "/api/chat/reports/queue/{id}",
3327 "title": "Gets a single Chat Queue Report",
3330 "title": "Example usage:",
3331 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3335 "name": "ShowChat_Queue_Reports",
3336 "group": "Chat_Queue_Reports",
3337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3339 "filename": "server/api/chatQueueReport/index.js",
3340 "groupTitle": "Chat_Queue_Reports"
3344 "url": "/api/chat/reports/queue/{id}",
3345 "title": "Update an existing Chat Queue Report",
3348 "title": "Example usage:",
3349 "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",
3353 "name": "updateChat_Queue_Reports",
3354 "group": "Chat_Queue_Reports",
3355 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3357 "filename": "server/api/chatQueueReport/index.js",
3358 "groupTitle": "Chat_Queue_Reports"
3362 "url": "/api/chat/queues/{id}/users",
3363 "title": "Add agents to a queue",
3366 "title": "Example usage:",
3367 "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",
3371 "name": "AddAgents",
3372 "group": "Chat_Queues",
3373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3375 "filename": "server/api/chatQueue/index.js",
3376 "groupTitle": "Chat_Queues"
3380 "url": "/api/chat/queues/{id}/teams",
3381 "title": "Add teams to a queue",
3384 "title": "Example usage:",
3385 "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",
3390 "group": "Chat_Queues",
3391 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3393 "filename": "server/api/chatQueue/index.js",
3394 "groupTitle": "Chat_Queues"
3398 "url": "/api/chat/queues",
3399 "title": "Creates a new Queue",
3402 "title": "Example usage:",
3403 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3407 "name": "CreateQueues",
3408 "group": "Chat_Queues",
3423 "field": "description",
3442 "field": "strategy",
3448 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3450 "filename": "server/api/chatQueue/index.js",
3451 "groupTitle": "Chat_Queues"
3455 "url": "/api/chat/queues/{id}",
3456 "title": "Deletes a Queue",
3459 "title": "Example usage:",
3460 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3464 "name": "DeleteQueues",
3465 "group": "Chat_Queues",
3466 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3468 "filename": "server/api/chatQueue/index.js",
3469 "groupTitle": "Chat_Queues"
3473 "url": "/api/chat/queues/describe",
3474 "title": "Gets table info about Queues",
3477 "title": "Example usage:",
3478 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3482 "name": "DescribeQueues",
3483 "group": "Chat_Queues",
3484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3486 "filename": "server/api/chatQueue/index.js",
3487 "groupTitle": "Chat_Queues"
3491 "url": "/api/chat/queues/{id}/users",
3492 "title": "Gets queue agents",
3495 "title": "Example usage:",
3496 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3500 "name": "GetAgents",
3501 "group": "Chat_Queues",
3502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3504 "filename": "server/api/chatQueue/index.js",
3505 "groupTitle": "Chat_Queues"
3509 "url": "/api/chat/queues/{id}/members",
3510 "title": "GetMembers",
3513 "title": "Example usage:",
3514 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3518 "name": "GetMembers",
3519 "group": "Chat_Queues",
3520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3522 "filename": "server/api/chatQueue/index.js",
3523 "groupTitle": "Chat_Queues"
3527 "url": "/api/chat/queues",
3528 "title": "Gets a list of Queues",
3531 "title": "Example usage:",
3532 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3536 "name": "GetQueues",
3537 "group": "Chat_Queues",
3538 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3540 "filename": "server/api/chatQueue/index.js",
3541 "groupTitle": "Chat_Queues"
3545 "url": "/api/chat/queues/{id}/teams",
3546 "title": "Gets queues list",
3549 "title": "Example usage:",
3550 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3555 "group": "Chat_Queues",
3556 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3558 "filename": "server/api/chatQueue/index.js",
3559 "groupTitle": "Chat_Queues"
3563 "url": "/api/chat/queues/{id}/users",
3564 "title": "Removes agents from a queue",
3567 "title": "Example usage:",
3568 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3572 "name": "RemoveAgents",
3573 "group": "Chat_Queues",
3574 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3576 "filename": "server/api/chatQueue/index.js",
3577 "groupTitle": "Chat_Queues"
3581 "url": "/api/chat/queues/{id}",
3582 "title": "Gets a single Queue",
3585 "title": "Example usage:",
3586 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3590 "name": "ShowQueues",
3591 "group": "Chat_Queues",
3592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3594 "filename": "server/api/chatQueue/index.js",
3595 "groupTitle": "Chat_Queues"
3599 "url": "/api/chat/queues/{id}",
3600 "title": "Update an existing Queue",
3603 "title": "Example usage:",
3604 "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",
3608 "name": "updateQueues",
3609 "group": "Chat_Queues",
3610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3612 "filename": "server/api/chatQueue/index.js",
3613 "groupTitle": "Chat_Queues"
3617 "url": "/api/chat/reports/transfer",
3618 "title": "Creates a new Chat Transfer Report",
3621 "title": "Example usage:",
3622 "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",
3626 "name": "CreateChat_Transfer_Reports",
3627 "group": "Chat_Transfer_Reports",
3635 "field": "uniqueid",
3654 "field": "transferredAt",
3660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3662 "filename": "server/api/chatTransferReport/index.js",
3663 "groupTitle": "Chat_Transfer_Reports"
3667 "url": "/api/chat/reports/transfer/{id}",
3668 "title": "Deletes a Chat Transfer Report",
3671 "title": "Example usage:",
3672 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3676 "name": "DeleteChat_Transfer_Reports",
3677 "group": "Chat_Transfer_Reports",
3678 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3680 "filename": "server/api/chatTransferReport/index.js",
3681 "groupTitle": "Chat_Transfer_Reports"
3685 "url": "/api/chat/reports/transfer/describe",
3686 "title": "Gets table info about Chat Transfer Reports",
3689 "title": "Example usage:",
3690 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3694 "name": "DescribeChat_Transfer_Reports",
3695 "group": "Chat_Transfer_Reports",
3696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3698 "filename": "server/api/chatTransferReport/index.js",
3699 "groupTitle": "Chat_Transfer_Reports"
3703 "url": "/api/chat/reports/transfer",
3704 "title": "Gets a list of Chat Transfer Reports",
3707 "title": "Example usage:",
3708 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3712 "name": "GetChat_Transfer_Reports",
3713 "group": "Chat_Transfer_Reports",
3714 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3716 "filename": "server/api/chatTransferReport/index.js",
3717 "groupTitle": "Chat_Transfer_Reports"
3721 "url": "/api/chat/reports/transfer/{id}",
3722 "title": "Gets a single Chat Transfer Report",
3725 "title": "Example usage:",
3726 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3730 "name": "ShowChat_Transfer_Reports",
3731 "group": "Chat_Transfer_Reports",
3732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3734 "filename": "server/api/chatTransferReport/index.js",
3735 "groupTitle": "Chat_Transfer_Reports"
3739 "url": "/api/chat/reports/transfer/{id}",
3740 "title": "Update an existing Chat Transfer Report",
3743 "title": "Example usage:",
3744 "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",
3748 "name": "updateChat_Transfer_Reports",
3749 "group": "Chat_Transfer_Reports",
3750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3752 "filename": "server/api/chatTransferReport/index.js",
3753 "groupTitle": "Chat_Transfer_Reports"
3757 "url": "/api/chat/websites/{id}/users",
3758 "title": "Add agents to a website",
3761 "title": "Example usage:",
3762 "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",
3766 "name": "AddAgents",
3767 "group": "Chat_Websites",
3768 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3770 "filename": "server/api/chatWebsite/index.js",
3771 "groupTitle": "Chat_Websites"
3775 "url": "/api/chat/websites",
3776 "title": "Creates a new Website",
3779 "title": "Example usage:",
3780 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3784 "name": "CreateWebsites",
3785 "group": "Chat_Websites",
3807 "field": "description",
3821 "field": "mapKeyOffline",
3835 "field": "agentAlias",
3842 "field": "customerAlias",
3856 "field": "color_button",
3863 "field": "textColor",
3870 "field": "fontSize",
3884 "field": "animation",
3895 "field": "header_shape",
3902 "field": "header_online",
3909 "field": "start_chat_button",
3916 "field": "offline_chat_button",
3923 "field": "header_offline",
3930 "field": "download_transcript",
3944 "field": "whiteLabel",
3951 "field": "defaultWhiteLabel",
3965 "field": "closingQuestion",
3972 "field": "formSubmitSuccessMessage",
3979 "field": "formSubmitFailureMessage",
3986 "field": "noteTitle",
3993 "field": "placeholderMessage",
4000 "field": "closingMessage",
4007 "field": "closingMessageButton",
4014 "field": "skipMessageButton",
4021 "field": "conditionAgreement",
4028 "field": "enableRating",
4035 "field": "enableFeedback",
4042 "field": "enableSendButton",
4049 "field": "feedbackTitle",
4060 "field": "ratingType",
4067 "field": "ratingStarsNumber",
4074 "field": "onlineForm",
4081 "field": "offlineForm",
4095 "field": "autoclose",
4102 "field": "enableCustomerWriting",
4109 "field": "forwardTranscript",
4116 "field": "forwardTranscriptMessage",
4123 "field": "forwardOffline",
4130 "field": "forwardOfflineAddress",
4137 "field": "waitingTitle",
4144 "field": "waitingMessage",
4151 "field": "offlineMessageSubject",
4158 "field": "offlineMessageBody",
4165 "field": "enableUnmanagedNote",
4172 "field": "unmanagedMessage",
4179 "field": "skipUnmanaged",
4186 "field": "sendUnmanaged",
4193 "field": "enableCustomerAttachment",
4200 "field": "enableCustomerCheckmarks",
4207 "field": "agentAvatar",
4214 "field": "showAgentAvatar",
4221 "field": "timezone",
4228 "field": "notificationTemplate",
4235 "field": "notificationSound",
4242 "field": "notificationShake",
4249 "field": "hideWhenOffline",
4256 "field": "agentIdentifier",
4263 "field": "waitForTheAssignedAgent",
4270 "field": "alignment",
4277 "field": "verticalAlignment",
4284 "field": "messagesAlignment",
4291 "field": "defaultTitle",
4298 "field": "customerAvatar",
4305 "field": "showCustomerAvatar",
4312 "field": "messageFontSize",
4319 "field": "backgroundColor",
4326 "field": "queueTransfer",
4333 "field": "queueTransferTimeout",
4340 "field": "agentTransfer",
4347 "field": "agentTransferTimeout",
4354 "field": "systemAlias",
4361 "field": "systemAvatar",
4368 "field": "mandatoryDispositionPauseId",
4369 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4375 "field": "mandatoryDisposition",
4376 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4382 "field": "vidaooEscalation",
4389 "field": "vidaooApiKey",
4396 "field": "vidaooTopic",
4403 "field": "vidaooNote",
4410 "field": "vidaooMetadata",
4417 "field": "openNewInteraction",
4424 "field": "subjectOffline",
4430 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4432 "filename": "server/api/chatWebsite/index.js",
4433 "groupTitle": "Chat_Websites"
4437 "url": "/api/chat/websites/{id}",
4438 "title": "Deletes a Website",
4441 "title": "Example usage:",
4442 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4446 "name": "DeleteWebsites",
4447 "group": "Chat_Websites",
4448 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4450 "filename": "server/api/chatWebsite/index.js",
4451 "groupTitle": "Chat_Websites"
4455 "url": "/api/chat/websites/describe",
4456 "title": "Gets table info about Websites",
4459 "title": "Example usage:",
4460 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4464 "name": "DescribeWebsites",
4465 "group": "Chat_Websites",
4466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4468 "filename": "server/api/chatWebsite/index.js",
4469 "groupTitle": "Chat_Websites"
4473 "url": "/api/chat/websites/{id}/users",
4474 "title": "Gets agents from website",
4477 "title": "Example usage:",
4478 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4482 "name": "GetAgents",
4483 "group": "Chat_Websites",
4484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4486 "filename": "server/api/chatWebsite/index.js",
4487 "groupTitle": "Chat_Websites"
4491 "url": "/api/chat/websites",
4492 "title": "Gets a list of Websites",
4495 "title": "Example usage:",
4496 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4500 "name": "GetWebsites",
4501 "group": "Chat_Websites",
4502 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4504 "filename": "server/api/chatWebsite/index.js",
4505 "groupTitle": "Chat_Websites"
4509 "url": "/api/chat/websites/{id}/users",
4510 "title": "Removes agents from a website",
4513 "title": "Example usage:",
4514 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4518 "name": "RemoveAgents",
4519 "group": "Chat_Websites",
4520 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4522 "filename": "server/api/chatWebsite/index.js",
4523 "groupTitle": "Chat_Websites"
4527 "url": "/api/chat/websites/{id}/canned_answers",
4528 "title": "Removes canned answers from account",
4531 "title": "Example usage:",
4532 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4536 "name": "RemoveAnswers",
4537 "group": "Chat_Websites",
4538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4540 "filename": "server/api/chatWebsite/index.js",
4541 "groupTitle": "Chat_Websites"
4545 "url": "/api/chat/websites/{id}/dispositions",
4546 "title": "Removes canned answers from account",
4549 "title": "Example usage:",
4550 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4554 "name": "RemoveDispositions",
4555 "group": "Chat_Websites",
4556 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4558 "filename": "server/api/chatWebsite/index.js",
4559 "groupTitle": "Chat_Websites"
4563 "url": "/api/chat/websites/{id}",
4564 "title": "Gets a single Website",
4567 "title": "Example usage:",
4568 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4572 "name": "ShowWebsites",
4573 "group": "Chat_Websites",
4574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4576 "filename": "server/api/chatWebsite/index.js",
4577 "groupTitle": "Chat_Websites"
4581 "url": "/api/chat/messages/{id}/accept",
4582 "title": "Accepts message",
4585 "title": "Example usage:",
4586 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4590 "name": "acceptMessage",
4591 "group": "Chat_Websites",
4592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4594 "filename": "server/api/chatMessage/index.js",
4595 "groupTitle": "Chat_Websites"
4599 "url": "/api/chat/websites/{id}/canned_answers",
4600 "title": "Creates new canned answer",
4603 "title": "Example usage:",
4604 "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",
4608 "name": "addAnswer",
4609 "group": "Chat_Websites",
4631 "field": "description",
4644 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4646 "filename": "server/api/chatWebsite/index.js",
4647 "groupTitle": "Chat_Websites"
4651 "url": "/api/chat/websites/{id}/applications",
4652 "title": "Creates new applications",
4655 "title": "Example usage:",
4656 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4660 "name": "addApplications",
4661 "group": "Chat_Websites",
4669 "field": "priority",
4690 "field": "description",
4697 "field": "interval",
4703 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4705 "filename": "server/api/chatWebsite/index.js",
4706 "groupTitle": "Chat_Websites"
4710 "url": "/api/chat/websites/{id}/avatar",
4711 "title": "Add avatar",
4714 "title": "Example usage:",
4715 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4719 "name": "addAvatar",
4720 "group": "Chat_Websites",
4721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4723 "filename": "server/api/chatWebsite/index.js",
4724 "groupTitle": "Chat_Websites"
4728 "url": "/api/chat/websites/{id}/customer_avatar",
4729 "title": "Add customer avatar",
4732 "title": "Example usage:",
4733 "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",
4737 "name": "addCustomerAvatar",
4738 "group": "Chat_Websites",
4739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4741 "filename": "server/api/chatWebsite/index.js",
4742 "groupTitle": "Chat_Websites"
4746 "url": "/api/chat/websites/{id}/dispositions",
4747 "title": "Creates new disposition",
4750 "title": "Example usage:",
4751 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4755 "name": "addDisposition",
4756 "group": "Chat_Websites",
4783 "field": "description",
4789 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4791 "filename": "server/api/chatWebsite/index.js",
4792 "groupTitle": "Chat_Websites"
4796 "url": "/api/chat/accounts/{id}/interactions",
4797 "title": "Creates new interactions",
4800 "title": "Example usage:",
4801 "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",
4805 "name": "addInteraction",
4806 "group": "Chat_Websites",
4821 "field": "ratingValue",
4832 "field": "ratingType",
4839 "field": "ratingMessage",
4846 "field": "pathTranscript",
4853 "field": "mailTranscript",
4860 "field": "closedAt",
4867 "field": "disposition",
4874 "field": "secondDisposition",
4881 "field": "thirdDisposition",
4895 "field": "browserName",
4902 "field": "browserVersion",
4916 "field": "osVersion",
4923 "field": "deviceModel",
4930 "field": "deviceVendor",
4937 "field": "deviceType",
4951 "field": "customerIp",
4958 "field": "formData",
4965 "field": "read1stAt",
4972 "field": "lastMsgAt",
4983 "field": "lastMsgDirection",
4990 "field": "closeReason",
4997 "field": "customerPort",
5004 "field": "vidaooSessionId",
5011 "field": "autoreplyExecuted",
5017 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5019 "filename": "server/api/chatWebsite/index.js",
5020 "groupTitle": "Chat_Websites"
5024 "url": "/api/chat/websites/{id}/logo",
5025 "title": "Add logo",
5028 "title": "Example usage:",
5029 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5034 "group": "Chat_Websites",
5035 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5037 "filename": "server/api/chatWebsite/index.js",
5038 "groupTitle": "Chat_Websites"
5042 "url": "/api/chat/websites/{id}/proactive_actions",
5043 "title": "Creates new Proactive Actions",
5046 "title": "Example usage:",
5047 "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",
5051 "name": "addProactiveActions",
5052 "group": "Chat_Websites",
5078 "field": "selector",
5091 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5093 "filename": "server/api/chatWebsite/index.js",
5094 "groupTitle": "Chat_Websites"
5098 "url": "/api/chat/websites/{id}/system_avatar",
5099 "title": "Add system avatar",
5102 "title": "Example usage:",
5103 "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",
5107 "name": "addSystemAvatar",
5108 "group": "Chat_Websites",
5109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5111 "filename": "server/api/chatWebsite/index.js",
5112 "groupTitle": "Chat_Websites"
5116 "url": "/api/chat/websites/{id}/canned_answers",
5117 "title": "Gets account canned answers",
5120 "title": "Example usage:",
5121 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5125 "name": "getAnswers",
5126 "group": "Chat_Websites",
5127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5129 "filename": "server/api/chatWebsite/index.js",
5130 "groupTitle": "Chat_Websites"
5134 "url": "/api/chat/websites/{id}/applications",
5135 "title": "Gets Website Applications",
5138 "title": "Example usage:",
5139 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5143 "name": "getApplications",
5144 "group": "Chat_Websites",
5145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5147 "filename": "server/api/chatWebsite/index.js",
5148 "groupTitle": "Chat_Websites"
5152 "url": "/api/chat/websites/{id}/avatar",
5153 "title": "Get avatar",
5156 "title": "Example usage:",
5157 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5161 "name": "getAvatar",
5162 "group": "Chat_Websites",
5163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5165 "filename": "server/api/chatWebsite/index.js",
5166 "groupTitle": "Chat_Websites"
5170 "url": "/api/chat/websites/{id}/customer_avatar",
5171 "title": "Get Customer Avatar",
5174 "title": "Example usage:",
5175 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5179 "name": "getCustomerAvatar",
5180 "group": "Chat_Websites",
5181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5183 "filename": "server/api/chatWebsite/index.js",
5184 "groupTitle": "Chat_Websites"
5188 "url": "/api/chat/websites/{id}/dispositions",
5189 "title": "Gets account dispositions",
5192 "title": "Example usage:",
5193 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5197 "name": "getDispositions",
5198 "group": "Chat_Websites",
5199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5201 "filename": "server/api/chatWebsite/index.js",
5202 "groupTitle": "Chat_Websites"
5206 "url": "/api/chat/websites/{id}/fields",
5207 "title": "Gets Website Fields",
5210 "title": "Example usage:",
5211 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5215 "name": "getFields",
5216 "group": "Chat_Websites",
5217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5219 "filename": "server/api/chatWebsite/index.js",
5220 "groupTitle": "Chat_Websites"
5224 "url": "/api/chat/websites/{id}/interactions",
5225 "title": "Gets Website Interactions",
5228 "title": "Example usage:",
5229 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5233 "name": "getInteraction",
5234 "group": "Chat_Websites",
5235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5237 "filename": "server/api/chatWebsite/index.js",
5238 "groupTitle": "Chat_Websites"
5242 "url": "/api/chat/websites/{id}/logo",
5243 "title": "Get logo",
5246 "title": "Example usage:",
5247 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5252 "group": "Chat_Websites",
5253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5255 "filename": "server/api/chatWebsite/index.js",
5256 "groupTitle": "Chat_Websites"
5260 "url": "/api/chat/websites/{id}/offline_messages",
5261 "title": "Gets Website Offline Messages",
5264 "title": "Example usage:",
5265 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5269 "name": "getOfflineMessages",
5270 "group": "Chat_Websites",
5271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5273 "filename": "server/api/chatWebsite/index.js",
5274 "groupTitle": "Chat_Websites"
5278 "url": "/api/chat/websites/{id}/proactive_actions",
5279 "title": "Gets Website Proactive Actions",
5282 "title": "Example usage:",
5283 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5287 "name": "getProactiveActions",
5288 "group": "Chat_Websites",
5289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5291 "filename": "server/api/chatWebsite/index.js",
5292 "groupTitle": "Chat_Websites"
5296 "url": "/api/chat/websites/{id}/snippet",
5297 "title": "Gets Website Snippet",
5300 "title": "Example usage:",
5301 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5305 "name": "getSnippet",
5306 "group": "Chat_Websites",
5307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5309 "filename": "server/api/chatWebsite/index.js",
5310 "groupTitle": "Chat_Websites"
5314 "url": "/api/chat/websites/{id}/system_avatar",
5315 "title": "Get System Avatar",
5318 "title": "Example usage:",
5319 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5323 "name": "getSystemAvatar",
5324 "group": "Chat_Websites",
5325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5327 "filename": "server/api/chatWebsite/index.js",
5328 "groupTitle": "Chat_Websites"
5332 "url": "/api/chat/websites/{id}/notify",
5333 "title": "Notify new message",
5336 "title": "Example usage:",
5337 "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",
5342 "group": "Chat_Websites",
5343 "description": "<p>Motion 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>",
5345 "filename": "server/api/chatWebsite/index.js",
5346 "groupTitle": "Chat_Websites"
5350 "url": "/api/chat/websites/{id}/offline",
5351 "title": "Offline message",
5354 "title": "Example usage:",
5355 "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",
5360 "group": "Chat_Websites",
5361 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5363 "filename": "server/api/chatWebsite/index.js",
5364 "groupTitle": "Chat_Websites"
5368 "url": "/api/chat/messages/{id}/reject",
5369 "title": "Rejects message",
5372 "title": "Example usage:",
5373 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5377 "name": "rejectMessage",
5378 "group": "Chat_Websites",
5379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5381 "filename": "server/api/chatMessage/index.js",
5382 "groupTitle": "Chat_Websites"
5386 "url": "/api/chat/websites/{id}",
5387 "title": "Update an existing Website",
5390 "title": "Example usage:",
5391 "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",
5395 "name": "updateWebsites",
5396 "group": "Chat_Websites",
5397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5399 "filename": "server/api/chatWebsite/index.js",
5400 "groupTitle": "Chat_Websites"
5404 "url": "/api/cloudProviders",
5405 "title": "Creates a new CloudProvider",
5408 "title": "Example usage:",
5409 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5413 "name": "CreateCloudProviders",
5414 "group": "CloudProviders",
5453 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5455 "filename": "server/api/cloudProvider/index.js",
5456 "groupTitle": "CloudProviders"
5460 "url": "/api/cloudProviders/{id}",
5461 "title": "Deletes a CloudProvider",
5464 "title": "Example usage:",
5465 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5469 "name": "DeleteCloudProviders",
5470 "group": "CloudProviders",
5471 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5473 "filename": "server/api/cloudProvider/index.js",
5474 "groupTitle": "CloudProviders"
5478 "url": "/api/cloudProviders",
5479 "title": "Gets a list of CloudProviders",
5482 "title": "Example usage:",
5483 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5487 "name": "GetCloudProviders",
5488 "group": "CloudProviders",
5489 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5491 "filename": "server/api/cloudProvider/index.js",
5492 "groupTitle": "CloudProviders"
5496 "url": "/api/cloudProviders/{id}",
5497 "title": "Gets a single CloudProvider",
5500 "title": "Example usage:",
5501 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5505 "name": "ShowCloudProviders",
5506 "group": "CloudProviders",
5507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5509 "filename": "server/api/cloudProvider/index.js",
5510 "groupTitle": "CloudProviders"
5514 "url": "/api/cloudProviders/{id}",
5515 "title": "Update an existing CloudProvider",
5518 "title": "Example usage:",
5519 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5523 "name": "updateCloudProviders",
5524 "group": "CloudProviders",
5525 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5527 "filename": "server/api/cloudProvider/index.js",
5528 "groupTitle": "CloudProviders"
5532 "url": "/api/cm/companies",
5533 "title": "Creates a new Company",
5536 "title": "Example usage:",
5537 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5541 "name": "CreateCompanies",
5542 "group": "Cm_Companies",
5564 "field": "companyId",
5606 "field": "postalCode",
5634 "field": "emailDomain",
5648 "field": "sPostalCode",
5662 "field": "sCountry",
5669 "field": "description",
5675 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5677 "filename": "server/api/cmCompany/index.js",
5678 "groupTitle": "Cm_Companies"
5682 "url": "/api/cm/companies/{id}",
5683 "title": "Deletes a Company",
5686 "title": "Example usage:",
5687 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5691 "name": "DeleteCompanies",
5692 "group": "Cm_Companies",
5693 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5695 "filename": "server/api/cmCompany/index.js",
5696 "groupTitle": "Cm_Companies"
5700 "url": "/api/cm/companies/describe",
5701 "title": "Gets table info about Companies",
5704 "title": "Example usage:",
5705 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5709 "name": "DescribeCompanies",
5710 "group": "Cm_Companies",
5711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5713 "filename": "server/api/cmCompany/index.js",
5714 "groupTitle": "Cm_Companies"
5718 "url": "/api/cm/companies",
5719 "title": "Gets a list of Companies",
5722 "title": "Example usage:",
5723 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5727 "name": "GetCompanies",
5728 "group": "Cm_Companies",
5729 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5731 "filename": "server/api/cmCompany/index.js",
5732 "groupTitle": "Cm_Companies"
5736 "url": "/api/cm/companies/{id}",
5737 "title": "Gets a single Company",
5740 "title": "Example usage:",
5741 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5745 "name": "ShowCompanies",
5746 "group": "Cm_Companies",
5747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5749 "filename": "server/api/cmCompany/index.js",
5750 "groupTitle": "Cm_Companies"
5754 "url": "/api/cm/companies/{id}/contacts",
5755 "title": "Creates new contacts",
5758 "title": "Example usage:",
5759 "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",
5763 "name": "addContacts",
5764 "group": "Cm_Companies",
5772 "field": "firstName",
5779 "field": "lastName",
5793 "field": "postalCode",
5814 "field": "dateOfBirth",
5821 "field": "description",
5863 "field": "facebook",
5919 "field": "telegram",
5933 "field": "priority",
5940 "field": "scheduledat",
5946 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5948 "filename": "server/api/cmCompany/index.js",
5949 "groupTitle": "Cm_Companies"
5953 "url": "/api/cm/companies/{id}/contacts",
5954 "title": "Gets List Contacts",
5957 "title": "Example usage:",
5958 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5962 "name": "getContacts",
5963 "group": "Cm_Companies",
5964 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5966 "filename": "server/api/cmCompany/index.js",
5967 "groupTitle": "Cm_Companies"
5971 "url": "/api/cm/companies/{id}",
5972 "title": "Update an existing Company",
5975 "title": "Example usage:",
5976 "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",
5980 "name": "updateCompanies",
5981 "group": "Cm_Companies",
5982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5984 "filename": "server/api/cmCompany/index.js",
5985 "groupTitle": "Cm_Companies"
5989 "url": "/api/cm/contacts/{id}",
5990 "title": "Deletes a Contact",
5993 "title": "Example usage:",
5994 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5998 "name": "DeleteContacts",
5999 "group": "Cm_Contacts",
6000 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6002 "filename": "server/api/cmContact/index.js",
6003 "groupTitle": "Cm_Contacts"
6007 "url": "/api/cm/contacts/describe",
6008 "title": "Gets table info about Contacts",
6011 "title": "Example usage:",
6012 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6016 "name": "DescribeContacts",
6017 "group": "Cm_Contacts",
6018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6020 "filename": "server/api/cmContact/index.js",
6021 "groupTitle": "Cm_Contacts"
6025 "url": "/api/cm/contacts",
6026 "title": "Gets a list of Contacts",
6029 "title": "Example usage:",
6030 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6034 "name": "GetContacts",
6035 "group": "Cm_Contacts",
6036 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6038 "filename": "server/api/cmContact/index.js",
6039 "groupTitle": "Cm_Contacts"
6043 "url": "/api/cm/contacts/{id}/finals",
6044 "title": "Gets contact hopper finals",
6047 "title": "Example usage:",
6048 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6052 "name": "GetHopperFinals",
6053 "group": "Cm_Contacts",
6054 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6056 "filename": "server/api/cmContact/index.js",
6057 "groupTitle": "Cm_Contacts"
6061 "url": "/api/cm/contacts/{id}/hopper_histories",
6062 "title": "Gets contact hopper histories",
6065 "title": "Example usage:",
6066 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6070 "name": "GetHopperHistories",
6071 "group": "Cm_Contacts",
6072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6074 "filename": "server/api/cmContact/index.js",
6075 "groupTitle": "Cm_Contacts"
6079 "url": "/api/cm/contacts/{id}/hoppers",
6080 "title": "Gets contact hoppers",
6083 "title": "Example usage:",
6084 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6088 "name": "GetHoppers",
6089 "group": "Cm_Contacts",
6090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6092 "filename": "server/api/cmContact/index.js",
6093 "groupTitle": "Cm_Contacts"
6097 "url": "/api/cm/contacts/create_many",
6098 "title": "Create Contacts",
6101 "title": "Example usage:",
6102 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6106 "name": "bulkCreate",
6107 "group": "Cm_Contacts",
6108 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6110 "filename": "server/api/cmContact/index.js",
6111 "groupTitle": "Cm_Contacts"
6115 "url": "/api/cm/contacts",
6116 "title": "Create Contact",
6119 "title": "Example usage:",
6120 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6125 "group": "Cm_Contacts",
6126 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6128 "filename": "server/api/cmContact/index.js",
6129 "groupTitle": "Cm_Contacts"
6133 "url": "/api/cm/contacts/{id}/journey",
6134 "title": "Gets customer journey",
6137 "title": "Example usage:",
6138 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6142 "name": "getJourney",
6143 "group": "Cm_Contacts",
6144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6146 "filename": "server/api/cmContact/index.js",
6147 "groupTitle": "Cm_Contacts"
6151 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6152 "title": "Gets contact hopper blacks",
6155 "title": "Example usage:",
6156 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6160 "name": "getJscriptySessions",
6161 "group": "Cm_Contacts",
6162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6164 "filename": "server/api/cmContact/index.js",
6165 "groupTitle": "Cm_Contacts"
6169 "url": "/api/cm/contacts/{id}/tags",
6170 "title": "Gets configurations tags",
6173 "title": "Example usage:",
6174 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6179 "group": "Cm_Contacts",
6180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6182 "filename": "server/api/cmContact/index.js",
6183 "groupTitle": "Cm_Contacts"
6187 "url": "/api/cm/contacts/merge",
6188 "title": "Merge Contact",
6191 "title": "Example usage:",
6192 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6197 "group": "Cm_Contacts",
6198 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6200 "filename": "server/api/cmContact/index.js",
6201 "groupTitle": "Cm_Contacts"
6205 "url": "/api/cm/contacts/{id}/tags",
6206 "title": "Sets new tags",
6209 "title": "Example usage:",
6210 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6215 "group": "Cm_Contacts",
6216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6218 "filename": "server/api/cmContact/index.js",
6219 "groupTitle": "Cm_Contacts"
6223 "url": "/api/cm/contacts/{id}",
6224 "title": "Gets a single Contact",
6227 "title": "Example usage:",
6228 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6233 "group": "Cm_Contacts",
6234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6236 "filename": "server/api/cmContact/index.js",
6237 "groupTitle": "Cm_Contacts"
6241 "url": "/api/cm/contacts/{id}",
6242 "title": "Update a single Contact",
6245 "title": "Example usage:",
6246 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6251 "group": "Cm_Contacts",
6252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6254 "filename": "server/api/cmContact/index.js",
6255 "groupTitle": "Cm_Contacts"
6259 "url": "/api/cm/custom_fields/{id}",
6260 "title": "Deletes a Custom Field",
6263 "title": "Example usage:",
6264 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6268 "name": "DeleteCustom_Fields",
6269 "group": "Cm_Custom_Fields",
6270 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6272 "filename": "server/api/cmCustomField/index.js",
6273 "groupTitle": "Cm_Custom_Fields"
6277 "url": "/api/cm/custom_fields",
6278 "title": "Gets a list of Custom Fields",
6281 "title": "Example usage:",
6282 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6286 "name": "GetCustom_Fields",
6287 "group": "Cm_Custom_Fields",
6288 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6290 "filename": "server/api/cmCustomField/index.js",
6291 "groupTitle": "Cm_Custom_Fields"
6295 "url": "/api/cm/custom_fields/{id}",
6296 "title": "Gets a single Custom Field",
6299 "title": "Example usage:",
6300 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6304 "name": "ShowCustom_Fields",
6305 "group": "Cm_Custom_Fields",
6306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6308 "filename": "server/api/cmCustomField/index.js",
6309 "groupTitle": "Cm_Custom_Fields"
6313 "url": "/api/cm/custom_fields/{id}",
6314 "title": "Update an existing Custom Field",
6317 "title": "Example usage:",
6318 "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",
6322 "name": "updateCustom_Fields",
6323 "group": "Cm_Custom_Fields",
6324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6326 "filename": "server/api/cmCustomField/index.js",
6327 "groupTitle": "Cm_Custom_Fields"
6331 "url": "/api/cm/hopper",
6332 "title": "Creates a new Hopper",
6335 "title": "Example usage:",
6336 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6340 "name": "CreateHopper",
6341 "group": "Cm_Hopper",
6363 "field": "scheduledat",
6370 "field": "countbusyretry",
6377 "field": "countcongestionretry",
6384 "field": "countnoanswerretry",
6391 "field": "callback",
6398 "field": "callbackuniqueid",
6405 "field": "callbackat",
6412 "field": "priority",
6419 "field": "recallme",
6426 "field": "ContactId",
6447 "field": "VoiceQueueId",
6454 "field": "CampaignId",
6461 "field": "countnosuchnumberretry",
6468 "field": "countdropretry",
6475 "field": "countabandonedretry",
6482 "field": "countmachineretry",
6489 "field": "countagentrejectretry",
6495 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6497 "filename": "server/api/cmHopper/index.js",
6498 "groupTitle": "Cm_Hopper"
6502 "url": "/api/cm/hopper/describe",
6503 "title": "Gets table info about Hopper",
6506 "title": "Example usage:",
6507 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6511 "name": "DescribeHopper",
6512 "group": "Cm_Hopper",
6513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6515 "filename": "server/api/cmHopper/index.js",
6516 "groupTitle": "Cm_Hopper"
6520 "url": "/api/cm/hopper",
6521 "title": "Gets a list of Hopper",
6524 "title": "Example usage:",
6525 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6529 "name": "GetHopper",
6530 "group": "Cm_Hopper",
6531 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6533 "filename": "server/api/cmHopper/index.js",
6534 "groupTitle": "Cm_Hopper"
6538 "url": "/api/cm/hopper/{id}",
6539 "title": "Gets a single Hopper",
6542 "title": "Example usage:",
6543 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6547 "name": "ShowHopper",
6548 "group": "Cm_Hopper",
6549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6551 "filename": "server/api/cmHopper/index.js",
6552 "groupTitle": "Cm_Hopper"
6556 "url": "/api/cm/hopper_black/{id}",
6557 "title": "Deletes a Hopper Black",
6560 "title": "Example usage:",
6561 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6565 "name": "DeleteHopper_Black",
6566 "group": "Cm_Hopper_Black",
6567 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6569 "filename": "server/api/cmHopperBlack/index.js",
6570 "groupTitle": "Cm_Hopper_Black"
6574 "url": "/api/cm/hopper_black/describe",
6575 "title": "Gets table info about Hopper Black",
6578 "title": "Example usage:",
6579 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6583 "name": "DescribeHopper_Black",
6584 "group": "Cm_Hopper_Black",
6585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6587 "filename": "server/api/cmHopperBlack/index.js",
6588 "groupTitle": "Cm_Hopper_Black"
6592 "url": "/api/cm/hopper_black",
6593 "title": "Gets a list of Hopper Black",
6596 "title": "Example usage:",
6597 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6601 "name": "GetHopper_Black",
6602 "group": "Cm_Hopper_Black",
6603 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6605 "filename": "server/api/cmHopperBlack/index.js",
6606 "groupTitle": "Cm_Hopper_Black"
6610 "url": "/api/cm/hopper_black/{id}",
6611 "title": "Gets a single Hopper Black",
6614 "title": "Example usage:",
6615 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6619 "name": "ShowHopper_Black",
6620 "group": "Cm_Hopper_Black",
6621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6623 "filename": "server/api/cmHopperBlack/index.js",
6624 "groupTitle": "Cm_Hopper_Black"
6628 "url": "/api/cm/hopper_black/{id}",
6629 "title": "Update an existing Hopper Black",
6632 "title": "Example usage:",
6633 "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",
6637 "name": "updateHopper_Black",
6638 "group": "Cm_Hopper_Black",
6639 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6641 "filename": "server/api/cmHopperBlack/index.js",
6642 "groupTitle": "Cm_Hopper_Black"
6646 "url": "/api/cm/hopper_final/checkContactHopper",
6647 "title": "Check if contact is in hopper",
6650 "title": "Example usage:",
6651 "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",
6655 "name": "/checkContactHopper",
6656 "group": "Cm_Hopper_Final",
6657 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6659 "filename": "server/api/cmHopperFinal/index.js",
6660 "groupTitle": "Cm_Hopper_Final"
6664 "url": "/api/cm/hopper_final/describe",
6665 "title": "Gets table info about HopperFinal",
6668 "title": "Example usage:",
6669 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6673 "name": "DescribeHopperFinal",
6674 "group": "Cm_Hopper_Final",
6675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6677 "filename": "server/api/cmHopperFinal/index.js",
6678 "groupTitle": "Cm_Hopper_Final"
6682 "url": "/api/cm/hopper_final",
6683 "title": "Gets a list of HopperFinal",
6686 "title": "Example usage:",
6687 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6691 "name": "GetHopperFinal",
6692 "group": "Cm_Hopper_Final",
6693 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6695 "filename": "server/api/cmHopperFinal/index.js",
6696 "groupTitle": "Cm_Hopper_Final"
6700 "url": "/api/cm/hopper_final/{id}",
6701 "title": "Gets a single HopperFinal",
6704 "title": "Example usage:",
6705 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6709 "name": "ShowHopperFinal",
6710 "group": "Cm_Hopper_Final",
6711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6713 "filename": "server/api/cmHopperFinal/index.js",
6714 "groupTitle": "Cm_Hopper_Final"
6718 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6719 "title": "Return number contacts for attributes",
6722 "title": "Example usage:",
6723 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6727 "name": "countContactsIvrCampaignHopperFinal",
6728 "group": "Cm_Hopper_Final",
6729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6731 "filename": "server/api/cmHopperFinal/index.js",
6732 "groupTitle": "Cm_Hopper_Final"
6736 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6737 "title": "Return number contacts for attributes",
6740 "title": "Example usage:",
6741 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6745 "name": "countContactsQueueCampaignHopperFinal",
6746 "group": "Cm_Hopper_Final",
6747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6749 "filename": "server/api/cmHopperFinal/index.js",
6750 "groupTitle": "Cm_Hopper_Final"
6754 "url": "/api/cm/hopper_final/campaign/{id}",
6755 "title": "Move contacts in hopper",
6758 "title": "Example usage:",
6759 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6763 "name": "moveContactsIvrCampaignHopperFinal",
6764 "group": "Cm_Hopper_Final",
6765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6767 "filename": "server/api/cmHopperFinal/index.js",
6768 "groupTitle": "Cm_Hopper_Final"
6772 "url": "/api/cm/hopper_final/voice/queue/{id}",
6773 "title": "Move contacts in hopper",
6776 "title": "Example usage:",
6777 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6781 "name": "moveContactsQueueCampaignHopperFinal",
6782 "group": "Cm_Hopper_Final",
6783 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6785 "filename": "server/api/cmHopperFinal/index.js",
6786 "groupTitle": "Cm_Hopper_Final"
6790 "url": "/api/cm/hopper_final/{id}",
6791 "title": "Update a single hopper final",
6794 "title": "Example usage:",
6795 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6800 "group": "Cm_Hopper_Final",
6801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6803 "filename": "server/api/cmHopperFinal/index.js",
6804 "groupTitle": "Cm_Hopper_Final"
6808 "url": "/api/cm/hopper_history",
6809 "title": "Creates a new HopperHistory",
6812 "title": "Example usage:",
6813 "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",
6817 "name": "CreateHopperHistory",
6818 "group": "Cm_Hopper_History",
6833 "field": "statedesc",
6840 "field": "scheduledat",
6847 "field": "countbusyretry",
6854 "field": "countcongestionretry",
6861 "field": "countnoanswerretry",
6868 "field": "countglobal",
6875 "field": "uniqueid",
6882 "field": "originatecalleridnum",
6889 "field": "originatecalleridname",
6896 "field": "calleridnum",
6903 "field": "calleridname",
6910 "field": "starttime",
6917 "field": "responsetime",
6924 "field": "answertime",
6931 "field": "droptime",
6945 "field": "ringtime",
6952 "field": "holdtime",
6959 "field": "talktime",
6966 "field": "followuptime",
6973 "field": "dropreason",
6980 "field": "campaign",
6987 "field": "campaigntype",
6994 "field": "membername",
7022 "field": "callback",
7029 "field": "callbackuniqueid",
7036 "field": "callbackat",
7043 "field": "recallme",
7050 "field": "editedat",
7064 "field": "countnosuchnumberretry",
7071 "field": "countdropretry",
7078 "field": "countabandonedretry",
7085 "field": "countmachineretry",
7092 "field": "countagentrejectretry",
7098 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7100 "filename": "server/api/cmHopperHistory/index.js",
7101 "groupTitle": "Cm_Hopper_History"
7105 "url": "/api/cm/hopper_history/describe",
7106 "title": "Gets table info about HopperHistory",
7109 "title": "Example usage:",
7110 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7114 "name": "DescribeHopperHistory",
7115 "group": "Cm_Hopper_History",
7116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7118 "filename": "server/api/cmHopperHistory/index.js",
7119 "groupTitle": "Cm_Hopper_History"
7123 "url": "/api/cm/hopper_history",
7124 "title": "Gets a list of HopperHistory",
7127 "title": "Example usage:",
7128 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7132 "name": "GetHopperHistory",
7133 "group": "Cm_Hopper_History",
7134 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7136 "filename": "server/api/cmHopperHistory/index.js",
7137 "groupTitle": "Cm_Hopper_History"
7141 "url": "/api/cm/hopper_history/{id}",
7142 "title": "Gets a single HopperHistory",
7145 "title": "Example usage:",
7146 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7150 "name": "ShowHopperHistory",
7151 "group": "Cm_Hopper_History",
7152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7154 "filename": "server/api/cmHopperHistory/index.js",
7155 "groupTitle": "Cm_Hopper_History"
7159 "url": "/api/cm/hopper_history/{id}",
7160 "title": "Update a single hopper history",
7163 "title": "Example usage:",
7164 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7169 "group": "Cm_Hopper_History",
7170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7172 "filename": "server/api/cmHopperHistory/index.js",
7173 "groupTitle": "Cm_Hopper_History"
7177 "url": "/api/cm/hopper/{id}",
7178 "title": "Delete Hopper",
7181 "title": "Example usage:",
7182 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7187 "group": "Cm_Hopper",
7188 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7190 "filename": "server/api/cmHopper/index.js",
7191 "groupTitle": "Cm_Hopper"
7195 "url": "/api/cm/hopper/opencontacts",
7196 "title": "Gets Open Contacts",
7199 "title": "Example usage:",
7200 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7204 "name": "getOpenContacts",
7205 "group": "Cm_Hopper",
7206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7208 "filename": "server/api/cmHopper/index.js",
7209 "groupTitle": "Cm_Hopper"
7213 "url": "/api/cm/hopper/preview",
7214 "title": "Gets Preview Dialer Contacts",
7217 "title": "Example usage:",
7218 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7222 "name": "getPreview",
7223 "group": "Cm_Hopper",
7224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7226 "filename": "server/api/cmHopper/index.js",
7227 "groupTitle": "Cm_Hopper"
7231 "url": "/api/cm/hopper/{id}",
7232 "title": "Update an existing Hopper",
7235 "title": "Example usage:",
7236 "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",
7240 "name": "updateHopper",
7241 "group": "Cm_Hopper",
7242 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7244 "filename": "server/api/cmHopper/index.js",
7245 "groupTitle": "Cm_Hopper"
7249 "url": "/api/cm/lists",
7250 "title": "Creates a new List",
7253 "title": "Example usage:",
7254 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7258 "name": "CreateLists",
7259 "group": "Cm_Lists",
7274 "field": "description",
7281 "field": "dialPrefix",
7287 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7289 "filename": "server/api/cmList/index.js",
7290 "groupTitle": "Cm_Lists"
7294 "url": "/api/cm/lists/{id}",
7295 "title": "Deletes a List",
7298 "title": "Example usage:",
7299 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7303 "name": "DeleteLists",
7304 "group": "Cm_Lists",
7305 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7307 "filename": "server/api/cmList/index.js",
7308 "groupTitle": "Cm_Lists"
7312 "url": "/api/cm/lists/describe",
7313 "title": "Gets table info about Lists",
7316 "title": "Example usage:",
7317 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7321 "name": "DescribeLists",
7322 "group": "Cm_Lists",
7323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7325 "filename": "server/api/cmList/index.js",
7326 "groupTitle": "Cm_Lists"
7330 "url": "/api/cm/lists/{id}/users",
7331 "title": "Gets agents from list",
7334 "title": "Example usage:",
7335 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7339 "name": "GetAgents",
7340 "group": "Cm_Lists",
7341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7343 "filename": "server/api/cmList/index.js",
7344 "groupTitle": "Cm_Lists"
7348 "url": "/api/cm/lists",
7349 "title": "Gets a list of Lists",
7352 "title": "Example usage:",
7353 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7358 "group": "Cm_Lists",
7359 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7361 "filename": "server/api/cmList/index.js",
7362 "groupTitle": "Cm_Lists"
7366 "url": "/api/cm/lists/{id}/users",
7367 "title": "Removes agents from a list",
7370 "title": "Example usage:",
7371 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7375 "name": "RemoveAgents",
7376 "group": "Cm_Lists",
7377 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7379 "filename": "server/api/cmList/index.js",
7380 "groupTitle": "Cm_Lists"
7384 "url": "/api/cm/lists/{id}/dispositions",
7385 "title": "Removes dispositions from account",
7388 "title": "Example usage:",
7389 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7393 "name": "RemoveDispositions",
7394 "group": "Cm_Lists",
7395 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7397 "filename": "server/api/cmList/index.js",
7398 "groupTitle": "Cm_Lists"
7402 "url": "/api/cm/lists/{id}",
7403 "title": "Gets a single List",
7406 "title": "Example usage:",
7407 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7411 "name": "ShowLists",
7412 "group": "Cm_Lists",
7413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7415 "filename": "server/api/cmList/index.js",
7416 "groupTitle": "Cm_Lists"
7420 "url": "/api/cm/lists/{id}/users",
7421 "title": "Adds agents to a list",
7424 "title": "Example usage:",
7425 "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",
7429 "name": "addAgents",
7430 "group": "Cm_Lists",
7431 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7433 "filename": "server/api/cmList/index.js",
7434 "groupTitle": "Cm_Lists"
7438 "url": "/api/cm/lists/{id}/contacts",
7439 "title": "Creates new contacts",
7442 "title": "Example usage:",
7443 "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",
7447 "name": "addContacts",
7448 "group": "Cm_Lists",
7456 "field": "firstName",
7463 "field": "lastName",
7477 "field": "postalCode",
7498 "field": "dateOfBirth",
7505 "field": "description",
7547 "field": "facebook",
7603 "field": "telegram",
7617 "field": "priority",
7624 "field": "scheduledat",
7630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7632 "filename": "server/api/cmList/index.js",
7633 "groupTitle": "Cm_Lists"
7637 "url": "/api/cm/lists/{id}/fields",
7638 "title": "Creates a new custom field",
7641 "title": "Example usage:",
7642 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7646 "name": "addCustomField",
7647 "group": "Cm_Lists",
7648 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7650 "filename": "server/api/cmList/index.js",
7651 "groupTitle": "Cm_Lists"
7655 "url": "/api/cm/lists/{id}/dispositions",
7656 "title": "Creates new disposition",
7659 "title": "Example usage:",
7660 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7664 "name": "addDisposition",
7665 "group": "Cm_Lists",
7692 "field": "description",
7698 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7700 "filename": "server/api/cmList/index.js",
7701 "groupTitle": "Cm_Lists"
7705 "url": "/api/cm/lists/{id}/contacts",
7706 "title": "Gets List Contacts",
7709 "title": "Example usage:",
7710 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7714 "name": "getContacts",
7715 "group": "Cm_Lists",
7716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7718 "filename": "server/api/cmList/index.js",
7719 "groupTitle": "Cm_Lists"
7723 "url": "/api/cm/lists/{id}/fields",
7724 "title": "Gets Custom Fields",
7727 "title": "Example usage:",
7728 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7732 "name": "getCustomFields",
7733 "group": "Cm_Lists",
7734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7736 "filename": "server/api/cmList/index.js",
7737 "groupTitle": "Cm_Lists"
7741 "url": "/api/cm/lists/{id}/dispositions",
7742 "title": "Gets list dispositions",
7745 "title": "Example usage:",
7746 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7750 "name": "getDispositions",
7751 "group": "Cm_Lists",
7752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7754 "filename": "server/api/cmList/index.js",
7755 "groupTitle": "Cm_Lists"
7759 "url": "/api/cm/lists/{id}/contacts/csv",
7760 "title": "Gets CSV List Contacts",
7763 "title": "Example usage:",
7764 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7769 "group": "Cm_Lists",
7770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7772 "filename": "server/api/cmList/index.js",
7773 "groupTitle": "Cm_Lists"
7777 "url": "/api/cm/lists/{id}",
7778 "title": "Update an existing List",
7781 "title": "Example usage:",
7782 "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",
7786 "name": "updateLists",
7787 "group": "Cm_Lists",
7788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7790 "filename": "server/api/cmList/index.js",
7791 "groupTitle": "Cm_Lists"
7795 "url": "/api/cm/contacts/upload/:id",
7796 "title": "Import new contacts by csv",
7799 "title": "Example usage:",
7800 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7805 "group": "Cm_contacts",
7806 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7808 "filename": "server/api/cmContact/index.js",
7809 "groupTitle": "Cm_contacts"
7813 "url": "/api/cm/contacts/upload",
7814 "title": "Upload csv",
7817 "title": "Example usage:",
7818 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7823 "group": "Cm_contacts",
7824 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7826 "filename": "server/api/cmContact/index.js",
7827 "groupTitle": "Cm_contacts"
7831 "url": "/api/cm/contacts/csv",
7832 "title": "Create new contacts by csv",
7835 "title": "Example usage:",
7836 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7840 "name": "uploadCsv",
7841 "group": "Cm_contacts",
7842 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7844 "filename": "server/api/cmContact/index.js",
7845 "groupTitle": "Cm_contacts"
7849 "url": "/api/conditions/{id}",
7850 "title": "Deletes a Condition",
7853 "title": "Example usage:",
7854 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7858 "name": "DeleteConditions",
7859 "group": "Conditions",
7860 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7862 "filename": "server/api/condition/index.js",
7863 "groupTitle": "Conditions"
7867 "url": "/api/conditions/{id}",
7868 "title": "Update an existing Condition",
7871 "title": "Example usage:",
7872 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7876 "name": "updateConditions",
7877 "group": "Conditions",
7878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7880 "filename": "server/api/condition/index.js",
7881 "groupTitle": "Conditions"
7885 "url": "/api/cm/custom_field",
7886 "title": "Create a new custom field",
7889 "title": "Example usage:",
7890 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7894 "name": "CreateCustomField",
7895 "group": "Custom_Fields",
7896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7898 "filename": "server/api/cmCustomField/index.js",
7899 "groupTitle": "Custom_Fields"
7903 "url": "/api/dashboards/items",
7904 "title": "Create dasboard item",
7907 "title": "Example usage:",
7908 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7913 "group": "Dashboard_Items",
7914 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7916 "filename": "server/api/dashboardItem/index.js",
7917 "groupTitle": "Dashboard_Items"
7921 "url": "/api/dashboards/items/{id}",
7922 "title": "Deletes a Dashboard Item",
7925 "title": "Example usage:",
7926 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7930 "name": "DeleteDashboard_Items",
7931 "group": "Dashboard_Items",
7932 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7934 "filename": "server/api/dashboardItem/index.js",
7935 "groupTitle": "Dashboard_Items"
7939 "url": "/api/dashboards/items/{id}",
7940 "title": "Gets a single Dashboard Item",
7943 "title": "Example usage:",
7944 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7948 "name": "ShowDashboard_Items",
7949 "group": "Dashboard_Items",
7950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7952 "filename": "server/api/dashboardItem/index.js",
7953 "groupTitle": "Dashboard_Items"
7957 "url": "/api/dashboards/items/{id}",
7958 "title": "Update an existing item",
7961 "title": "Example usage:",
7962 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7967 "group": "Dashboard_Items",
7968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7970 "filename": "server/api/dashboardItem/index.js",
7971 "groupTitle": "Dashboard_Items"
7975 "url": "/api/dashboards/clone",
7976 "title": "Clone an existing Dashboard",
7979 "title": "Example usage:",
7980 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7984 "name": "CloneDashboards",
7985 "group": "Dashboards",
7986 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7988 "filename": "server/api/dashboard/index.js",
7989 "groupTitle": "Dashboards"
7993 "url": "/api/dashboards",
7994 "title": "Creates a new Dashboard",
7997 "title": "Example usage:",
7998 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8002 "name": "CreateDashboards",
8003 "group": "Dashboards",
8018 "field": "description",
8024 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8026 "filename": "server/api/dashboard/index.js",
8027 "groupTitle": "Dashboards"
8031 "url": "/api/dashboards/{id}",
8032 "title": "Deletes a Dashboard",
8035 "title": "Example usage:",
8036 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8040 "name": "DeleteDashboards",
8041 "group": "Dashboards",
8042 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8044 "filename": "server/api/dashboard/index.js",
8045 "groupTitle": "Dashboards"
8049 "url": "/api/dashboards",
8050 "title": "Gets a list of Dashboards",
8053 "title": "Example usage:",
8054 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8058 "name": "GetDashboards",
8059 "group": "Dashboards",
8060 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8062 "filename": "server/api/dashboard/index.js",
8063 "groupTitle": "Dashboards"
8067 "url": "/api/dashboards/{id}",
8068 "title": "Gets a single Dashboard",
8071 "title": "Example usage:",
8072 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8076 "name": "ShowDashboards",
8077 "group": "Dashboards",
8078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8080 "filename": "server/api/dashboard/index.js",
8081 "groupTitle": "Dashboards"
8085 "url": "/api/dashboards/{id}/items",
8086 "title": "Creates new item",
8089 "title": "Example usage:",
8090 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8095 "group": "Dashboards",
8096 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8098 "filename": "server/api/dashboard/index.js",
8099 "groupTitle": "Dashboards"
8103 "url": "/api/dashboards/{id}/items",
8104 "title": "Gets items",
8107 "title": "Example usage:",
8108 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8113 "group": "Dashboards",
8114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8116 "filename": "server/api/dashboard/index.js",
8117 "groupTitle": "Dashboards"
8121 "url": "/api/dashboards/{id}",
8122 "title": "Update an existing Dashboard",
8125 "title": "Example usage:",
8126 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8130 "name": "updateDashboards",
8131 "group": "Dashboards",
8132 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8134 "filename": "server/api/dashboard/index.js",
8135 "groupTitle": "Dashboards"
8139 "url": "/api/integrations/desk/accounts",
8140 "title": "Creates a new Desk Account",
8143 "title": "Example usage:",
8144 "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",
8148 "name": "CreateDesk_Accounts",
8149 "group": "Desk_Accounts",
8164 "field": "description",
8171 "field": "username",
8178 "field": "remoteUri",
8188 "field": "authType",
8195 "field": "password",
8202 "field": "consumerKey",
8209 "field": "consumerSecret",
8223 "field": "tokenSecret",
8230 "field": "serverUrl",
8237 "\"integrationTab\"",
8247 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8249 "filename": "server/api/intDeskAccount/index.js",
8250 "groupTitle": "Desk_Accounts"
8254 "url": "/api/integrations/desk/accounts/{id}",
8255 "title": "Deletes a Desk Account",
8258 "title": "Example usage:",
8259 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8263 "name": "DeleteDesk_Accounts",
8264 "group": "Desk_Accounts",
8265 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8267 "filename": "server/api/intDeskAccount/index.js",
8268 "groupTitle": "Desk_Accounts"
8272 "url": "/api/integrations/desk/accounts",
8273 "title": "Gets a list of Desk Accounts",
8276 "title": "Example usage:",
8277 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8281 "name": "GetDesk_Accounts",
8282 "group": "Desk_Accounts",
8283 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8285 "filename": "server/api/intDeskAccount/index.js",
8286 "groupTitle": "Desk_Accounts"
8290 "url": "/api/integrations/desk/accounts/{id}",
8291 "title": "Gets a single Desk Account",
8294 "title": "Example usage:",
8295 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8299 "name": "ShowDesk_Accounts",
8300 "group": "Desk_Accounts",
8301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8303 "filename": "server/api/intDeskAccount/index.js",
8304 "groupTitle": "Desk_Accounts"
8308 "url": "/api/integrations/desk/accounts/{id}/configurations",
8309 "title": "Creates new configuration",
8312 "title": "Example usage:",
8313 "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",
8317 "name": "addConfiguration",
8318 "group": "Desk_Accounts",
8319 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8321 "filename": "server/api/intDeskAccount/index.js",
8322 "groupTitle": "Desk_Accounts"
8326 "url": "/api/integrations/desk/accounts/{id}/configurations",
8327 "title": "Gets account configurations",
8330 "title": "Example usage:",
8331 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8335 "name": "getConfigurations",
8336 "group": "Desk_Accounts",
8337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8339 "filename": "server/api/intDeskAccount/index.js",
8340 "groupTitle": "Desk_Accounts"
8344 "url": "/api/integrations/desk/accounts/{id}/fields",
8345 "title": "Gets account fields",
8348 "title": "Example usage:",
8349 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8353 "name": "getFields",
8354 "group": "Desk_Accounts",
8355 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8357 "filename": "server/api/intDeskAccount/index.js",
8358 "groupTitle": "Desk_Accounts"
8362 "url": "/api/integrations/desk/accounts/{id}",
8363 "title": "Update an existing Desk Account",
8366 "title": "Example usage:",
8367 "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",
8371 "name": "updateDesk_Accounts",
8372 "group": "Desk_Accounts",
8373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8375 "filename": "server/api/intDeskAccount/index.js",
8376 "groupTitle": "Desk_Accounts"
8380 "url": "/api/integrations/desk/configurations",
8381 "title": "Creates a new Desk Configuration",
8384 "title": "Example usage:",
8385 "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",
8389 "name": "CreateDesk_Configurations",
8390 "group": "Desk_Configurations",
8405 "field": "description",
8411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8413 "filename": "server/api/intDeskConfiguration/index.js",
8414 "groupTitle": "Desk_Configurations"
8418 "url": "/api/integrations/desk/configurations/{id}",
8419 "title": "Deletes a Desk Configuration",
8422 "title": "Example usage:",
8423 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8427 "name": "DeleteDesk_Configurations",
8428 "group": "Desk_Configurations",
8429 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8431 "filename": "server/api/intDeskConfiguration/index.js",
8432 "groupTitle": "Desk_Configurations"
8436 "url": "/api/integrations/desk/configurations",
8437 "title": "Gets a list of Desk Configurations",
8440 "title": "Example usage:",
8441 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8445 "name": "GetDesk_Configurations",
8446 "group": "Desk_Configurations",
8447 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8449 "filename": "server/api/intDeskConfiguration/index.js",
8450 "groupTitle": "Desk_Configurations"
8454 "url": "/api/integrations/desk/configurations/{id}",
8455 "title": "Gets a single Desk Configuration",
8458 "title": "Example usage:",
8459 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8463 "name": "ShowDesk_Configurations",
8464 "group": "Desk_Configurations",
8465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8467 "filename": "server/api/intDeskConfiguration/index.js",
8468 "groupTitle": "Desk_Configurations"
8472 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8473 "title": "Gets configurations descriptions",
8476 "title": "Example usage:",
8477 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8481 "name": "getDescriptions",
8482 "group": "Desk_Configurations",
8483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8485 "filename": "server/api/intDeskConfiguration/index.js",
8486 "groupTitle": "Desk_Configurations"
8490 "url": "/api/integrations/desk/configurations/{id}/fields",
8491 "title": "Gets configurations fields",
8494 "title": "Example usage:",
8495 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8499 "name": "getFields",
8500 "group": "Desk_Configurations",
8501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8503 "filename": "server/api/intDeskConfiguration/index.js",
8504 "groupTitle": "Desk_Configurations"
8508 "url": "/api/integrations/desk/configurations/{id}/subjects",
8509 "title": "Gets configurations subjects",
8512 "title": "Example usage:",
8513 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8517 "name": "getSubjects",
8518 "group": "Desk_Configurations",
8519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8521 "filename": "server/api/intDeskConfiguration/index.js",
8522 "groupTitle": "Desk_Configurations"
8526 "url": "/api/integrations/desk/configurations/{id}/tags",
8527 "title": "Gets configurations tags",
8530 "title": "Example usage:",
8531 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8536 "group": "Desk_Configurations",
8537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8539 "filename": "server/api/intDeskConfiguration/index.js",
8540 "groupTitle": "Desk_Configurations"
8544 "url": "/api/integrations/desk/configurations/{id}/tags",
8545 "title": "Sets new tags",
8548 "title": "Example usage:",
8549 "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",
8554 "group": "Desk_Configurations",
8555 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8557 "filename": "server/api/intDeskConfiguration/index.js",
8558 "groupTitle": "Desk_Configurations"
8562 "url": "/api/integrations/desk/configurations/{id}",
8563 "title": "Update an existing Desk Configuration",
8566 "title": "Example usage:",
8567 "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",
8571 "name": "updateDesk_Configurations",
8572 "group": "Desk_Configurations",
8573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8575 "filename": "server/api/intDeskConfiguration/index.js",
8576 "groupTitle": "Desk_Configurations"
8580 "url": "/api/integrations/desk/fields",
8581 "title": "Creates a new Desk Field",
8584 "title": "Example usage:",
8585 "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",
8589 "name": "CreateDesk_Fields",
8590 "group": "Desk_Fields",
8600 "\"customVariable\"",
8628 "\"customVariable\""
8638 "field": "keyContent",
8652 "field": "nameField",
8659 "field": "customField",
8666 "field": "variableName",
8672 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8674 "filename": "server/api/intDeskField/index.js",
8675 "groupTitle": "Desk_Fields"
8679 "url": "/api/integrations/desk/fields/{id}",
8680 "title": "Deletes a Desk Field",
8683 "title": "Example usage:",
8684 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8688 "name": "DeleteDesk_Fields",
8689 "group": "Desk_Fields",
8690 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8692 "filename": "server/api/intDeskField/index.js",
8693 "groupTitle": "Desk_Fields"
8697 "url": "/api/integrations/desk/fields",
8698 "title": "Gets a list of Desk Fields",
8701 "title": "Example usage:",
8702 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8706 "name": "GetDesk_Fields",
8707 "group": "Desk_Fields",
8708 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8710 "filename": "server/api/intDeskField/index.js",
8711 "groupTitle": "Desk_Fields"
8715 "url": "/api/integrations/desk/fields/{id}",
8716 "title": "Gets a single Desk Field",
8719 "title": "Example usage:",
8720 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8724 "name": "ShowDesk_Fields",
8725 "group": "Desk_Fields",
8726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8728 "filename": "server/api/intDeskField/index.js",
8729 "groupTitle": "Desk_Fields"
8733 "url": "/api/integrations/desk/fields/{id}",
8734 "title": "Update an existing Desk Field",
8737 "title": "Example usage:",
8738 "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",
8742 "name": "updateDesk_Fields",
8743 "group": "Desk_Fields",
8744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8746 "filename": "server/api/intDeskField/index.js",
8747 "groupTitle": "Desk_Fields"
8751 "url": "/api/dispositions",
8752 "title": "Creates a new Disposition",
8755 "title": "Example usage:",
8756 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8760 "name": "CreateDispositions",
8761 "group": "Dispositions",
8788 "field": "description",
8794 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8796 "filename": "server/api/disposition/index.js",
8797 "groupTitle": "Dispositions"
8801 "url": "/api/dispositions/{id}",
8802 "title": "Deletes a Disposition",
8805 "title": "Example usage:",
8806 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8810 "name": "DeleteDispositions",
8811 "group": "Dispositions",
8812 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8814 "filename": "server/api/disposition/index.js",
8815 "groupTitle": "Dispositions"
8819 "url": "/api/dispositions",
8820 "title": "Gets a list of Dispositions",
8823 "title": "Example usage:",
8824 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8828 "name": "GetDispositions",
8829 "group": "Dispositions",
8830 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8832 "filename": "server/api/disposition/index.js",
8833 "groupTitle": "Dispositions"
8837 "url": "/api/dispositions/{id}",
8838 "title": "Gets a single Disposition",
8841 "title": "Example usage:",
8842 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8846 "name": "ShowDispositions",
8847 "group": "Dispositions",
8848 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8850 "filename": "server/api/disposition/index.js",
8851 "groupTitle": "Dispositions"
8855 "url": "/api/dispositions/{id}",
8856 "title": "Update an existing Disposition",
8859 "title": "Example usage:",
8860 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8864 "name": "updateDispositions",
8865 "group": "Dispositions",
8866 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8868 "filename": "server/api/disposition/index.js",
8869 "groupTitle": "Dispositions"
8873 "url": "/api/integrations/dynamics365/accounts",
8874 "title": "Creates a new Dynamics365 Account",
8877 "title": "Example usage:",
8878 "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",
8882 "name": "CreateDynamics365_Accounts",
8883 "group": "Dynamics365_Accounts",
8898 "field": "username",
8905 "field": "password",
8912 "field": "remoteUri",
8919 "field": "tenantId",
8926 "field": "clientId",
8933 "field": "clientSecret",
8940 "field": "serverUrl",
8947 "field": "description",
8953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8955 "filename": "server/api/intDynamics365Account/index.js",
8956 "groupTitle": "Dynamics365_Accounts"
8960 "url": "/api/integrations/dynamics365/accounts/{id}",
8961 "title": "Deletes a Dynamics365 Account",
8964 "title": "Example usage:",
8965 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8969 "name": "DeleteDynamics365_Accounts",
8970 "group": "Dynamics365_Accounts",
8971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8973 "filename": "server/api/intDynamics365Account/index.js",
8974 "groupTitle": "Dynamics365_Accounts"
8978 "url": "/api/integrations/dynamics365/accounts",
8979 "title": "Gets a list of Dynamics365 Accounts",
8982 "title": "Example usage:",
8983 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8987 "name": "GetDynamics365_Accounts",
8988 "group": "Dynamics365_Accounts",
8989 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8991 "filename": "server/api/intDynamics365Account/index.js",
8992 "groupTitle": "Dynamics365_Accounts"
8996 "url": "/api/integrations/dynamics365/accounts/{id}",
8997 "title": "Gets a single Dynamics365 Account",
9000 "title": "Example usage:",
9001 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9005 "name": "ShowDynamics365_Accounts",
9006 "group": "Dynamics365_Accounts",
9007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9009 "filename": "server/api/intDynamics365Account/index.js",
9010 "groupTitle": "Dynamics365_Accounts"
9014 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9015 "title": "Creates new configuration",
9018 "title": "Example usage:",
9019 "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",
9023 "name": "addConfiguration",
9024 "group": "Dynamics365_Accounts",
9025 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9027 "filename": "server/api/intDynamics365Account/index.js",
9028 "groupTitle": "Dynamics365_Accounts"
9032 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9033 "title": "Gets account configurations",
9036 "title": "Example usage:",
9037 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9041 "name": "getConfigurations",
9042 "group": "Dynamics365_Accounts",
9043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9045 "filename": "server/api/intDynamics365Account/index.js",
9046 "groupTitle": "Dynamics365_Accounts"
9050 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9051 "title": "Gets account fields",
9054 "title": "Example usage:",
9055 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9059 "name": "getFields",
9060 "group": "Dynamics365_Accounts",
9061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9063 "filename": "server/api/intDynamics365Account/index.js",
9064 "groupTitle": "Dynamics365_Accounts"
9068 "url": "/api/integrations/dynamics365/accounts/{id}",
9069 "title": "Update an existing Dynamics365 Account",
9072 "title": "Example usage:",
9073 "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",
9077 "name": "updateDynamics365_Accounts",
9078 "group": "Dynamics365_Accounts",
9079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9081 "filename": "server/api/intDynamics365Account/index.js",
9082 "groupTitle": "Dynamics365_Accounts"
9086 "url": "/api/integrations/dynamics365/configurations",
9087 "title": "Creates a new Dynamics365 Configuration",
9090 "title": "Example usage:",
9091 "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",
9095 "name": "CreateDynamics365_Configurations",
9096 "group": "Dynamics365_Configurations",
9111 "field": "description",
9122 "field": "ticketType",
9128 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9130 "filename": "server/api/intDynamics365Configuration/index.js",
9131 "groupTitle": "Dynamics365_Configurations"
9135 "url": "/api/integrations/dynamics365/configurations/{id}",
9136 "title": "Deletes a Dynamics365 Configuration",
9139 "title": "Example usage:",
9140 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9144 "name": "DeleteDynamics365_Configurations",
9145 "group": "Dynamics365_Configurations",
9146 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9148 "filename": "server/api/intDynamics365Configuration/index.js",
9149 "groupTitle": "Dynamics365_Configurations"
9153 "url": "/api/integrations/dynamics365/configurations",
9154 "title": "Gets a list of Dynamics365 Configurations",
9157 "title": "Example usage:",
9158 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9162 "name": "GetDynamics365_Configurations",
9163 "group": "Dynamics365_Configurations",
9164 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9166 "filename": "server/api/intDynamics365Configuration/index.js",
9167 "groupTitle": "Dynamics365_Configurations"
9171 "url": "/api/integrations/dynamics365/configurations/{id}",
9172 "title": "Gets a single Dynamics365 Configuration",
9175 "title": "Example usage:",
9176 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9180 "name": "ShowDynamics365_Configurations",
9181 "group": "Dynamics365_Configurations",
9182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9184 "filename": "server/api/intDynamics365Configuration/index.js",
9185 "groupTitle": "Dynamics365_Configurations"
9189 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9190 "title": "Gets configurations descriptions",
9193 "title": "Example usage:",
9194 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9198 "name": "getDescriptions",
9199 "group": "Dynamics365_Configurations",
9200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9202 "filename": "server/api/intDynamics365Configuration/index.js",
9203 "groupTitle": "Dynamics365_Configurations"
9207 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9208 "title": "Gets configurations fields",
9211 "title": "Example usage:",
9212 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9216 "name": "getFields",
9217 "group": "Dynamics365_Configurations",
9218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9220 "filename": "server/api/intDynamics365Configuration/index.js",
9221 "groupTitle": "Dynamics365_Configurations"
9225 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9226 "title": "Gets configurations subjects",
9229 "title": "Example usage:",
9230 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9234 "name": "getSubjects",
9235 "group": "Dynamics365_Configurations",
9236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9238 "filename": "server/api/intDynamics365Configuration/index.js",
9239 "groupTitle": "Dynamics365_Configurations"
9243 "url": "/api/integrations/dynamics365/configurations/{id}",
9244 "title": "Update an existing Dynamics365 Configuration",
9247 "title": "Example usage:",
9248 "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",
9252 "name": "updateDynamics365_Configurations",
9253 "group": "Dynamics365_Configurations",
9254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9256 "filename": "server/api/intDynamics365Configuration/index.js",
9257 "groupTitle": "Dynamics365_Configurations"
9261 "url": "/api/integrations/dynamics365/fields",
9262 "title": "Creates a new Dynamics365 Field",
9265 "title": "Example usage:",
9266 "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",
9270 "name": "CreateDynamics365_Fields",
9271 "group": "Dynamics365_Fields",
9281 "\"customVariable\"",
9309 "\"customVariable\""
9319 "field": "keyContent",
9333 "field": "nameField",
9340 "field": "customField",
9347 "field": "variableName",
9353 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9355 "filename": "server/api/intDynamics365Field/index.js",
9356 "groupTitle": "Dynamics365_Fields"
9360 "url": "/api/integrations/dynamics365/fields/{id}",
9361 "title": "Deletes a Dynamics365 Field",
9364 "title": "Example usage:",
9365 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9369 "name": "DeleteDynamics365_Fields",
9370 "group": "Dynamics365_Fields",
9371 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9373 "filename": "server/api/intDynamics365Field/index.js",
9374 "groupTitle": "Dynamics365_Fields"
9378 "url": "/api/integrations/dynamics365/fields",
9379 "title": "Gets a list of Dynamics365 Fields",
9382 "title": "Example usage:",
9383 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9387 "name": "GetDynamics365_Fields",
9388 "group": "Dynamics365_Fields",
9389 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9391 "filename": "server/api/intDynamics365Field/index.js",
9392 "groupTitle": "Dynamics365_Fields"
9396 "url": "/api/integrations/dynamics365/fields/{id}",
9397 "title": "Gets a single Dynamics365 Field",
9400 "title": "Example usage:",
9401 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9405 "name": "ShowDynamics365_Fields",
9406 "group": "Dynamics365_Fields",
9407 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9409 "filename": "server/api/intDynamics365Field/index.js",
9410 "groupTitle": "Dynamics365_Fields"
9414 "url": "/api/integrations/dynamics365/fields/{id}",
9415 "title": "Update an existing Dynamics365 Field",
9418 "title": "Example usage:",
9419 "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",
9423 "name": "updateDynamics365_Fields",
9424 "group": "Dynamics365_Fields",
9425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9427 "filename": "server/api/intDynamics365Field/index.js",
9428 "groupTitle": "Dynamics365_Fields"
9432 "url": "/api/fax/accounts/{id}/users",
9433 "title": "Add agents to a fax account",
9436 "title": "Example usage:",
9437 "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",
9441 "name": "AddAgents",
9442 "group": "Fax_Accounts",
9443 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9445 "filename": "server/api/faxAccount/index.js",
9446 "groupTitle": "Fax_Accounts"
9450 "url": "/api/fax/accounts",
9451 "title": "Creates a new Account",
9454 "title": "Example usage:",
9455 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9459 "name": "CreateAccounts",
9460 "group": "Fax_Accounts",
9475 "field": "description",
9493 "field": "headerinfo",
9500 "field": "localstationid",
9551 "field": "faxdetect",
9558 "field": "t38timeout",
9585 "field": "notificationTemplate",
9592 "field": "notificationSound",
9599 "field": "notificationShake",
9606 "field": "waitForTheAssignedAgent",
9613 "field": "queueTransfer",
9620 "field": "queueTransferTimeout",
9627 "field": "agentTransfer",
9634 "field": "agentTransferTimeout",
9641 "field": "mandatoryDispositionPauseId",
9642 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9648 "field": "mandatoryDisposition",
9649 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9654 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9656 "filename": "server/api/faxAccount/index.js",
9657 "groupTitle": "Fax_Accounts"
9661 "url": "/api/fax/accounts/{id}",
9662 "title": "Deletes a Account",
9665 "title": "Example usage:",
9666 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9670 "name": "DeleteAccounts",
9671 "group": "Fax_Accounts",
9672 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9674 "filename": "server/api/faxAccount/index.js",
9675 "groupTitle": "Fax_Accounts"
9679 "url": "/api/fax/accounts/describe",
9680 "title": "Gets table info about Accounts",
9683 "title": "Example usage:",
9684 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9688 "name": "DescribeAccounts",
9689 "group": "Fax_Accounts",
9690 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9692 "filename": "server/api/faxAccount/index.js",
9693 "groupTitle": "Fax_Accounts"
9697 "url": "/api/fax/accounts",
9698 "title": "Gets a list of Accounts",
9701 "title": "Example usage:",
9702 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9706 "name": "GetAccounts",
9707 "group": "Fax_Accounts",
9708 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9710 "filename": "server/api/faxAccount/index.js",
9711 "groupTitle": "Fax_Accounts"
9715 "url": "/api/fax/accounts/{id}/users",
9716 "title": "Gets agents from fax account",
9719 "title": "Example usage:",
9720 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9724 "name": "GetAgents",
9725 "group": "Fax_Accounts",
9726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9728 "filename": "server/api/faxAccount/index.js",
9729 "groupTitle": "Fax_Accounts"
9733 "url": "/api/fax/accounts/{id}/users",
9734 "title": "Removes agents from a fax account",
9737 "title": "Example usage:",
9738 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9742 "name": "RemoveAgents",
9743 "group": "Fax_Accounts",
9744 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9746 "filename": "server/api/faxAccount/index.js",
9747 "groupTitle": "Fax_Accounts"
9751 "url": "/api/fax/accounts/{id}/canned_answers",
9752 "title": "Removes canned answers from account",
9755 "title": "Example usage:",
9756 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9760 "name": "RemoveAnswers",
9761 "group": "Fax_Accounts",
9762 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9764 "filename": "server/api/faxAccount/index.js",
9765 "groupTitle": "Fax_Accounts"
9769 "url": "/api/fax/accounts/{id}/dispositions",
9770 "title": "Removes dispositions from account",
9773 "title": "Example usage:",
9774 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9778 "name": "RemoveDispositions",
9779 "group": "Fax_Accounts",
9780 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9782 "filename": "server/api/faxAccount/index.js",
9783 "groupTitle": "Fax_Accounts"
9787 "url": "/api/fax/accounts/{id}",
9788 "title": "Gets a single Account",
9791 "title": "Example usage:",
9792 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9796 "name": "ShowAccounts",
9797 "group": "Fax_Accounts",
9798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9800 "filename": "server/api/faxAccount/index.js",
9801 "groupTitle": "Fax_Accounts"
9805 "url": "/api/fax/accounts/{id}/canned_answers",
9806 "title": "Creates new canned answer",
9809 "title": "Example usage:",
9810 "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",
9814 "name": "addAnswer",
9815 "group": "Fax_Accounts",
9837 "field": "description",
9850 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9852 "filename": "server/api/faxAccount/index.js",
9853 "groupTitle": "Fax_Accounts"
9857 "url": "/api/fax/accounts/{id}/applications",
9858 "title": "Creates new applications",
9861 "title": "Example usage:",
9862 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9866 "name": "addApplications",
9867 "group": "Fax_Accounts",
9875 "field": "priority",
9896 "field": "description",
9903 "field": "interval",
9909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9911 "filename": "server/api/faxAccount/index.js",
9912 "groupTitle": "Fax_Accounts"
9916 "url": "/api/fax/accounts/addaccountapplications",
9917 "title": "Creates new account and applications",
9920 "title": "Example usage:",
9921 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9925 "name": "addApplications",
9926 "group": "Fax_Accounts",
9934 "field": "priority",
9955 "field": "description",
9962 "field": "interval",
9968 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9970 "filename": "server/api/faxAccount/index.js",
9971 "groupTitle": "Fax_Accounts"
9975 "url": "/api/fax/accounts/{id}/dispositions",
9976 "title": "Creates new disposition",
9979 "title": "Example usage:",
9980 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9984 "name": "addDisposition",
9985 "group": "Fax_Accounts",
10012 "field": "description",
10018 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10019 "version": "0.0.0",
10020 "filename": "server/api/faxAccount/index.js",
10021 "groupTitle": "Fax_Accounts"
10025 "url": "/api/fax/accounts/{id}/interactions",
10026 "title": "Creates new interactions",
10029 "title": "Example usage:",
10030 "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",
10034 "name": "addInteraction",
10035 "group": "Fax_Accounts",
10050 "field": "closedAt",
10057 "field": "disposition",
10064 "field": "secondDisposition",
10071 "field": "thirdDisposition",
10085 "field": "read1stAt",
10103 "field": "firstMsgDirection",
10110 "field": "lastMsgAt",
10121 "field": "lastMsgDirection",
10127 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10128 "version": "0.0.0",
10129 "filename": "server/api/faxAccount/index.js",
10130 "groupTitle": "Fax_Accounts"
10134 "url": "/api/fax/accounts/{id}/canned_answers",
10135 "title": "Gets account canned answers",
10138 "title": "Example usage:",
10139 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10143 "name": "getAnswers",
10144 "group": "Fax_Accounts",
10145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10146 "version": "0.0.0",
10147 "filename": "server/api/faxAccount/index.js",
10148 "groupTitle": "Fax_Accounts"
10152 "url": "/api/fax/accounts/{id}/applications",
10153 "title": "Gets account pplications",
10156 "title": "Example usage:",
10157 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10161 "name": "getApplications",
10162 "group": "Fax_Accounts",
10163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10164 "version": "0.0.0",
10165 "filename": "server/api/faxAccount/index.js",
10166 "groupTitle": "Fax_Accounts"
10170 "url": "/api/fax/accounts/{id}/dispositions",
10171 "title": "Gets account dispositions",
10174 "title": "Example usage:",
10175 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10179 "name": "getDispositions",
10180 "group": "Fax_Accounts",
10181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10182 "version": "0.0.0",
10183 "filename": "server/api/faxAccount/index.js",
10184 "groupTitle": "Fax_Accounts"
10188 "url": "/api/fax/accounts/{id}/interactions",
10189 "title": "Gets account interactions",
10192 "title": "Example usage:",
10193 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10197 "name": "getInteraction",
10198 "group": "Fax_Accounts",
10199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10200 "version": "0.0.0",
10201 "filename": "server/api/faxAccount/index.js",
10202 "groupTitle": "Fax_Accounts"
10206 "url": "/api/fax/accounts/{id}/messages",
10207 "title": "Gets account messages",
10210 "title": "Example usage:",
10211 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10215 "name": "getMessages",
10216 "group": "Fax_Accounts",
10217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10218 "version": "0.0.0",
10219 "filename": "server/api/faxAccount/index.js",
10220 "groupTitle": "Fax_Accounts"
10224 "url": "/api/fax/accounts/{id}/send",
10225 "title": "Send new fax",
10228 "title": "Example usage:",
10229 "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",
10234 "group": "Fax_Accounts",
10235 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10236 "version": "0.0.0",
10237 "filename": "server/api/faxAccount/index.js",
10238 "groupTitle": "Fax_Accounts"
10242 "url": "/api/fax/accounts/{id}",
10243 "title": "Update an existing Account",
10246 "title": "Example usage:",
10247 "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",
10251 "name": "updateAccounts",
10252 "group": "Fax_Accounts",
10253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10254 "version": "0.0.0",
10255 "filename": "server/api/faxAccount/index.js",
10256 "groupTitle": "Fax_Accounts"
10260 "url": "/api/fax/accounts/updateaccountapplications",
10261 "title": "Update account and applications",
10264 "title": "Example usage:",
10265 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10269 "name": "updateApplications",
10270 "group": "Fax_Accounts",
10278 "field": "priority",
10292 "field": "appdata",
10299 "field": "description",
10306 "field": "interval",
10312 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10313 "version": "0.0.0",
10314 "filename": "server/api/faxAccount/index.js",
10315 "groupTitle": "Fax_Accounts"
10319 "url": "/api/fax/applications",
10320 "title": "Creates a new Application",
10323 "title": "Example usage:",
10324 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10328 "name": "CreateApplications",
10329 "group": "Fax_Applications",
10337 "field": "priority",
10351 "field": "appdata",
10358 "field": "description",
10365 "field": "interval",
10371 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10372 "version": "0.0.0",
10373 "filename": "server/api/faxApplication/index.js",
10374 "groupTitle": "Fax_Applications"
10378 "url": "/api/fax/applications/{id}",
10379 "title": "Deletes a Application",
10382 "title": "Example usage:",
10383 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10387 "name": "DeleteApplications",
10388 "group": "Fax_Applications",
10389 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10390 "version": "0.0.0",
10391 "filename": "server/api/faxApplication/index.js",
10392 "groupTitle": "Fax_Applications"
10396 "url": "/api/fax/applications",
10397 "title": "Gets a list of Applications",
10400 "title": "Example usage:",
10401 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10405 "name": "GetApplications",
10406 "group": "Fax_Applications",
10407 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10408 "version": "0.0.0",
10409 "filename": "server/api/faxApplication/index.js",
10410 "groupTitle": "Fax_Applications"
10414 "url": "/api/fax/applications/{id}",
10415 "title": "Gets a single Application",
10418 "title": "Example usage:",
10419 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10423 "name": "ShowApplications",
10424 "group": "Fax_Applications",
10425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10426 "version": "0.0.0",
10427 "filename": "server/api/faxApplication/index.js",
10428 "groupTitle": "Fax_Applications"
10432 "url": "/api/fax/applications/{id}",
10433 "title": "Update an existing Application",
10436 "title": "Example usage:",
10437 "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",
10441 "name": "updateApplications",
10442 "group": "Fax_Applications",
10443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10444 "version": "0.0.0",
10445 "filename": "server/api/faxApplication/index.js",
10446 "groupTitle": "Fax_Applications"
10450 "url": "/api/fax/interactions/{id}/tags",
10451 "title": "Add tags to the interaction",
10454 "title": "Example usage:",
10455 "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",
10460 "group": "Fax_Interactions",
10461 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10462 "version": "0.0.0",
10463 "filename": "server/api/faxInteraction/index.js",
10464 "groupTitle": "Fax_Interactions"
10468 "url": "/api/fax/interactions",
10469 "title": "Creates a new Interaction",
10472 "title": "Example usage:",
10473 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10477 "name": "CreateInteractions",
10478 "group": "Fax_Interactions",
10493 "field": "closedAt",
10500 "field": "disposition",
10507 "field": "secondDisposition",
10514 "field": "thirdDisposition",
10528 "field": "read1stAt",
10546 "field": "firstMsgDirection",
10553 "field": "lastMsgAt",
10564 "field": "lastMsgDirection",
10570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10571 "version": "0.0.0",
10572 "filename": "server/api/faxInteraction/index.js",
10573 "groupTitle": "Fax_Interactions"
10577 "url": "/api/fax/interactions/{id}",
10578 "title": "Deletes a Interaction",
10581 "title": "Example usage:",
10582 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10586 "name": "DeleteInteractions",
10587 "group": "Fax_Interactions",
10588 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10589 "version": "0.0.0",
10590 "filename": "server/api/faxInteraction/index.js",
10591 "groupTitle": "Fax_Interactions"
10595 "url": "/api/fax/interactions/describe",
10596 "title": "Gets table info about Interactions",
10599 "title": "Example usage:",
10600 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10604 "name": "DescribeInteractions",
10605 "group": "Fax_Interactions",
10606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10607 "version": "0.0.0",
10608 "filename": "server/api/faxInteraction/index.js",
10609 "groupTitle": "Fax_Interactions"
10613 "url": "/api/fax/interactions",
10614 "title": "Gets a list of Interactions",
10617 "title": "Example usage:",
10618 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10622 "name": "GetInteractions",
10623 "group": "Fax_Interactions",
10624 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10625 "version": "0.0.0",
10626 "filename": "server/api/faxInteraction/index.js",
10627 "groupTitle": "Fax_Interactions"
10631 "url": "/api/fax/interactions/{id}/tags",
10632 "title": "Removes tags from interaction",
10635 "title": "Example usage:",
10636 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10640 "name": "RemoveTags",
10641 "group": "Fax_Interactions",
10642 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10643 "version": "0.0.0",
10644 "filename": "server/api/faxInteraction/index.js",
10645 "groupTitle": "Fax_Interactions"
10649 "url": "/api/fax/interactions/{id}",
10650 "title": "Gets a single Interaction",
10653 "title": "Example usage:",
10654 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10658 "name": "ShowInteractions",
10659 "group": "Fax_Interactions",
10660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10661 "version": "0.0.0",
10662 "filename": "server/api/faxInteraction/index.js",
10663 "groupTitle": "Fax_Interactions"
10667 "url": "/api/fax/interactions/{id}/messages",
10668 "title": "Creates new messages",
10671 "title": "Example usage:",
10672 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10676 "name": "addMessage",
10677 "group": "Fax_Interactions",
10703 "field": "direction",
10710 "field": "failMessage",
10723 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10724 "version": "0.0.0",
10725 "filename": "server/api/faxInteraction/index.js",
10726 "groupTitle": "Fax_Interactions"
10730 "url": "/api/fax/interactions/{id}/download",
10731 "title": "Get interactions",
10734 "title": "Example usage:",
10735 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10739 "name": "download",
10740 "group": "Fax_Interactions",
10741 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10742 "version": "0.0.0",
10743 "filename": "server/api/faxInteraction/index.js",
10744 "groupTitle": "Fax_Interactions"
10748 "url": "/api/fax/interactions/{id}/messages",
10749 "title": "Gets interaction messages",
10752 "title": "Example usage:",
10753 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10757 "name": "getMessages",
10758 "group": "Fax_Interactions",
10759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10760 "version": "0.0.0",
10761 "filename": "server/api/faxInteraction/index.js",
10762 "groupTitle": "Fax_Interactions"
10766 "url": "/api/fax/interactions/{id}",
10767 "title": "Update an existing Interaction",
10770 "title": "Example usage:",
10771 "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",
10775 "name": "updateInteractions",
10776 "group": "Fax_Interactions",
10777 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10778 "version": "0.0.0",
10779 "filename": "server/api/faxInteraction/index.js",
10780 "groupTitle": "Fax_Interactions"
10784 "url": "/api/fax/messages/{id}/download",
10785 "title": "Get message",
10788 "title": "Example usage:",
10789 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10793 "name": "download",
10794 "group": "Fax_Message",
10795 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10796 "version": "0.0.0",
10797 "filename": "server/api/faxMessage/index.js",
10798 "groupTitle": "Fax_Message"
10802 "url": "/api/fax/messages/{id}",
10803 "title": "Deletes a Message",
10806 "title": "Example usage:",
10807 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10811 "name": "DeleteMessages",
10812 "group": "Fax_Messages",
10813 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10814 "version": "0.0.0",
10815 "filename": "server/api/faxMessage/index.js",
10816 "groupTitle": "Fax_Messages"
10820 "url": "/api/fax/messages/describe",
10821 "title": "Gets table info about Messages",
10824 "title": "Example usage:",
10825 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10829 "name": "DescribeMessages",
10830 "group": "Fax_Messages",
10831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10832 "version": "0.0.0",
10833 "filename": "server/api/faxMessage/index.js",
10834 "groupTitle": "Fax_Messages"
10838 "url": "/api/fax/messages",
10839 "title": "Gets a list of Messages",
10842 "title": "Example usage:",
10843 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10847 "name": "GetMessages",
10848 "group": "Fax_Messages",
10849 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10850 "version": "0.0.0",
10851 "filename": "server/api/faxMessage/index.js",
10852 "groupTitle": "Fax_Messages"
10856 "url": "/api/fax/messages/{id}",
10857 "title": "Gets a single Message",
10860 "title": "Example usage:",
10861 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10865 "name": "ShowMessages",
10866 "group": "Fax_Messages",
10867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10868 "version": "0.0.0",
10869 "filename": "server/api/faxMessage/index.js",
10870 "groupTitle": "Fax_Messages"
10874 "url": "/api/fax/messages/{id}/accept",
10875 "title": "Accepts message",
10878 "title": "Example usage:",
10879 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10883 "name": "acceptMessage",
10884 "group": "Fax_Messages",
10885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10886 "version": "0.0.0",
10887 "filename": "server/api/faxMessage/index.js",
10888 "groupTitle": "Fax_Messages"
10892 "url": "/api/fax/messages",
10893 "title": "Create message and send Fax",
10896 "title": "Example usage:",
10897 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10901 "name": "rejectMessage",
10902 "group": "Fax_Messages",
10903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10904 "version": "0.0.0",
10905 "filename": "server/api/faxMessage/index.js",
10906 "groupTitle": "Fax_Messages"
10910 "url": "/api/fax/messages/{id}/reject",
10911 "title": "Rejects message",
10914 "title": "Example usage:",
10915 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10919 "name": "rejectMessage",
10920 "group": "Fax_Messages",
10921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10922 "version": "0.0.0",
10923 "filename": "server/api/faxMessage/index.js",
10924 "groupTitle": "Fax_Messages"
10928 "url": "/api/fax/messages/{id}",
10929 "title": "Update an existing Message",
10932 "title": "Example usage:",
10933 "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",
10937 "name": "updateMessages",
10938 "group": "Fax_Messages",
10939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10940 "version": "0.0.0",
10941 "filename": "server/api/faxMessage/index.js",
10942 "groupTitle": "Fax_Messages"
10946 "url": "/api/fax/reports/queue",
10947 "title": "Creates a new Fax Queue Report",
10950 "title": "Example usage:",
10951 "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",
10955 "name": "CreateFax_Queue_Reports",
10956 "group": "Fax_Queue_Reports",
10964 "field": "uniqueid",
10985 "field": "leaveAt",
10992 "field": "acceptAt",
11012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11013 "version": "0.0.0",
11014 "filename": "server/api/faxQueueReport/index.js",
11015 "groupTitle": "Fax_Queue_Reports"
11019 "url": "/api/fax/reports/queue/{id}",
11020 "title": "Deletes a Fax Queue Report",
11023 "title": "Example usage:",
11024 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11028 "name": "DeleteFax_Queue_Reports",
11029 "group": "Fax_Queue_Reports",
11030 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11031 "version": "0.0.0",
11032 "filename": "server/api/faxQueueReport/index.js",
11033 "groupTitle": "Fax_Queue_Reports"
11037 "url": "/api/fax/reports/queue/describe",
11038 "title": "Gets table info about Fax Queue Reports",
11041 "title": "Example usage:",
11042 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11046 "name": "DescribeFax_Queue_Reports",
11047 "group": "Fax_Queue_Reports",
11048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11049 "version": "0.0.0",
11050 "filename": "server/api/faxQueueReport/index.js",
11051 "groupTitle": "Fax_Queue_Reports"
11055 "url": "/api/fax/reports/queue",
11056 "title": "Gets a list of Fax Queue Reports",
11059 "title": "Example usage:",
11060 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11064 "name": "GetFax_Queue_Reports",
11065 "group": "Fax_Queue_Reports",
11066 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11067 "version": "0.0.0",
11068 "filename": "server/api/faxQueueReport/index.js",
11069 "groupTitle": "Fax_Queue_Reports"
11073 "url": "/api/fax/reports/queue/{id}",
11074 "title": "Gets a single Fax Queue Report",
11077 "title": "Example usage:",
11078 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11082 "name": "ShowFax_Queue_Reports",
11083 "group": "Fax_Queue_Reports",
11084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11085 "version": "0.0.0",
11086 "filename": "server/api/faxQueueReport/index.js",
11087 "groupTitle": "Fax_Queue_Reports"
11091 "url": "/api/fax/reports/queue/{id}",
11092 "title": "Update an existing Fax Queue Report",
11095 "title": "Example usage:",
11096 "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",
11100 "name": "updateFax_Queue_Reports",
11101 "group": "Fax_Queue_Reports",
11102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11103 "version": "0.0.0",
11104 "filename": "server/api/faxQueueReport/index.js",
11105 "groupTitle": "Fax_Queue_Reports"
11109 "url": "/api/fax/queues/{id}/users",
11110 "title": "Add agents to a queue",
11113 "title": "Example usage:",
11114 "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",
11118 "name": "AddAgents",
11119 "group": "Fax_Queues",
11120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11121 "version": "0.0.0",
11122 "filename": "server/api/faxQueue/index.js",
11123 "groupTitle": "Fax_Queues"
11127 "url": "/api/fax/queues/{id}/teams",
11128 "title": "Add teams to a queue",
11131 "title": "Example usage:",
11132 "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",
11136 "name": "AddTeams",
11137 "group": "Fax_Queues",
11138 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11139 "version": "0.0.0",
11140 "filename": "server/api/faxQueue/index.js",
11141 "groupTitle": "Fax_Queues"
11145 "url": "/api/fax/queues",
11146 "title": "Creates a new Queue",
11149 "title": "Example usage:",
11150 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11154 "name": "CreateQueues",
11155 "group": "Fax_Queues",
11170 "field": "description",
11177 "field": "timeout",
11189 "field": "strategy",
11196 "field": "lastAgent",
11202 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11203 "version": "0.0.0",
11204 "filename": "server/api/faxQueue/index.js",
11205 "groupTitle": "Fax_Queues"
11209 "url": "/api/fax/queues/{id}",
11210 "title": "Deletes a Queue",
11213 "title": "Example usage:",
11214 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11218 "name": "DeleteQueues",
11219 "group": "Fax_Queues",
11220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11221 "version": "0.0.0",
11222 "filename": "server/api/faxQueue/index.js",
11223 "groupTitle": "Fax_Queues"
11227 "url": "/api/fax/queues/describe",
11228 "title": "Gets table info about Queues",
11231 "title": "Example usage:",
11232 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11236 "name": "DescribeQueues",
11237 "group": "Fax_Queues",
11238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11239 "version": "0.0.0",
11240 "filename": "server/api/faxQueue/index.js",
11241 "groupTitle": "Fax_Queues"
11245 "url": "/api/fax/queues/{id}/users",
11246 "title": "Gets queue agents",
11249 "title": "Example usage:",
11250 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11254 "name": "GetAgents",
11255 "group": "Fax_Queues",
11256 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11257 "version": "0.0.0",
11258 "filename": "server/api/faxQueue/index.js",
11259 "groupTitle": "Fax_Queues"
11263 "url": "/api/fax/queues/{id}/members",
11264 "title": "GetMembers",
11267 "title": "Example usage:",
11268 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11272 "name": "GetMembers",
11273 "group": "Fax_Queues",
11274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11275 "version": "0.0.0",
11276 "filename": "server/api/faxQueue/index.js",
11277 "groupTitle": "Fax_Queues"
11281 "url": "/api/fax/queues",
11282 "title": "Gets a list of Queues",
11285 "title": "Example usage:",
11286 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11290 "name": "GetQueues",
11291 "group": "Fax_Queues",
11292 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11293 "version": "0.0.0",
11294 "filename": "server/api/faxQueue/index.js",
11295 "groupTitle": "Fax_Queues"
11299 "url": "/api/fax/queues/{id}/teams",
11300 "title": "Gets queues list",
11303 "title": "Example usage:",
11304 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11308 "name": "GetTeams",
11309 "group": "Fax_Queues",
11310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11311 "version": "0.0.0",
11312 "filename": "server/api/faxQueue/index.js",
11313 "groupTitle": "Fax_Queues"
11317 "url": "/api/fax/queues/{id}/users",
11318 "title": "Removes agents from a queue",
11321 "title": "Example usage:",
11322 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11326 "name": "RemoveAgents",
11327 "group": "Fax_Queues",
11328 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11329 "version": "0.0.0",
11330 "filename": "server/api/faxQueue/index.js",
11331 "groupTitle": "Fax_Queues"
11335 "url": "/api/fax/queues/{id}",
11336 "title": "Gets a single Queue",
11339 "title": "Example usage:",
11340 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11344 "name": "ShowQueues",
11345 "group": "Fax_Queues",
11346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11347 "version": "0.0.0",
11348 "filename": "server/api/faxQueue/index.js",
11349 "groupTitle": "Fax_Queues"
11353 "url": "/api/fax/queues/{id}",
11354 "title": "Update an existing Queue",
11357 "title": "Example usage:",
11358 "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",
11362 "name": "updateQueues",
11363 "group": "Fax_Queues",
11364 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11365 "version": "0.0.0",
11366 "filename": "server/api/faxQueue/index.js",
11367 "groupTitle": "Fax_Queues"
11371 "url": "/api/fax/reports/transfer",
11372 "title": "Creates a new Fax Transfer Report",
11375 "title": "Example usage:",
11376 "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",
11380 "name": "CreateFax_Transfer_Reports",
11381 "group": "Fax_Transfer_Reports",
11389 "field": "uniqueid",
11408 "field": "transferredAt",
11414 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11415 "version": "0.0.0",
11416 "filename": "server/api/faxTransferReport/index.js",
11417 "groupTitle": "Fax_Transfer_Reports"
11421 "url": "/api/fax/reports/transfer/{id}",
11422 "title": "Deletes a Fax Transfer Report",
11425 "title": "Example usage:",
11426 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11430 "name": "DeleteFax_Transfer_Reports",
11431 "group": "Fax_Transfer_Reports",
11432 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11433 "version": "0.0.0",
11434 "filename": "server/api/faxTransferReport/index.js",
11435 "groupTitle": "Fax_Transfer_Reports"
11439 "url": "/api/fax/reports/transfer/describe",
11440 "title": "Gets table info about Fax Transfer Reports",
11443 "title": "Example usage:",
11444 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11448 "name": "DescribeFax_Transfer_Reports",
11449 "group": "Fax_Transfer_Reports",
11450 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11451 "version": "0.0.0",
11452 "filename": "server/api/faxTransferReport/index.js",
11453 "groupTitle": "Fax_Transfer_Reports"
11457 "url": "/api/fax/reports/transfer",
11458 "title": "Gets a list of Fax Transfer Reports",
11461 "title": "Example usage:",
11462 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11466 "name": "GetFax_Transfer_Reports",
11467 "group": "Fax_Transfer_Reports",
11468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11469 "version": "0.0.0",
11470 "filename": "server/api/faxTransferReport/index.js",
11471 "groupTitle": "Fax_Transfer_Reports"
11475 "url": "/api/fax/reports/transfer/{id}",
11476 "title": "Gets a single Fax Transfer Report",
11479 "title": "Example usage:",
11480 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11484 "name": "ShowFax_Transfer_Reports",
11485 "group": "Fax_Transfer_Reports",
11486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11487 "version": "0.0.0",
11488 "filename": "server/api/faxTransferReport/index.js",
11489 "groupTitle": "Fax_Transfer_Reports"
11493 "url": "/api/fax/reports/transfer/{id}",
11494 "title": "Update an existing Fax Transfer Report",
11497 "title": "Example usage:",
11498 "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",
11502 "name": "updateFax_Transfer_Reports",
11503 "group": "Fax_Transfer_Reports",
11504 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11505 "version": "0.0.0",
11506 "filename": "server/api/faxTransferReport/index.js",
11507 "groupTitle": "Fax_Transfer_Reports"
11511 "url": "/api/integrations/freshdesk/accounts",
11512 "title": "Creates a new Freshdesk Account",
11515 "title": "Example usage:",
11516 "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",
11520 "name": "CreateFreshdesk_Accounts",
11521 "group": "Freshdesk_Accounts",
11536 "field": "description",
11543 "field": "username",
11557 "field": "remoteUri",
11564 "field": "serverUrl",
11570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11571 "version": "0.0.0",
11572 "filename": "server/api/intFreshdeskAccount/index.js",
11573 "groupTitle": "Freshdesk_Accounts"
11577 "url": "/api/integrations/freshdesk/accounts/{id}",
11578 "title": "Deletes a Freshdesk Account",
11581 "title": "Example usage:",
11582 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11586 "name": "DeleteFreshdesk_Accounts",
11587 "group": "Freshdesk_Accounts",
11588 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11589 "version": "0.0.0",
11590 "filename": "server/api/intFreshdeskAccount/index.js",
11591 "groupTitle": "Freshdesk_Accounts"
11595 "url": "/api/integrations/freshdesk/accounts",
11596 "title": "Gets a list of Freshdesk Accounts",
11599 "title": "Example usage:",
11600 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11604 "name": "GetFreshdesk_Accounts",
11605 "group": "Freshdesk_Accounts",
11606 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11607 "version": "0.0.0",
11608 "filename": "server/api/intFreshdeskAccount/index.js",
11609 "groupTitle": "Freshdesk_Accounts"
11613 "url": "/api/integrations/freshdesk/accounts/{id}",
11614 "title": "Gets a single Freshdesk Account",
11617 "title": "Example usage:",
11618 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11622 "name": "ShowFreshdesk_Accounts",
11623 "group": "Freshdesk_Accounts",
11624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11625 "version": "0.0.0",
11626 "filename": "server/api/intFreshdeskAccount/index.js",
11627 "groupTitle": "Freshdesk_Accounts"
11631 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11632 "title": "Creates new configuration",
11635 "title": "Example usage:",
11636 "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",
11640 "name": "addConfiguration",
11641 "group": "Freshdesk_Accounts",
11642 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11643 "version": "0.0.0",
11644 "filename": "server/api/intFreshdeskAccount/index.js",
11645 "groupTitle": "Freshdesk_Accounts"
11649 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11650 "title": "Gets account configurations",
11653 "title": "Example usage:",
11654 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11658 "name": "getConfigurations",
11659 "group": "Freshdesk_Accounts",
11660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11661 "version": "0.0.0",
11662 "filename": "server/api/intFreshdeskAccount/index.js",
11663 "groupTitle": "Freshdesk_Accounts"
11667 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11668 "title": "Gets account fields",
11671 "title": "Example usage:",
11672 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11676 "name": "getFields",
11677 "group": "Freshdesk_Accounts",
11678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11679 "version": "0.0.0",
11680 "filename": "server/api/intFreshdeskAccount/index.js",
11681 "groupTitle": "Freshdesk_Accounts"
11685 "url": "/api/integrations/freshdesk/accounts/{id}",
11686 "title": "Update an existing Freshdesk Account",
11689 "title": "Example usage:",
11690 "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",
11694 "name": "updateFreshdesk_Accounts",
11695 "group": "Freshdesk_Accounts",
11696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11697 "version": "0.0.0",
11698 "filename": "server/api/intFreshdeskAccount/index.js",
11699 "groupTitle": "Freshdesk_Accounts"
11703 "url": "/api/integrations/freshdesk/configurations",
11704 "title": "Creates a new Freshdesk Configuration",
11707 "title": "Example usage:",
11708 "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",
11712 "name": "CreateFreshdesk_Configurations",
11713 "group": "Freshdesk_Configurations",
11728 "field": "description",
11734 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11735 "version": "0.0.0",
11736 "filename": "server/api/intFreshdeskConfiguration/index.js",
11737 "groupTitle": "Freshdesk_Configurations"
11741 "url": "/api/integrations/freshdesk/configurations/{id}",
11742 "title": "Deletes a Freshdesk Configuration",
11745 "title": "Example usage:",
11746 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11750 "name": "DeleteFreshdesk_Configurations",
11751 "group": "Freshdesk_Configurations",
11752 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11753 "version": "0.0.0",
11754 "filename": "server/api/intFreshdeskConfiguration/index.js",
11755 "groupTitle": "Freshdesk_Configurations"
11759 "url": "/api/integrations/freshdesk/configurations",
11760 "title": "Gets a list of Freshdesk Configurations",
11763 "title": "Example usage:",
11764 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11768 "name": "GetFreshdesk_Configurations",
11769 "group": "Freshdesk_Configurations",
11770 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11771 "version": "0.0.0",
11772 "filename": "server/api/intFreshdeskConfiguration/index.js",
11773 "groupTitle": "Freshdesk_Configurations"
11777 "url": "/api/integrations/freshdesk/configurations/{id}",
11778 "title": "Gets a single Freshdesk Configuration",
11781 "title": "Example usage:",
11782 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11786 "name": "ShowFreshdesk_Configurations",
11787 "group": "Freshdesk_Configurations",
11788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11789 "version": "0.0.0",
11790 "filename": "server/api/intFreshdeskConfiguration/index.js",
11791 "groupTitle": "Freshdesk_Configurations"
11795 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11796 "title": "Gets configurations descriptions",
11799 "title": "Example usage:",
11800 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11804 "name": "getDescriptions",
11805 "group": "Freshdesk_Configurations",
11806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11807 "version": "0.0.0",
11808 "filename": "server/api/intFreshdeskConfiguration/index.js",
11809 "groupTitle": "Freshdesk_Configurations"
11813 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11814 "title": "Gets configurations fields",
11817 "title": "Example usage:",
11818 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11822 "name": "getFields",
11823 "group": "Freshdesk_Configurations",
11824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11825 "version": "0.0.0",
11826 "filename": "server/api/intFreshdeskConfiguration/index.js",
11827 "groupTitle": "Freshdesk_Configurations"
11831 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11832 "title": "Gets configurations subjects",
11835 "title": "Example usage:",
11836 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11840 "name": "getSubjects",
11841 "group": "Freshdesk_Configurations",
11842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11843 "version": "0.0.0",
11844 "filename": "server/api/intFreshdeskConfiguration/index.js",
11845 "groupTitle": "Freshdesk_Configurations"
11849 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11850 "title": "Gets configurations tags",
11853 "title": "Example usage:",
11854 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11859 "group": "Freshdesk_Configurations",
11860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11861 "version": "0.0.0",
11862 "filename": "server/api/intFreshdeskConfiguration/index.js",
11863 "groupTitle": "Freshdesk_Configurations"
11867 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11868 "title": "Sets new tags",
11871 "title": "Example usage:",
11872 "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",
11877 "group": "Freshdesk_Configurations",
11878 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11879 "version": "0.0.0",
11880 "filename": "server/api/intFreshdeskConfiguration/index.js",
11881 "groupTitle": "Freshdesk_Configurations"
11885 "url": "/api/integrations/freshdesk/configurations/{id}",
11886 "title": "Update an existing Freshdesk Configuration",
11889 "title": "Example usage:",
11890 "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",
11894 "name": "updateFreshdesk_Configurations",
11895 "group": "Freshdesk_Configurations",
11896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11897 "version": "0.0.0",
11898 "filename": "server/api/intFreshdeskConfiguration/index.js",
11899 "groupTitle": "Freshdesk_Configurations"
11903 "url": "/api/integrations/freshdesk/fields",
11904 "title": "Creates a new Freshdesk Field",
11907 "title": "Example usage:",
11908 "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",
11912 "name": "CreateFreshdesk_Fields",
11913 "group": "Freshdesk_Fields",
11923 "\"customVariable\"",
11935 "field": "content",
11951 "\"customVariable\""
11954 "field": "keyType",
11961 "field": "keyContent",
11968 "field": "idField",
11975 "field": "nameField",
11982 "field": "customField",
11989 "field": "variableName",
11995 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11996 "version": "0.0.0",
11997 "filename": "server/api/intFreshdeskField/index.js",
11998 "groupTitle": "Freshdesk_Fields"
12002 "url": "/api/integrations/freshdesk/fields/{id}",
12003 "title": "Deletes a Freshdesk Field",
12006 "title": "Example usage:",
12007 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12011 "name": "DeleteFreshdesk_Fields",
12012 "group": "Freshdesk_Fields",
12013 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12014 "version": "0.0.0",
12015 "filename": "server/api/intFreshdeskField/index.js",
12016 "groupTitle": "Freshdesk_Fields"
12020 "url": "/api/integrations/freshdesk/fields",
12021 "title": "Gets a list of Freshdesk Fields",
12024 "title": "Example usage:",
12025 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12029 "name": "GetFreshdesk_Fields",
12030 "group": "Freshdesk_Fields",
12031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12032 "version": "0.0.0",
12033 "filename": "server/api/intFreshdeskField/index.js",
12034 "groupTitle": "Freshdesk_Fields"
12038 "url": "/api/integrations/freshdesk/fields/{id}",
12039 "title": "Gets a single Freshdesk Field",
12042 "title": "Example usage:",
12043 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12047 "name": "ShowFreshdesk_Fields",
12048 "group": "Freshdesk_Fields",
12049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12050 "version": "0.0.0",
12051 "filename": "server/api/intFreshdeskField/index.js",
12052 "groupTitle": "Freshdesk_Fields"
12056 "url": "/api/integrations/freshdesk/fields/{id}",
12057 "title": "Update an existing Freshdesk Field",
12060 "title": "Example usage:",
12061 "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",
12065 "name": "updateFreshdesk_Fields",
12066 "group": "Freshdesk_Fields",
12067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12068 "version": "0.0.0",
12069 "filename": "server/api/intFreshdeskField/index.js",
12070 "groupTitle": "Freshdesk_Fields"
12074 "url": "/api/integrations/freshsales/accounts",
12075 "title": "Creates a new Freshsales Account",
12078 "title": "Example usage:",
12079 "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",
12083 "name": "CreateFreshsales_Accounts",
12084 "group": "Freshsales_Accounts",
12099 "field": "description",
12106 "field": "username",
12120 "field": "remoteUri",
12127 "field": "serverUrl",
12133 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12134 "version": "0.0.0",
12135 "filename": "server/api/intFreshsalesAccount/index.js",
12136 "groupTitle": "Freshsales_Accounts"
12140 "url": "/api/integrations/freshsales/accounts/{id}",
12141 "title": "Deletes a Freshsales Account",
12144 "title": "Example usage:",
12145 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12149 "name": "DeleteFreshsales_Accounts",
12150 "group": "Freshsales_Accounts",
12151 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12152 "version": "0.0.0",
12153 "filename": "server/api/intFreshsalesAccount/index.js",
12154 "groupTitle": "Freshsales_Accounts"
12158 "url": "/api/integrations/freshsales/accounts",
12159 "title": "Gets a list of Freshsales Accounts",
12162 "title": "Example usage:",
12163 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12167 "name": "GetFreshsales_Accounts",
12168 "group": "Freshsales_Accounts",
12169 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12170 "version": "0.0.0",
12171 "filename": "server/api/intFreshsalesAccount/index.js",
12172 "groupTitle": "Freshsales_Accounts"
12176 "url": "/api/integrations/freshsales/accounts/{id}",
12177 "title": "Gets a single Freshsales Account",
12180 "title": "Example usage:",
12181 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12185 "name": "ShowFreshsales_Accounts",
12186 "group": "Freshsales_Accounts",
12187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12188 "version": "0.0.0",
12189 "filename": "server/api/intFreshsalesAccount/index.js",
12190 "groupTitle": "Freshsales_Accounts"
12194 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12195 "title": "Creates new configuration",
12198 "title": "Example usage:",
12199 "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",
12203 "name": "addConfiguration",
12204 "group": "Freshsales_Accounts",
12205 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12206 "version": "0.0.0",
12207 "filename": "server/api/intFreshsalesAccount/index.js",
12208 "groupTitle": "Freshsales_Accounts"
12212 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12213 "title": "Gets account configurations",
12216 "title": "Example usage:",
12217 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12221 "name": "getConfigurations",
12222 "group": "Freshsales_Accounts",
12223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12224 "version": "0.0.0",
12225 "filename": "server/api/intFreshsalesAccount/index.js",
12226 "groupTitle": "Freshsales_Accounts"
12230 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12231 "title": "Gets account fields",
12234 "title": "Example usage:",
12235 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12239 "name": "getFields",
12240 "group": "Freshsales_Accounts",
12241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12242 "version": "0.0.0",
12243 "filename": "server/api/intFreshsalesAccount/index.js",
12244 "groupTitle": "Freshsales_Accounts"
12248 "url": "/api/integrations/freshsales/accounts/{id}",
12249 "title": "Update an existing Freshsales Account",
12252 "title": "Example usage:",
12253 "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",
12257 "name": "updateFreshsales_Accounts",
12258 "group": "Freshsales_Accounts",
12259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12260 "version": "0.0.0",
12261 "filename": "server/api/intFreshsalesAccount/index.js",
12262 "groupTitle": "Freshsales_Accounts"
12266 "url": "/api/integrations/freshsales/configurations",
12267 "title": "Creates a new Freshsales Configuration",
12270 "title": "Example usage:",
12271 "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",
12275 "name": "CreateFreshsales_Configurations",
12276 "group": "Freshsales_Configurations",
12291 "field": "description",
12297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12298 "version": "0.0.0",
12299 "filename": "server/api/intFreshsalesConfiguration/index.js",
12300 "groupTitle": "Freshsales_Configurations"
12304 "url": "/api/integrations/freshsales/configurations/{id}",
12305 "title": "Deletes a Freshsales Configuration",
12308 "title": "Example usage:",
12309 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12313 "name": "DeleteFreshsales_Configurations",
12314 "group": "Freshsales_Configurations",
12315 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12316 "version": "0.0.0",
12317 "filename": "server/api/intFreshsalesConfiguration/index.js",
12318 "groupTitle": "Freshsales_Configurations"
12322 "url": "/api/integrations/freshsales/configurations",
12323 "title": "Gets a list of Freshsales Configurations",
12326 "title": "Example usage:",
12327 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12331 "name": "GetFreshsales_Configurations",
12332 "group": "Freshsales_Configurations",
12333 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12334 "version": "0.0.0",
12335 "filename": "server/api/intFreshsalesConfiguration/index.js",
12336 "groupTitle": "Freshsales_Configurations"
12340 "url": "/api/integrations/freshsales/configurations/{id}",
12341 "title": "Gets a single Freshsales Configuration",
12344 "title": "Example usage:",
12345 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12349 "name": "ShowFreshsales_Configurations",
12350 "group": "Freshsales_Configurations",
12351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12352 "version": "0.0.0",
12353 "filename": "server/api/intFreshsalesConfiguration/index.js",
12354 "groupTitle": "Freshsales_Configurations"
12358 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12359 "title": "Gets configurations descriptions",
12362 "title": "Example usage:",
12363 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12367 "name": "getDescriptions",
12368 "group": "Freshsales_Configurations",
12369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12370 "version": "0.0.0",
12371 "filename": "server/api/intFreshsalesConfiguration/index.js",
12372 "groupTitle": "Freshsales_Configurations"
12376 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12377 "title": "Gets configurations fields",
12380 "title": "Example usage:",
12381 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12385 "name": "getFields",
12386 "group": "Freshsales_Configurations",
12387 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12388 "version": "0.0.0",
12389 "filename": "server/api/intFreshsalesConfiguration/index.js",
12390 "groupTitle": "Freshsales_Configurations"
12394 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12395 "title": "Gets configurations subjects",
12398 "title": "Example usage:",
12399 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12403 "name": "getSubjects",
12404 "group": "Freshsales_Configurations",
12405 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12406 "version": "0.0.0",
12407 "filename": "server/api/intFreshsalesConfiguration/index.js",
12408 "groupTitle": "Freshsales_Configurations"
12412 "url": "/api/integrations/freshsales/configurations/{id}",
12413 "title": "Update an existing Freshsales Configuration",
12416 "title": "Example usage:",
12417 "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",
12421 "name": "updateFreshsales_Configurations",
12422 "group": "Freshsales_Configurations",
12423 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12424 "version": "0.0.0",
12425 "filename": "server/api/intFreshsalesConfiguration/index.js",
12426 "groupTitle": "Freshsales_Configurations"
12430 "url": "/api/integrations/freshsales/fields",
12431 "title": "Creates a new Freshsales Field",
12434 "title": "Example usage:",
12435 "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",
12439 "name": "CreateFreshsales_Fields",
12440 "group": "Freshsales_Fields",
12450 "\"customVariable\"",
12462 "field": "content",
12478 "\"customVariable\""
12481 "field": "keyType",
12488 "field": "keyContent",
12495 "field": "idField",
12502 "field": "nameField",
12509 "field": "customField",
12516 "field": "variableName",
12522 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12523 "version": "0.0.0",
12524 "filename": "server/api/intFreshsalesField/index.js",
12525 "groupTitle": "Freshsales_Fields"
12529 "url": "/api/integrations/freshsales/fields/{id}",
12530 "title": "Deletes a Freshsales Field",
12533 "title": "Example usage:",
12534 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12538 "name": "DeleteFreshsales_Fields",
12539 "group": "Freshsales_Fields",
12540 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12541 "version": "0.0.0",
12542 "filename": "server/api/intFreshsalesField/index.js",
12543 "groupTitle": "Freshsales_Fields"
12547 "url": "/api/integrations/freshsales/fields",
12548 "title": "Gets a list of Freshsales Fields",
12551 "title": "Example usage:",
12552 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12556 "name": "GetFreshsales_Fields",
12557 "group": "Freshsales_Fields",
12558 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12559 "version": "0.0.0",
12560 "filename": "server/api/intFreshsalesField/index.js",
12561 "groupTitle": "Freshsales_Fields"
12565 "url": "/api/integrations/freshsales/fields/{id}",
12566 "title": "Gets a single Freshsales Field",
12569 "title": "Example usage:",
12570 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12574 "name": "ShowFreshsales_Fields",
12575 "group": "Freshsales_Fields",
12576 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12577 "version": "0.0.0",
12578 "filename": "server/api/intFreshsalesField/index.js",
12579 "groupTitle": "Freshsales_Fields"
12583 "url": "/api/integrations/freshsales/fields/{id}",
12584 "title": "Update an existing Freshsales Field",
12587 "title": "Example usage:",
12588 "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",
12592 "name": "updateFreshsales_Fields",
12593 "group": "Freshsales_Fields",
12594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12595 "version": "0.0.0",
12596 "filename": "server/api/intFreshsalesField/index.js",
12597 "groupTitle": "Freshsales_Fields"
12601 "url": "/api/campaigns/{id}/blacklists",
12602 "title": "Add blacklists to an IVR campaign",
12605 "title": "Example usage:",
12606 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12610 "name": "AddBlackLists",
12611 "group": "IVR_Campaigns",
12612 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12613 "version": "0.0.0",
12614 "filename": "server/api/campaign/index.js",
12615 "groupTitle": "IVR_Campaigns"
12619 "url": "/api/campaigns/{id}/lists",
12620 "title": "Add lists to an IVR campaign",
12623 "title": "Example usage:",
12624 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12628 "name": "AddLists",
12629 "group": "IVR_Campaigns",
12630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12631 "version": "0.0.0",
12632 "filename": "server/api/campaign/index.js",
12633 "groupTitle": "IVR_Campaigns"
12637 "url": "/api/campaigns/clone",
12638 "title": "Clone an existing IVR Campaign",
12641 "title": "Example usage:",
12642 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12646 "name": "CloneIVR_Campaigns",
12647 "group": "IVR_Campaigns",
12648 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12649 "version": "0.0.0",
12650 "filename": "server/api/campaign/index.js",
12651 "groupTitle": "IVR_Campaigns"
12655 "url": "/api/campaigns",
12656 "title": "Creates a new IVR Campaign",
12659 "title": "Example usage:",
12660 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12664 "name": "CreateIVR_Campaigns",
12665 "group": "IVR_Campaigns",
12690 "field": "description",
12698 "description": "<p>Active/Disactive Campaign</p>"
12704 "field": "limitCalls",
12705 "description": "<p>Max 200 calls.</p>"
12711 "field": "dialOriginateCallerIdName",
12718 "field": "dialOriginateCallerIdNumber",
12725 "field": "dialOriginateTimeout",
12726 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12732 "field": "dialCongestionMaxRetry",
12733 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12739 "field": "dialCongestionRetryFrequency",
12740 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12746 "field": "dialBusyMaxRetry",
12747 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12753 "field": "dialBusyRetryFrequency",
12754 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12760 "field": "dialNoAnswerMaxRetry",
12761 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12767 "field": "dialNoAnswerRetryFrequency",
12768 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12774 "field": "dialGlobalMaxRetry",
12775 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12781 "field": "dialTimezone",
12788 "field": "dialGlobalInterval",
12800 "field": "dialCheckDuplicateType",
12807 "field": "dialAMDActive",
12808 "description": "<p>Active/Disactive AMD</p>"
12814 "field": "dialAMDInitialSilence",
12815 "description": "<p>#AMD Initial Silence</p>"
12821 "field": "dialAMDGreeting",
12822 "description": "<p>#AMD Greeting</p>"
12828 "field": "dialAMDAfterGreetingSilence",
12829 "description": "<p>#AMD After Greeting Silence</p>"
12835 "field": "dialAMDTotalAnalysisTime",
12836 "description": "<p>#AMD Total Analysis Time</p>"
12842 "field": "dialAMDMinWordLength",
12843 "description": "<p>#AMD Min Word Length</p>"
12849 "field": "dialAMDBetweenWordsSilence",
12850 "description": "<p>#AMD Between Words Silence</p>"
12856 "field": "dialAMDMaximumNumberOfWords",
12857 "description": "<p>#AMD Maximum Number Of Words</p>"
12863 "field": "dialAMDSilenceThreshold",
12864 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12870 "field": "dialAMDMaximumWordLength",
12871 "description": "<p>#AMD Maximum Word Length</p>"
12881 "field": "dialOrderByScheduledAt",
12888 "field": "dialPrefix",
12895 "field": "dialRandomLastDigitCallerIdNumber",
12896 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12902 "field": "dialCutDigit",
12903 "description": "<p>Cut Digit (min:1, max:15)</p>"
12909 "field": "dialNoSuchNumberMaxRetry",
12910 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12916 "field": "dialNoSuchNumberRetryFrequency",
12917 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12923 "field": "dialDropMaxRetry",
12924 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12930 "field": "dialDropRetryFrequency",
12931 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12937 "field": "dialAbandonedMaxRetry",
12938 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12944 "field": "dialAbandonedRetryFrequency",
12945 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12951 "field": "dialMachineMaxRetry",
12952 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12958 "field": "dialMachineRetryFrequency",
12959 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12965 "field": "dialAgentRejectMaxRetry",
12966 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12972 "field": "dialAgentRejectRetryFrequency",
12973 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12978 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12979 "version": "0.0.0",
12980 "filename": "server/api/campaign/index.js",
12981 "groupTitle": "IVR_Campaigns"
12985 "url": "/api/campaigns/{id}",
12986 "title": "Deletes a IVR Campaign",
12989 "title": "Example usage:",
12990 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12994 "name": "DeleteIVR_Campaigns",
12995 "group": "IVR_Campaigns",
12996 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12997 "version": "0.0.0",
12998 "filename": "server/api/campaign/index.js",
12999 "groupTitle": "IVR_Campaigns"
13003 "url": "/api/campaigns/{id}/blacklists",
13004 "title": "Get IVR campaign blacklists",
13007 "title": "Example usage:",
13008 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13012 "name": "GetBlackLists",
13013 "group": "IVR_Campaigns",
13014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13015 "version": "0.0.0",
13016 "filename": "server/api/campaign/index.js",
13017 "groupTitle": "IVR_Campaigns"
13021 "url": "/api/campaigns/{id}/finals",
13022 "title": "Gets IVR campaign hopper finals",
13025 "title": "Example usage:",
13026 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13030 "name": "GetHopperFinals",
13031 "group": "IVR_Campaigns",
13032 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13033 "version": "0.0.0",
13034 "filename": "server/api/campaign/index.js",
13035 "groupTitle": "IVR_Campaigns"
13039 "url": "/api/campaigns/{id}/hopper_histories",
13040 "title": "Gets IVR campaign hopper histories",
13043 "title": "Example usage:",
13044 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13048 "name": "GetHopperHistories",
13049 "group": "IVR_Campaigns",
13050 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13051 "version": "0.0.0",
13052 "filename": "server/api/campaign/index.js",
13053 "groupTitle": "IVR_Campaigns"
13057 "url": "/api/campaigns/{id}/hoppers",
13058 "title": "Gets IVR campaign hoppers",
13061 "title": "Example usage:",
13062 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13066 "name": "GetHoppers",
13067 "group": "IVR_Campaigns",
13068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13069 "version": "0.0.0",
13070 "filename": "server/api/campaign/index.js",
13071 "groupTitle": "IVR_Campaigns"
13075 "url": "/api/campaigns",
13076 "title": "Gets a list of IVR Campaigns",
13079 "title": "Example usage:",
13080 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13084 "name": "GetIVR_Campaigns",
13085 "group": "IVR_Campaigns",
13086 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13087 "version": "0.0.0",
13088 "filename": "server/api/campaign/index.js",
13089 "groupTitle": "IVR_Campaigns"
13093 "url": "/api/campaigns/{id}/lists",
13094 "title": "Get IVR campaign lists",
13097 "title": "Example usage:",
13098 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13102 "name": "GetLists",
13103 "group": "IVR_Campaigns",
13104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13105 "version": "0.0.0",
13106 "filename": "server/api/campaign/index.js",
13107 "groupTitle": "IVR_Campaigns"
13111 "url": "/api/campaigns/{id}/blacklists",
13112 "title": "Remove blacklists from an IVR Campaign",
13115 "title": "Example usage:",
13116 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13120 "name": "RemoveBlackLists",
13121 "group": "IVR_Campaigns",
13122 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13123 "version": "0.0.0",
13124 "filename": "server/api/campaign/index.js",
13125 "groupTitle": "IVR_Campaigns"
13129 "url": "/api/campaigns/{id}/lists",
13130 "title": "Remove lists from an IVR Campaign",
13133 "title": "Example usage:",
13134 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13138 "name": "RemoveLists",
13139 "group": "IVR_Campaigns",
13140 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13141 "version": "0.0.0",
13142 "filename": "server/api/campaign/index.js",
13143 "groupTitle": "IVR_Campaigns"
13147 "url": "/api/campaigns/{id}",
13148 "title": "Gets a single IVR Campaign",
13151 "title": "Example usage:",
13152 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13156 "name": "ShowIVR_Campaigns",
13157 "group": "IVR_Campaigns",
13158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13159 "version": "0.0.0",
13160 "filename": "server/api/campaign/index.js",
13161 "groupTitle": "IVR_Campaigns"
13165 "url": "/api/campaigns/{id}/blacks",
13166 "title": "Gets IVR campaign hopper blacks",
13169 "title": "Example usage:",
13170 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13174 "name": "getHopperBlacks",
13175 "group": "IVR_Campaigns",
13176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13177 "version": "0.0.0",
13178 "filename": "server/api/campaign/index.js",
13179 "groupTitle": "IVR_Campaigns"
13183 "url": "/api/campaigns/{id}",
13184 "title": "Update an existing IVR Campaign",
13187 "title": "Example usage:",
13188 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13192 "name": "updateIVR_Campaigns",
13193 "group": "IVR_Campaigns",
13194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13195 "version": "0.0.0",
13196 "filename": "server/api/campaign/index.js",
13197 "groupTitle": "IVR_Campaigns"
13201 "url": "/api/integrations/reports",
13202 "title": "Creates a new Integration Report",
13205 "title": "Example usage:",
13206 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13210 "name": "CreateIntegration_Reports",
13211 "group": "Integration_Reports",
13219 "field": "integration",
13226 "field": "eventChannel",
13233 "field": "exitStatus",
13240 "field": "ticketId",
13247 "field": "integrationId",
13254 "field": "contacts",
13261 "field": "uniqueid",
13268 "field": "calleridnum",
13275 "field": "calleridname",
13289 "field": "interface",
13296 "field": "membername",
13303 "field": "agentcalledAt",
13310 "field": "agentconnectAt",
13317 "field": "holdtime",
13324 "field": "agentcomplete",
13331 "field": "agentcompleteAt",
13338 "field": "talktime",
13345 "field": "agentacw",
13352 "field": "acwtime",
13366 "field": "agentringnoanswer",
13373 "field": "agentringnoanswerAt",
13380 "field": "agentdump",
13387 "field": "agentdumpAt",
13394 "field": "lastevent",
13401 "field": "channel",
13408 "field": "channelstate",
13415 "field": "channelstatedesc",
13422 "field": "connectedlinenum",
13429 "field": "connectedlinename",
13436 "field": "language",
13443 "field": "accountcode",
13450 "field": "context",
13464 "field": "priority",
13471 "field": "destchannel",
13478 "field": "destchannelstate",
13485 "field": "destchannelstatedesc",
13492 "field": "destcalleridnum",
13499 "field": "destcalleridname",
13506 "field": "destconnectedlinenum",
13513 "field": "destconnectedlinename",
13520 "field": "destlanguage",
13527 "field": "destaccountcode",
13534 "field": "destcontext",
13541 "field": "destexten",
13548 "field": "destpriority",
13555 "field": "destuniqueid",
13562 "field": "messageId",
13569 "field": "inReplyTo",
13576 "field": "subject",
13604 "field": "attachment",
13652 "field": "appdata",
13659 "field": "projectId",
13665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13666 "version": "0.0.0",
13667 "filename": "server/api/integrationReport/index.js",
13668 "groupTitle": "Integration_Reports"
13672 "url": "/api/integrations/reports/{id}",
13673 "title": "Deletes a Integration Report",
13676 "title": "Example usage:",
13677 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13681 "name": "DeleteIntegration_Reports",
13682 "group": "Integration_Reports",
13683 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13684 "version": "0.0.0",
13685 "filename": "server/api/integrationReport/index.js",
13686 "groupTitle": "Integration_Reports"
13690 "url": "/api/integrations/reports/describe",
13691 "title": "Gets table info about Integration Reports",
13694 "title": "Example usage:",
13695 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13699 "name": "DescribeIntegration_Reports",
13700 "group": "Integration_Reports",
13701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13702 "version": "0.0.0",
13703 "filename": "server/api/integrationReport/index.js",
13704 "groupTitle": "Integration_Reports"
13708 "url": "/api/integrations/reports",
13709 "title": "Gets a list of Integration Reports",
13712 "title": "Example usage:",
13713 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13717 "name": "GetIntegration_Reports",
13718 "group": "Integration_Reports",
13719 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13720 "version": "0.0.0",
13721 "filename": "server/api/integrationReport/index.js",
13722 "groupTitle": "Integration_Reports"
13726 "url": "/api/integrations/reports/{id}",
13727 "title": "Gets a single Integration Report",
13730 "title": "Example usage:",
13731 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13735 "name": "ShowIntegration_Reports",
13736 "group": "Integration_Reports",
13737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13738 "version": "0.0.0",
13739 "filename": "server/api/integrationReport/index.js",
13740 "groupTitle": "Integration_Reports"
13744 "url": "/api/integrations/reports/{id}",
13745 "title": "Update an existing Integration Report",
13748 "title": "Example usage:",
13749 "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",
13753 "name": "updateIntegration_Reports",
13754 "group": "Integration_Reports",
13755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13756 "version": "0.0.0",
13757 "filename": "server/api/integrationReport/index.js",
13758 "groupTitle": "Integration_Reports"
13762 "url": "/api/intervals",
13763 "title": "Creates a new Interval",
13766 "title": "Example usage:",
13767 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13771 "name": "CreateIntervals",
13772 "group": "Intervals",
13787 "field": "description",
13794 "field": "interval",
13800 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13801 "version": "0.0.0",
13802 "filename": "server/api/interval/index.js",
13803 "groupTitle": "Intervals"
13807 "url": "/api/intervals/{id}",
13808 "title": "Deletes a Interval",
13811 "title": "Example usage:",
13812 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13816 "name": "DeleteIntervals",
13817 "group": "Intervals",
13818 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13819 "version": "0.0.0",
13820 "filename": "server/api/interval/index.js",
13821 "groupTitle": "Intervals"
13825 "url": "/api/intervals",
13826 "title": "Gets a list of Intervals",
13829 "title": "Example usage:",
13830 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13834 "name": "GetIntervals",
13835 "group": "Intervals",
13836 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13837 "version": "0.0.0",
13838 "filename": "server/api/interval/index.js",
13839 "groupTitle": "Intervals"
13843 "url": "/api/intervals/{id}",
13844 "title": "Gets a single Interval",
13847 "title": "Example usage:",
13848 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13852 "name": "ShowIntervals",
13853 "group": "Intervals",
13854 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13855 "version": "0.0.0",
13856 "filename": "server/api/interval/index.js",
13857 "groupTitle": "Intervals"
13861 "url": "/api/intervals/{id}/sub_intervals",
13862 "title": "Creates a new sub interval",
13865 "title": "Example usage:",
13866 "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",
13870 "name": "addInterval",
13871 "group": "Intervals",
13872 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13873 "version": "0.0.0",
13874 "filename": "server/api/interval/index.js",
13875 "groupTitle": "Intervals"
13879 "url": "/api/intervals/{id}/sub_intervals/create_many",
13880 "title": "Create new sub intervals set",
13883 "title": "Example usage:",
13884 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13888 "name": "addIntervals",
13889 "group": "Intervals",
13890 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13891 "version": "0.0.0",
13892 "filename": "server/api/interval/index.js",
13893 "groupTitle": "Intervals"
13897 "url": "/api/intervals/{id}/sub_intervals",
13898 "title": "Get sub intervals set",
13901 "title": "Example usage:",
13902 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13906 "name": "getIntervals",
13907 "group": "Intervals",
13908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13909 "version": "0.0.0",
13910 "filename": "server/api/interval/index.js",
13911 "groupTitle": "Intervals"
13915 "url": "/api/intervals/{id}",
13916 "title": "Update an existing Interval",
13919 "title": "Example usage:",
13920 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13924 "name": "updateIntervals",
13925 "group": "Intervals",
13926 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13927 "version": "0.0.0",
13928 "filename": "server/api/interval/index.js",
13929 "groupTitle": "Intervals"
13933 "url": "/api/jira",
13934 "title": "Creates a new issue",
13937 "title": "Example usage:",
13938 "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}",
13942 "name": "Creates_Issue",
13954 "field": "issuetype",
13961 "field": "summary",
13968 "field": "description",
13974 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13975 "version": "0.0.0",
13976 "filename": "server/api/jira/index.js",
13977 "groupTitle": "Issue"
13981 "url": "/api/jscripty/answers/reports",
13982 "title": "Creates a new Report",
13985 "title": "Example usage:",
13986 "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",
13990 "name": "CreateReports",
13991 "group": "JscriptyAnswerReport",
13999 "field": "question",
14013 "field": "membername",
14020 "field": "projectname",
14034 "field": "uniqueid",
14041 "field": "calleridname",
14048 "field": "calleridnum",
14055 "field": "questionId",
14061 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14062 "version": "0.0.0",
14063 "filename": "server/api/jscriptyAnswerReport/index.js",
14064 "groupTitle": "JscriptyAnswerReport"
14068 "url": "/api/jscripty/answers/reports/{id}",
14069 "title": "Deletes a Report",
14072 "title": "Example usage:",
14073 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14077 "name": "DeleteReports",
14078 "group": "JscriptyAnswerReport",
14079 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/jscriptyAnswerReport/index.js",
14082 "groupTitle": "JscriptyAnswerReport"
14086 "url": "/api/jscripty/answers/reports/describe",
14087 "title": "Gets table info about Reports",
14090 "title": "Example usage:",
14091 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14095 "name": "DescribeReports",
14096 "group": "JscriptyAnswerReport",
14097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14098 "version": "0.0.0",
14099 "filename": "server/api/jscriptyAnswerReport/index.js",
14100 "groupTitle": "JscriptyAnswerReport"
14104 "url": "/api/jscripty/answers/reports",
14105 "title": "Gets a list of Reports",
14108 "title": "Example usage:",
14109 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14113 "name": "GetReports",
14114 "group": "JscriptyAnswerReport",
14115 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14116 "version": "0.0.0",
14117 "filename": "server/api/jscriptyAnswerReport/index.js",
14118 "groupTitle": "JscriptyAnswerReport"
14122 "url": "/api/jscripty/answers/reports/{id}",
14123 "title": "Gets a single Report",
14126 "title": "Example usage:",
14127 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14131 "name": "ShowReports",
14132 "group": "JscriptyAnswerReport",
14133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14134 "version": "0.0.0",
14135 "filename": "server/api/jscriptyAnswerReport/index.js",
14136 "groupTitle": "JscriptyAnswerReport"
14140 "url": "/api/jscripty/answers/reports/{id}",
14141 "title": "Update an existing Report",
14144 "title": "Example usage:",
14145 "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",
14149 "name": "updateReports",
14150 "group": "JscriptyAnswerReport",
14151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14152 "version": "0.0.0",
14153 "filename": "server/api/jscriptyAnswerReport/index.js",
14154 "groupTitle": "JscriptyAnswerReport"
14158 "url": "/api/jscripty/questions/reports",
14159 "title": "Creates a new Report",
14162 "title": "Example usage:",
14163 "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",
14167 "name": "CreateReports",
14168 "group": "JscriptyQuestionReport",
14176 "field": "question",
14190 "field": "membername",
14197 "field": "projectname",
14211 "field": "uniqueid",
14218 "field": "calleridname",
14225 "field": "calleridnum",
14232 "field": "questionId",
14238 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14239 "version": "0.0.0",
14240 "filename": "server/api/jscriptyQuestionReport/index.js",
14241 "groupTitle": "JscriptyQuestionReport"
14245 "url": "/api/jscripty/questions/reports/{id}",
14246 "title": "Deletes a Report",
14249 "title": "Example usage:",
14250 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14254 "name": "DeleteReports",
14255 "group": "JscriptyQuestionReport",
14256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/jscriptyQuestionReport/index.js",
14259 "groupTitle": "JscriptyQuestionReport"
14263 "url": "/api/jscripty/questions/reports/describe",
14264 "title": "Gets table info about Reports",
14267 "title": "Example usage:",
14268 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14272 "name": "DescribeReports",
14273 "group": "JscriptyQuestionReport",
14274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14275 "version": "0.0.0",
14276 "filename": "server/api/jscriptyQuestionReport/index.js",
14277 "groupTitle": "JscriptyQuestionReport"
14281 "url": "/api/jscripty/questions/reports",
14282 "title": "Gets a list of Reports",
14285 "title": "Example usage:",
14286 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14290 "name": "GetReports",
14291 "group": "JscriptyQuestionReport",
14292 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14293 "version": "0.0.0",
14294 "filename": "server/api/jscriptyQuestionReport/index.js",
14295 "groupTitle": "JscriptyQuestionReport"
14299 "url": "/api/jscripty/questions/reports/{id}",
14300 "title": "Gets a single Report",
14303 "title": "Example usage:",
14304 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14308 "name": "ShowReports",
14309 "group": "JscriptyQuestionReport",
14310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14311 "version": "0.0.0",
14312 "filename": "server/api/jscriptyQuestionReport/index.js",
14313 "groupTitle": "JscriptyQuestionReport"
14317 "url": "/api/jscripty/questions/reports/{id}",
14318 "title": "Update an existing Report",
14321 "title": "Example usage:",
14322 "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",
14326 "name": "updateReports",
14327 "group": "JscriptyQuestionReport",
14328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14329 "version": "0.0.0",
14330 "filename": "server/api/jscriptyQuestionReport/index.js",
14331 "groupTitle": "JscriptyQuestionReport"
14335 "url": "/api/jscripty/sessions/reports",
14336 "title": "Creates a new Report",
14339 "title": "Example usage:",
14340 "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",
14344 "name": "CreateReports",
14345 "group": "JscriptySessionReport",
14353 "field": "starttime",
14360 "field": "endtime",
14367 "field": "membername",
14374 "field": "projectname",
14388 "field": "uniqueid",
14395 "field": "calleridname",
14402 "field": "calleridnum",
14409 "field": "completed",
14415 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14416 "version": "0.0.0",
14417 "filename": "server/api/jscriptySessionReport/index.js",
14418 "groupTitle": "JscriptySessionReport"
14422 "url": "/api/jscripty/sessions/reports/{id}",
14423 "title": "Deletes a Report",
14426 "title": "Example usage:",
14427 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14431 "name": "DeleteReports",
14432 "group": "JscriptySessionReport",
14433 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14434 "version": "0.0.0",
14435 "filename": "server/api/jscriptySessionReport/index.js",
14436 "groupTitle": "JscriptySessionReport"
14440 "url": "/api/jscripty/sessions/reports/describe",
14441 "title": "Gets table info about Reports",
14444 "title": "Example usage:",
14445 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14449 "name": "DescribeReports",
14450 "group": "JscriptySessionReport",
14451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14452 "version": "0.0.0",
14453 "filename": "server/api/jscriptySessionReport/index.js",
14454 "groupTitle": "JscriptySessionReport"
14458 "url": "/api/jscripty/sessions/reports",
14459 "title": "Gets a list of Reports",
14462 "title": "Example usage:",
14463 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14467 "name": "GetReports",
14468 "group": "JscriptySessionReport",
14469 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14470 "version": "0.0.0",
14471 "filename": "server/api/jscriptySessionReport/index.js",
14472 "groupTitle": "JscriptySessionReport"
14476 "url": "/api/jscripty/sessions/reports/{id}",
14477 "title": "Gets a single Report",
14480 "title": "Example usage:",
14481 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14485 "name": "ShowReports",
14486 "group": "JscriptySessionReport",
14487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14488 "version": "0.0.0",
14489 "filename": "server/api/jscriptySessionReport/index.js",
14490 "groupTitle": "JscriptySessionReport"
14494 "url": "/api/jscripty/sessions/reports/{id}/questions",
14495 "title": "Gets Jscripty Session questions",
14498 "title": "Example usage:",
14499 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14503 "name": "getQuestions",
14504 "group": "JscriptySessionReport",
14505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14506 "version": "0.0.0",
14507 "filename": "server/api/jscriptySessionReport/index.js",
14508 "groupTitle": "JscriptySessionReport"
14512 "url": "/api/jscripty/sessions/reports/{id}",
14513 "title": "Update an existing Report",
14516 "title": "Example usage:",
14517 "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",
14521 "name": "updateReports",
14522 "group": "JscriptySessionReport",
14523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14524 "version": "0.0.0",
14525 "filename": "server/api/jscriptySessionReport/index.js",
14526 "groupTitle": "JscriptySessionReport"
14530 "url": "/api/jscripty/projects/clone",
14531 "title": "Clone an existing Project",
14534 "title": "Example usage:",
14535 "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",
14539 "name": "CloneProjects",
14540 "group": "Jscripty_Projects",
14541 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14542 "version": "0.0.0",
14543 "filename": "server/api/jscriptyProject/index.js",
14544 "groupTitle": "Jscripty_Projects"
14548 "url": "/api/jscripty/projects",
14549 "title": "Creates a new Project",
14552 "title": "Example usage:",
14553 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14557 "name": "CreateProjects",
14558 "group": "Jscripty_Projects",
14573 "field": "description",
14580 "field": "formData",
14587 "field": "enableUncompleteSave",
14594 "field": "sendUnpauseOnSubmit",
14600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14601 "version": "0.0.0",
14602 "filename": "server/api/jscriptyProject/index.js",
14603 "groupTitle": "Jscripty_Projects"
14607 "url": "/api/jscripty/projects/{id}",
14608 "title": "Deletes a Project",
14611 "title": "Example usage:",
14612 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14616 "name": "DeleteProjects",
14617 "group": "Jscripty_Projects",
14618 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14619 "version": "0.0.0",
14620 "filename": "server/api/jscriptyProject/index.js",
14621 "groupTitle": "Jscripty_Projects"
14625 "url": "/api/jscripty/projects",
14626 "title": "Gets a list of Projects",
14629 "title": "Example usage:",
14630 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14634 "name": "GetProjects",
14635 "group": "Jscripty_Projects",
14636 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14637 "version": "0.0.0",
14638 "filename": "server/api/jscriptyProject/index.js",
14639 "groupTitle": "Jscripty_Projects"
14643 "url": "/api/jscripty/projects/{id}",
14644 "title": "Gets a single Project",
14647 "title": "Example usage:",
14648 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14652 "name": "ShowProjects",
14653 "group": "Jscripty_Projects",
14654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14655 "version": "0.0.0",
14656 "filename": "server/api/jscriptyProject/index.js",
14657 "groupTitle": "Jscripty_Projects"
14661 "url": "/api/jscripty/projects/{id}/answers",
14662 "title": "Gets jscripty project answers",
14665 "title": "Example usage:",
14666 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14670 "name": "getAnswers",
14671 "group": "Jscripty_Projects",
14672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14673 "version": "0.0.0",
14674 "filename": "server/api/jscriptyProject/index.js",
14675 "groupTitle": "Jscripty_Projects"
14679 "url": "/api/jscripty/projects/{id}/sessions",
14680 "title": "Gets jscripty project sessions",
14683 "title": "Example usage:",
14684 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14688 "name": "getSessions",
14689 "group": "Jscripty_Projects",
14690 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14691 "version": "0.0.0",
14692 "filename": "server/api/jscriptyProject/index.js",
14693 "groupTitle": "Jscripty_Projects"
14697 "url": "/api/jscripty/projects/{id}/summary",
14698 "title": "Gets jscripty project summary",
14701 "title": "Example usage:",
14702 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14706 "name": "getSummary",
14707 "group": "Jscripty_Projects",
14708 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14709 "version": "0.0.0",
14710 "filename": "server/api/jscriptyProject/index.js",
14711 "groupTitle": "Jscripty_Projects"
14715 "url": "/api/jscripty/projects/{id}",
14716 "title": "Update an existing Project",
14719 "title": "Example usage:",
14720 "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",
14724 "name": "updateProjects",
14725 "group": "Jscripty_Projects",
14726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14727 "version": "0.0.0",
14728 "filename": "server/api/jscriptyProject/index.js",
14729 "groupTitle": "Jscripty_Projects"
14733 "url": "/api/license",
14734 "title": "Gets License Info",
14737 "title": "Example usage:",
14738 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14743 "group": "License",
14744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14745 "version": "0.0.0",
14746 "filename": "server/api/license/index.js",
14747 "groupTitle": "License"
14751 "url": "/api/license/{id}",
14752 "title": "Update License Info",
14755 "title": "Example usage:",
14756 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14761 "group": "License",
14762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14763 "version": "0.0.0",
14764 "filename": "server/api/license/index.js",
14765 "groupTitle": "License"
14769 "url": "/api/mail/accounts/{id}/users",
14770 "title": "Add agents to a mail account",
14773 "title": "Example usage:",
14774 "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",
14778 "name": "AddAgents",
14779 "group": "Mail_Accounts",
14780 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14781 "version": "0.0.0",
14782 "filename": "server/api/mailAccount/index.js",
14783 "groupTitle": "Mail_Accounts"
14787 "url": "/api/mail/accounts/{id}/in_servers",
14788 "title": "Creates a new IMAP server",
14791 "title": "Example usage:",
14792 "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",
14797 "group": "Mail_Accounts",
14805 "field": "description",
14819 "field": "authentication",
14833 "field": "password",
14854 "field": "mailbox",
14861 "field": "connTimeout",
14868 "field": "authTimeout",
14875 "field": "service",
14881 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14882 "version": "0.0.0",
14883 "filename": "server/api/mailAccount/index.js",
14884 "groupTitle": "Mail_Accounts"
14888 "url": "/api/mail/accounts/{id}/out_servers",
14889 "title": "Creates a new SMTP server",
14892 "title": "Example usage:",
14893 "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",
14898 "group": "Mail_Accounts",
14906 "field": "description",
14948 "field": "service",
14955 "field": "authentication",
14961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14962 "version": "0.0.0",
14963 "filename": "server/api/mailAccount/index.js",
14964 "groupTitle": "Mail_Accounts"
14968 "url": "/api/mail/accounts/{id}",
14969 "title": "Deletes a mail account",
14972 "title": "Example usage:",
14973 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14977 "name": "DeleteMailAccounts",
14978 "group": "Mail_Accounts",
14979 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14980 "version": "0.0.0",
14981 "filename": "server/api/mailAccount/index.js",
14982 "groupTitle": "Mail_Accounts"
14986 "url": "/api/mail/accounts/describe",
14987 "title": "Gets table info about Accounts",
14990 "title": "Example usage:",
14991 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14995 "name": "DescribeAccounts",
14996 "group": "Mail_Accounts",
14997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14998 "version": "0.0.0",
14999 "filename": "server/api/mailAccount/index.js",
15000 "groupTitle": "Mail_Accounts"
15004 "url": "/api/mail/accounts",
15005 "title": "Gets a list of Accounts",
15008 "title": "Example usage:",
15009 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15013 "name": "GetAccounts",
15014 "group": "Mail_Accounts",
15015 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15016 "version": "0.0.0",
15017 "filename": "server/api/mailAccount/index.js",
15018 "groupTitle": "Mail_Accounts"
15022 "url": "/api/mail/accounts/{id}/users",
15023 "title": "Gets agents from mail account",
15026 "title": "Example usage:",
15027 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15031 "name": "GetAgents",
15032 "group": "Mail_Accounts",
15033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15034 "version": "0.0.0",
15035 "filename": "server/api/mailAccount/index.js",
15036 "groupTitle": "Mail_Accounts"
15040 "url": "/api/mail/accounts/{id}/in_servers",
15041 "title": "Gets account IMAP server",
15044 "title": "Example usage:",
15045 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15050 "group": "Mail_Accounts",
15051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15052 "version": "0.0.0",
15053 "filename": "server/api/mailAccount/index.js",
15054 "groupTitle": "Mail_Accounts"
15058 "url": "/api/mail/accounts/{id}/out_servers",
15059 "title": "Gets account SMTP server",
15062 "title": "Example usage:",
15063 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15068 "group": "Mail_Accounts",
15069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15070 "version": "0.0.0",
15071 "filename": "server/api/mailAccount/index.js",
15072 "groupTitle": "Mail_Accounts"
15076 "url": "/api/mail/accounts/{id}/users",
15077 "title": "Removes agents from a mail account",
15080 "title": "Example usage:",
15081 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15085 "name": "RemoveAgents",
15086 "group": "Mail_Accounts",
15087 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15088 "version": "0.0.0",
15089 "filename": "server/api/mailAccount/index.js",
15090 "groupTitle": "Mail_Accounts"
15094 "url": "/api/mail/accounts/{id}/canned_answers",
15095 "title": "Removes canned answers from account",
15098 "title": "Example usage:",
15099 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15103 "name": "RemoveAnswers",
15104 "group": "Mail_Accounts",
15105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15106 "version": "0.0.0",
15107 "filename": "server/api/mailAccount/index.js",
15108 "groupTitle": "Mail_Accounts"
15112 "url": "/api/mail/accounts/{id}/dispositions",
15113 "title": "Removes dispositions from account",
15116 "title": "Example usage:",
15117 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15121 "name": "RemoveDispositions",
15122 "group": "Mail_Accounts",
15123 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15124 "version": "0.0.0",
15125 "filename": "server/api/mailAccount/index.js",
15126 "groupTitle": "Mail_Accounts"
15130 "url": "/api/mail/accounts/{id}/in_servers",
15131 "title": "Removes IMAP server from an account",
15134 "title": "Example usage:",
15135 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15139 "name": "RemoveImmap",
15140 "group": "Mail_Accounts",
15141 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15142 "version": "0.0.0",
15143 "filename": "server/api/mailAccount/index.js",
15144 "groupTitle": "Mail_Accounts"
15148 "url": "/api/mail/accounts/{id}/out_servers",
15149 "title": "Removes SMTP server from an account",
15152 "title": "Example usage:",
15153 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15157 "name": "RemoveSmtp",
15158 "group": "Mail_Accounts",
15159 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15160 "version": "0.0.0",
15161 "filename": "server/api/mailAccount/index.js",
15162 "groupTitle": "Mail_Accounts"
15166 "url": "/api/mail/accounts/{id}",
15167 "title": "Gets a single Account",
15170 "title": "Example usage:",
15171 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15175 "name": "ShowAccounts",
15176 "group": "Mail_Accounts",
15177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15178 "version": "0.0.0",
15179 "filename": "server/api/mailAccount/index.js",
15180 "groupTitle": "Mail_Accounts"
15184 "url": "/api/mail/accounts/{id}/canned_answers",
15185 "title": "Creates new canned answer",
15188 "title": "Example usage:",
15189 "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",
15193 "name": "addAnswer",
15194 "group": "Mail_Accounts",
15216 "field": "description",
15229 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15230 "version": "0.0.0",
15231 "filename": "server/api/mailAccount/index.js",
15232 "groupTitle": "Mail_Accounts"
15236 "url": "/api/mail/accounts/{id}/applications",
15237 "title": "Creates new applications",
15240 "title": "Example usage:",
15241 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15245 "name": "addApplications",
15246 "group": "Mail_Accounts",
15254 "field": "priority",
15268 "field": "appdata",
15275 "field": "description",
15282 "field": "interval",
15288 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15289 "version": "0.0.0",
15290 "filename": "server/api/mailAccount/index.js",
15291 "groupTitle": "Mail_Accounts"
15295 "url": "/api/mail/accounts/{id}/dispositions",
15296 "title": "Creates new disposition",
15299 "title": "Example usage:",
15300 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15304 "name": "addDisposition",
15305 "group": "Mail_Accounts",
15332 "field": "description",
15338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15339 "version": "0.0.0",
15340 "filename": "server/api/mailAccount/index.js",
15341 "groupTitle": "Mail_Accounts"
15345 "url": "/api/mail/accounts/{id}/interactions",
15346 "title": "Creates new interactions",
15349 "title": "Example usage:",
15350 "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",
15354 "name": "addInteraction",
15355 "group": "Mail_Accounts",
15370 "field": "closedAt",
15377 "field": "disposition",
15384 "field": "secondDisposition",
15391 "field": "thirdDisposition",
15405 "field": "inReplyTo",
15426 "field": "subject",
15440 "field": "read1stAt",
15447 "field": "substatus",
15454 "field": "substatusAt",
15465 "field": "firstMsgDirection",
15472 "field": "lastMsgAt",
15483 "field": "lastMsgDirection",
15490 "field": "autoreplyExecuted",
15496 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15497 "version": "0.0.0",
15498 "filename": "server/api/mailAccount/index.js",
15499 "groupTitle": "Mail_Accounts"
15503 "url": "/api/mail/accounts",
15504 "title": "Create a mail account",
15507 "title": "Example usage:",
15508 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15513 "group": "Mail_Accounts",
15514 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15515 "version": "0.0.0",
15516 "filename": "server/api/mailAccount/index.js",
15517 "groupTitle": "Mail_Accounts"
15521 "url": "/api/mail/accounts/{id}/canned_answers",
15522 "title": "Gets account canned answers",
15525 "title": "Example usage:",
15526 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15530 "name": "getAnswers",
15531 "group": "Mail_Accounts",
15532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15533 "version": "0.0.0",
15534 "filename": "server/api/mailAccount/index.js",
15535 "groupTitle": "Mail_Accounts"
15539 "url": "/api/mail/accounts/{id}/applications",
15540 "title": "Gets account applications",
15543 "title": "Example usage:",
15544 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15548 "name": "getApplications",
15549 "group": "Mail_Accounts",
15550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15551 "version": "0.0.0",
15552 "filename": "server/api/mailAccount/index.js",
15553 "groupTitle": "Mail_Accounts"
15557 "url": "/api/mail/accounts/{id}/dispositions",
15558 "title": "Gets account dispositions",
15561 "title": "Example usage:",
15562 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15566 "name": "getDispositions",
15567 "group": "Mail_Accounts",
15568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15569 "version": "0.0.0",
15570 "filename": "server/api/mailAccount/index.js",
15571 "groupTitle": "Mail_Accounts"
15575 "url": "/api/mail/accounts/{id}/interactions",
15576 "title": "Gets account interactions",
15579 "title": "Example usage:",
15580 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15584 "name": "getInteraction",
15585 "group": "Mail_Accounts",
15586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15587 "version": "0.0.0",
15588 "filename": "server/api/mailAccount/index.js",
15589 "groupTitle": "Mail_Accounts"
15593 "url": "/api/mail/accounts/{id}/messages",
15594 "title": "Gets account messages",
15597 "title": "Example usage:",
15598 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15602 "name": "getMessages",
15603 "group": "Mail_Accounts",
15604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15605 "version": "0.0.0",
15606 "filename": "server/api/mailAccount/index.js",
15607 "groupTitle": "Mail_Accounts"
15611 "url": "/api/mail/accounts/{id}/send",
15612 "title": "Send new mail",
15615 "title": "Example usage:",
15616 "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",
15620 "name": "sendMail",
15621 "group": "Mail_Accounts",
15622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15623 "version": "0.0.0",
15624 "filename": "server/api/mailAccount/index.js",
15625 "groupTitle": "Mail_Accounts"
15629 "url": "/api/mail/accounts/{id}",
15630 "title": "Update an existing Account",
15633 "title": "Example usage:",
15634 "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",
15638 "name": "updateAccounts",
15639 "group": "Mail_Accounts",
15640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15641 "version": "0.0.0",
15642 "filename": "server/api/mailAccount/index.js",
15643 "groupTitle": "Mail_Accounts"
15647 "url": "/api/mail/accounts/{id}/verify",
15648 "title": "Verify mail account",
15651 "title": "Example usage:",
15652 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15656 "name": "verifySmtp",
15657 "group": "Mail_Accounts",
15658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15659 "version": "0.0.0",
15660 "filename": "server/api/mailAccount/index.js",
15661 "groupTitle": "Mail_Accounts"
15665 "url": "/api/mail/applications/{id}",
15666 "title": "Deletes a Application",
15669 "title": "Example usage:",
15670 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15674 "name": "DeleteApplications",
15675 "group": "Mail_Applications",
15676 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15677 "version": "0.0.0",
15678 "filename": "server/api/mailApplication/index.js",
15679 "groupTitle": "Mail_Applications"
15683 "url": "/api/mail/applications/{id}",
15684 "title": "Gets a single Application",
15687 "title": "Example usage:",
15688 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15692 "name": "ShowApplications",
15693 "group": "Mail_Applications",
15694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15695 "version": "0.0.0",
15696 "filename": "server/api/mailApplication/index.js",
15697 "groupTitle": "Mail_Applications"
15701 "url": "/api/mail/applications/{id}",
15702 "title": "Update an existing Application",
15705 "title": "Example usage:",
15706 "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",
15710 "name": "updateApplications",
15711 "group": "Mail_Applications",
15712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15713 "version": "0.0.0",
15714 "filename": "server/api/mailApplication/index.js",
15715 "groupTitle": "Mail_Applications"
15719 "url": "/api/mail/interactions/{id}/tags",
15720 "title": "Add tags to the interaction",
15723 "title": "Example usage:",
15724 "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",
15729 "group": "Mail_Interactions",
15730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15731 "version": "0.0.0",
15732 "filename": "server/api/mailInteraction/index.js",
15733 "groupTitle": "Mail_Interactions"
15737 "url": "/api/mail/interactions",
15738 "title": "Creates a new Interaction",
15741 "title": "Example usage:",
15742 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15746 "name": "CreateInteractions",
15747 "group": "Mail_Interactions",
15762 "field": "closedAt",
15769 "field": "disposition",
15776 "field": "secondDisposition",
15783 "field": "thirdDisposition",
15797 "field": "inReplyTo",
15818 "field": "subject",
15832 "field": "read1stAt",
15839 "field": "substatus",
15846 "field": "substatusAt",
15857 "field": "firstMsgDirection",
15864 "field": "lastMsgAt",
15875 "field": "lastMsgDirection",
15882 "field": "autoreplyExecuted",
15888 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15889 "version": "0.0.0",
15890 "filename": "server/api/mailInteraction/index.js",
15891 "groupTitle": "Mail_Interactions"
15895 "url": "/api/mail/interactions/{id}",
15896 "title": "Deletes a Interaction",
15899 "title": "Example usage:",
15900 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15904 "name": "DeleteInteractions",
15905 "group": "Mail_Interactions",
15906 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15907 "version": "0.0.0",
15908 "filename": "server/api/mailInteraction/index.js",
15909 "groupTitle": "Mail_Interactions"
15913 "url": "/api/mail/interactions/describe",
15914 "title": "Gets table info about Interactions",
15917 "title": "Example usage:",
15918 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15922 "name": "DescribeInteractions",
15923 "group": "Mail_Interactions",
15924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15925 "version": "0.0.0",
15926 "filename": "server/api/mailInteraction/index.js",
15927 "groupTitle": "Mail_Interactions"
15931 "url": "/api/mail/interactions",
15932 "title": "Gets a list of Interactions",
15935 "title": "Example usage:",
15936 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15940 "name": "GetInteractions",
15941 "group": "Mail_Interactions",
15942 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15943 "version": "0.0.0",
15944 "filename": "server/api/mailInteraction/index.js",
15945 "groupTitle": "Mail_Interactions"
15949 "url": "/api/mail/interactions/{id}/tags",
15950 "title": "Removes tags from interaction",
15953 "title": "Example usage:",
15954 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15958 "name": "RemoveTags",
15959 "group": "Mail_Interactions",
15960 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15961 "version": "0.0.0",
15962 "filename": "server/api/mailInteraction/index.js",
15963 "groupTitle": "Mail_Interactions"
15967 "url": "/api/mail/interactions/{id}",
15968 "title": "Gets a single Interaction",
15971 "title": "Example usage:",
15972 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15976 "name": "ShowInteractions",
15977 "group": "Mail_Interactions",
15978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15979 "version": "0.0.0",
15980 "filename": "server/api/mailInteraction/index.js",
15981 "groupTitle": "Mail_Interactions"
15985 "url": "/api/mail/interactions/{id}/messages",
15986 "title": "Creates new message",
15989 "title": "Example usage:",
15990 "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",
15994 "name": "addMessage",
15995 "group": "Mail_Interactions",
16010 "field": "plainBody",
16028 "field": "direction",
16035 "field": "messageId",
16070 "field": "subject",
16105 "field": "originTo",
16112 "field": "originCc",
16123 "field": "originChannel",
16129 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16130 "version": "0.0.0",
16131 "filename": "server/api/mailInteraction/index.js",
16132 "groupTitle": "Mail_Interactions"
16136 "url": "/api/mail/interactions/{id}/download",
16137 "title": "Gets interaction",
16140 "title": "Example usage:",
16141 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16145 "name": "download",
16146 "group": "Mail_Interactions",
16147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16148 "version": "0.0.0",
16149 "filename": "server/api/mailInteraction/index.js",
16150 "groupTitle": "Mail_Interactions"
16154 "url": "/api/mail/interactions/{id}/messages",
16155 "title": "Gets interaction messages",
16158 "title": "Example usage:",
16159 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16163 "name": "getMessages",
16164 "group": "Mail_Interactions",
16165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16166 "version": "0.0.0",
16167 "filename": "server/api/mailInteraction/index.js",
16168 "groupTitle": "Mail_Interactions"
16172 "url": "/api/mail/interactions/{id}",
16173 "title": "Update an existing Interaction",
16176 "title": "Example usage:",
16177 "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",
16181 "name": "updateInteractions",
16182 "group": "Mail_Interactions",
16183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16184 "version": "0.0.0",
16185 "filename": "server/api/mailInteraction/index.js",
16186 "groupTitle": "Mail_Interactions"
16190 "url": "/api/mail/messages/{id}",
16191 "title": "Deletes a Message",
16194 "title": "Example usage:",
16195 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16199 "name": "DeleteMessages",
16200 "group": "Mail_Messages",
16201 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16202 "version": "0.0.0",
16203 "filename": "server/api/mailMessage/index.js",
16204 "groupTitle": "Mail_Messages"
16208 "url": "/api/mail/messages/describe",
16209 "title": "Gets table info about Messages",
16212 "title": "Example usage:",
16213 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16217 "name": "DescribeMessages",
16218 "group": "Mail_Messages",
16219 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16220 "version": "0.0.0",
16221 "filename": "server/api/mailMessage/index.js",
16222 "groupTitle": "Mail_Messages"
16226 "url": "/api/mail/messages",
16227 "title": "Gets a list of Messages",
16230 "title": "Example usage:",
16231 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16235 "name": "GetMessages",
16236 "group": "Mail_Messages",
16237 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16238 "version": "0.0.0",
16239 "filename": "server/api/mailMessage/index.js",
16240 "groupTitle": "Mail_Messages"
16244 "url": "/api/mail/messages/{id}",
16245 "title": "Gets a single Message",
16248 "title": "Example usage:",
16249 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16253 "name": "ShowMessages",
16254 "group": "Mail_Messages",
16255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16256 "version": "0.0.0",
16257 "filename": "server/api/mailMessage/index.js",
16258 "groupTitle": "Mail_Messages"
16262 "url": "/api/mail/messages/{id}/accept",
16263 "title": "Accepts message",
16266 "title": "Example usage:",
16267 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16271 "name": "acceptMessage",
16272 "group": "Mail_Messages",
16273 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16274 "version": "0.0.0",
16275 "filename": "server/api/mailMessage/index.js",
16276 "groupTitle": "Mail_Messages"
16280 "url": "/api/mail/messages",
16281 "title": "Create a message",
16284 "title": "Example usage:",
16285 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16289 "name": "createMessage",
16290 "group": "Mail_Messages",
16291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16292 "version": "0.0.0",
16293 "filename": "server/api/mailMessage/index.js",
16294 "groupTitle": "Mail_Messages"
16298 "url": "/api/mail/messages/{id}/download",
16299 "title": "Gets message",
16302 "title": "Example usage:",
16303 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16307 "name": "download",
16308 "group": "Mail_Messages",
16309 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16310 "version": "0.0.0",
16311 "filename": "server/api/mailMessage/index.js",
16312 "groupTitle": "Mail_Messages"
16316 "url": "/api/mail/messages/{id}/reject",
16317 "title": "Rejects message",
16320 "title": "Example usage:",
16321 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16325 "name": "rejectMessage",
16326 "group": "Mail_Messages",
16327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16328 "version": "0.0.0",
16329 "filename": "server/api/mailMessage/index.js",
16330 "groupTitle": "Mail_Messages"
16334 "url": "/api/mail/messages/{id}",
16335 "title": "Update an existing Message",
16338 "title": "Example usage:",
16339 "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",
16343 "name": "updateMessages",
16344 "group": "Mail_Messages",
16345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16346 "version": "0.0.0",
16347 "filename": "server/api/mailMessage/index.js",
16348 "groupTitle": "Mail_Messages"
16352 "url": "/api/mail/reports/queue",
16353 "title": "Creates a new Mail Queue Report",
16356 "title": "Example usage:",
16357 "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",
16361 "name": "CreateMail_Queue_Reports",
16362 "group": "Mail_Queue_Reports",
16370 "field": "uniqueid",
16391 "field": "leaveAt",
16398 "field": "acceptAt",
16418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16419 "version": "0.0.0",
16420 "filename": "server/api/mailQueueReport/index.js",
16421 "groupTitle": "Mail_Queue_Reports"
16425 "url": "/api/mail/reports/queue/{id}",
16426 "title": "Deletes a Mail Queue Report",
16429 "title": "Example usage:",
16430 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16434 "name": "DeleteMail_Queue_Reports",
16435 "group": "Mail_Queue_Reports",
16436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16437 "version": "0.0.0",
16438 "filename": "server/api/mailQueueReport/index.js",
16439 "groupTitle": "Mail_Queue_Reports"
16443 "url": "/api/mail/reports/queue/describe",
16444 "title": "Gets table info about Mail Queue Reports",
16447 "title": "Example usage:",
16448 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16452 "name": "DescribeMail_Queue_Reports",
16453 "group": "Mail_Queue_Reports",
16454 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16455 "version": "0.0.0",
16456 "filename": "server/api/mailQueueReport/index.js",
16457 "groupTitle": "Mail_Queue_Reports"
16461 "url": "/api/mail/reports/queue",
16462 "title": "Gets a list of Mail Queue Reports",
16465 "title": "Example usage:",
16466 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16470 "name": "GetMail_Queue_Reports",
16471 "group": "Mail_Queue_Reports",
16472 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16473 "version": "0.0.0",
16474 "filename": "server/api/mailQueueReport/index.js",
16475 "groupTitle": "Mail_Queue_Reports"
16479 "url": "/api/mail/reports/queue/{id}",
16480 "title": "Gets a single Mail Queue Report",
16483 "title": "Example usage:",
16484 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16488 "name": "ShowMail_Queue_Reports",
16489 "group": "Mail_Queue_Reports",
16490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16491 "version": "0.0.0",
16492 "filename": "server/api/mailQueueReport/index.js",
16493 "groupTitle": "Mail_Queue_Reports"
16497 "url": "/api/mail/reports/queue/{id}",
16498 "title": "Update an existing Mail Queue Report",
16501 "title": "Example usage:",
16502 "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",
16506 "name": "updateMail_Queue_Reports",
16507 "group": "Mail_Queue_Reports",
16508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16509 "version": "0.0.0",
16510 "filename": "server/api/mailQueueReport/index.js",
16511 "groupTitle": "Mail_Queue_Reports"
16515 "url": "/api/mail/queues/{id}/users",
16516 "title": "Add agents to a queue",
16519 "title": "Example usage:",
16520 "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",
16524 "name": "AddAgents",
16525 "group": "Mail_Queues",
16526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16527 "version": "0.0.0",
16528 "filename": "server/api/mailQueue/index.js",
16529 "groupTitle": "Mail_Queues"
16533 "url": "/api/mail/queues/{id}/teams",
16534 "title": "Add teams to a queue",
16537 "title": "Example usage:",
16538 "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",
16542 "name": "AddTeams",
16543 "group": "Mail_Queues",
16544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16545 "version": "0.0.0",
16546 "filename": "server/api/mailQueue/index.js",
16547 "groupTitle": "Mail_Queues"
16551 "url": "/api/mail/queues",
16552 "title": "Creates a new Queue",
16555 "title": "Example usage:",
16556 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16560 "name": "CreateQueues",
16561 "group": "Mail_Queues",
16576 "field": "description",
16583 "field": "timeout",
16595 "field": "strategy",
16601 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16602 "version": "0.0.0",
16603 "filename": "server/api/mailQueue/index.js",
16604 "groupTitle": "Mail_Queues"
16608 "url": "/api/mail/queues/{id}",
16609 "title": "Deletes a Queue",
16612 "title": "Example usage:",
16613 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16617 "name": "DeleteQueues",
16618 "group": "Mail_Queues",
16619 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16620 "version": "0.0.0",
16621 "filename": "server/api/mailQueue/index.js",
16622 "groupTitle": "Mail_Queues"
16626 "url": "/api/mail/queues/describe",
16627 "title": "Gets table info about Queues",
16630 "title": "Example usage:",
16631 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16635 "name": "DescribeQueues",
16636 "group": "Mail_Queues",
16637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16638 "version": "0.0.0",
16639 "filename": "server/api/mailQueue/index.js",
16640 "groupTitle": "Mail_Queues"
16644 "url": "/api/mail/queues/{id}/users",
16645 "title": "Gets queue agents",
16648 "title": "Example usage:",
16649 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16653 "name": "GetAgents",
16654 "group": "Mail_Queues",
16655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16656 "version": "0.0.0",
16657 "filename": "server/api/mailQueue/index.js",
16658 "groupTitle": "Mail_Queues"
16662 "url": "/api/mail/queues/{id}/members",
16663 "title": "GetMembers",
16666 "title": "Example usage:",
16667 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16671 "name": "GetMembers",
16672 "group": "Mail_Queues",
16673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16674 "version": "0.0.0",
16675 "filename": "server/api/mailQueue/index.js",
16676 "groupTitle": "Mail_Queues"
16680 "url": "/api/mail/queues",
16681 "title": "Gets a list of Queues",
16684 "title": "Example usage:",
16685 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16689 "name": "GetQueues",
16690 "group": "Mail_Queues",
16691 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16692 "version": "0.0.0",
16693 "filename": "server/api/mailQueue/index.js",
16694 "groupTitle": "Mail_Queues"
16698 "url": "/api/mail/queues/{id}/teams",
16699 "title": "Gets queues list",
16702 "title": "Example usage:",
16703 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16707 "name": "GetTeams",
16708 "group": "Mail_Queues",
16709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16710 "version": "0.0.0",
16711 "filename": "server/api/mailQueue/index.js",
16712 "groupTitle": "Mail_Queues"
16716 "url": "/api/mail/queues/{id}/users",
16717 "title": "Removes agents from a queue",
16720 "title": "Example usage:",
16721 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16725 "name": "RemoveAgents",
16726 "group": "Mail_Queues",
16727 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16728 "version": "0.0.0",
16729 "filename": "server/api/mailQueue/index.js",
16730 "groupTitle": "Mail_Queues"
16734 "url": "/api/mail/queues/{id}",
16735 "title": "Gets a single Queue",
16738 "title": "Example usage:",
16739 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16743 "name": "ShowQueues",
16744 "group": "Mail_Queues",
16745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16746 "version": "0.0.0",
16747 "filename": "server/api/mailQueue/index.js",
16748 "groupTitle": "Mail_Queues"
16752 "url": "/api/mail/queues/{id}",
16753 "title": "Update an existing Queue",
16756 "title": "Example usage:",
16757 "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",
16761 "name": "updateQueues",
16762 "group": "Mail_Queues",
16763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16764 "version": "0.0.0",
16765 "filename": "server/api/mailQueue/index.js",
16766 "groupTitle": "Mail_Queues"
16770 "url": "/api/mail/out_servers",
16771 "title": "Creates a new SMTP",
16774 "title": "Example usage:",
16775 "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",
16779 "name": "CreateSMTPs",
16780 "group": "Mail_SMTP",
16788 "field": "description",
16830 "field": "service",
16837 "field": "authentication",
16843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16844 "version": "0.0.0",
16845 "filename": "server/api/mailServerOut/index.js",
16846 "groupTitle": "Mail_SMTP"
16850 "url": "/api/mail/out_servers/{id}",
16851 "title": "Deletes a SMTP",
16854 "title": "Example usage:",
16855 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16859 "name": "DeleteSMTPs",
16860 "group": "Mail_SMTP",
16861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16862 "version": "0.0.0",
16863 "filename": "server/api/mailServerOut/index.js",
16864 "groupTitle": "Mail_SMTP"
16868 "url": "/api/mail/out_servers",
16869 "title": "Gets a list of SMTPs",
16872 "title": "Example usage:",
16873 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16877 "name": "GetSMTPs",
16878 "group": "Mail_SMTP",
16879 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16880 "version": "0.0.0",
16881 "filename": "server/api/mailServerOut/index.js",
16882 "groupTitle": "Mail_SMTP"
16886 "url": "/api/mail/out_servers/{id}",
16887 "title": "Gets a single SMTP",
16890 "title": "Example usage:",
16891 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16895 "name": "ShowSMTPs",
16896 "group": "Mail_SMTP",
16897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16898 "version": "0.0.0",
16899 "filename": "server/api/mailServerOut/index.js",
16900 "groupTitle": "Mail_SMTP"
16904 "url": "/api/mail/out_servers/{id}",
16905 "title": "Update an existing SMTP",
16908 "title": "Example usage:",
16909 "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",
16913 "name": "updateSMTPs",
16914 "group": "Mail_SMTP",
16915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16916 "version": "0.0.0",
16917 "filename": "server/api/mailServerOut/index.js",
16918 "groupTitle": "Mail_SMTP"
16922 "url": "/api/mail/substatuses",
16923 "title": "Creates a new Queue",
16926 "title": "Example usage:",
16927 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16931 "name": "CreateSubstatuses",
16932 "group": "Mail_Substatuses",
16947 "field": "description",
16953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16954 "version": "0.0.0",
16955 "filename": "server/api/mailSubstatus/index.js",
16956 "groupTitle": "Mail_Substatuses"
16960 "url": "/api/mail/substatuses/{id}",
16961 "title": "Deletes a Queue",
16964 "title": "Example usage:",
16965 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16969 "name": "DeleteSubstatuses",
16970 "group": "Mail_Substatuses",
16971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16972 "version": "0.0.0",
16973 "filename": "server/api/mailSubstatus/index.js",
16974 "groupTitle": "Mail_Substatuses"
16978 "url": "/api/mail/substatuses/describe",
16979 "title": "Gets table info about Substatuses",
16982 "title": "Example usage:",
16983 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16987 "name": "DescribeSubstatuses",
16988 "group": "Mail_Substatuses",
16989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16990 "version": "0.0.0",
16991 "filename": "server/api/mailSubstatus/index.js",
16992 "groupTitle": "Mail_Substatuses"
16996 "url": "/api/mail/substatuses",
16997 "title": "Gets a list of Substatuses",
17000 "title": "Example usage:",
17001 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17005 "name": "GetSubstatuses",
17006 "group": "Mail_Substatuses",
17007 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17008 "version": "0.0.0",
17009 "filename": "server/api/mailSubstatus/index.js",
17010 "groupTitle": "Mail_Substatuses"
17014 "url": "/api/mail/substatuses/{id}",
17015 "title": "Gets a single Queue",
17018 "title": "Example usage:",
17019 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17023 "name": "ShowSubstatuses",
17024 "group": "Mail_Substatuses",
17025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17026 "version": "0.0.0",
17027 "filename": "server/api/mailSubstatus/index.js",
17028 "groupTitle": "Mail_Substatuses"
17032 "url": "/api/mail/substatuses/{id}",
17033 "title": "Update an existing Queue",
17036 "title": "Example usage:",
17037 "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",
17041 "name": "updateSubstatuses",
17042 "group": "Mail_Substatuses",
17043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17044 "version": "0.0.0",
17045 "filename": "server/api/mailSubstatus/index.js",
17046 "groupTitle": "Mail_Substatuses"
17050 "url": "/api/mail/reports/transfer",
17051 "title": "Creates a new Mail Transfer Report",
17054 "title": "Example usage:",
17055 "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",
17059 "name": "CreateMail_Transfer_Reports",
17060 "group": "Mail_Transfer_Reports",
17068 "field": "uniqueid",
17087 "field": "transferredAt",
17093 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17094 "version": "0.0.0",
17095 "filename": "server/api/mailTransferReport/index.js",
17096 "groupTitle": "Mail_Transfer_Reports"
17100 "url": "/api/mail/reports/transfer/{id}",
17101 "title": "Deletes a Mail Transfer Report",
17104 "title": "Example usage:",
17105 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17109 "name": "DeleteMail_Transfer_Reports",
17110 "group": "Mail_Transfer_Reports",
17111 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17112 "version": "0.0.0",
17113 "filename": "server/api/mailTransferReport/index.js",
17114 "groupTitle": "Mail_Transfer_Reports"
17118 "url": "/api/mail/reports/transfer/describe",
17119 "title": "Gets table info about Mail Transfer Reports",
17122 "title": "Example usage:",
17123 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17127 "name": "DescribeMail_Transfer_Reports",
17128 "group": "Mail_Transfer_Reports",
17129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17130 "version": "0.0.0",
17131 "filename": "server/api/mailTransferReport/index.js",
17132 "groupTitle": "Mail_Transfer_Reports"
17136 "url": "/api/mail/reports/transfer",
17137 "title": "Gets a list of Mail Transfer Reports",
17140 "title": "Example usage:",
17141 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17145 "name": "GetMail_Transfer_Reports",
17146 "group": "Mail_Transfer_Reports",
17147 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17148 "version": "0.0.0",
17149 "filename": "server/api/mailTransferReport/index.js",
17150 "groupTitle": "Mail_Transfer_Reports"
17154 "url": "/api/mail/reports/transfer/{id}",
17155 "title": "Gets a single Mail Transfer Report",
17158 "title": "Example usage:",
17159 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17163 "name": "ShowMail_Transfer_Reports",
17164 "group": "Mail_Transfer_Reports",
17165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17166 "version": "0.0.0",
17167 "filename": "server/api/mailTransferReport/index.js",
17168 "groupTitle": "Mail_Transfer_Reports"
17172 "url": "/api/mail/reports/transfer/{id}",
17173 "title": "Update an existing Mail Transfer Report",
17176 "title": "Example usage:",
17177 "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",
17181 "name": "updateMail_Transfer_Reports",
17182 "group": "Mail_Transfer_Reports",
17183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17184 "version": "0.0.0",
17185 "filename": "server/api/mailTransferReport/index.js",
17186 "groupTitle": "Mail_Transfer_Reports"
17190 "url": "/api/members/reports/describe",
17191 "title": "Gets table info about Member Reports",
17194 "title": "Example usage:",
17195 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17199 "name": "DescribeMember_Reports",
17200 "group": "Member_Reports",
17201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17202 "version": "0.0.0",
17203 "filename": "server/api/memberReport/index.js",
17204 "groupTitle": "Member_Reports"
17208 "url": "/api/members/reports",
17209 "title": "Gets a list of Member Reports",
17212 "title": "Example usage:",
17213 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17217 "name": "GetMember_Reports",
17218 "group": "Member_Reports",
17219 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17220 "version": "0.0.0",
17221 "filename": "server/api/memberReport/index.js",
17222 "groupTitle": "Member_Reports"
17226 "url": "/api/members/reports/{id}",
17227 "title": "Gets a single Member Report",
17230 "title": "Example usage:",
17231 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17235 "name": "ShowMember_Reports",
17236 "group": "Member_Reports",
17237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17238 "version": "0.0.0",
17239 "filename": "server/api/memberReport/index.js",
17240 "groupTitle": "Member_Reports"
17244 "url": "/api/migrations",
17245 "title": "Gets a list of Migrations",
17248 "title": "Example usage:",
17249 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17253 "name": "GetMigrations",
17254 "group": "Migrations",
17255 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17256 "version": "0.0.0",
17257 "filename": "server/api/migration/index.js",
17258 "groupTitle": "Migrations"
17262 "url": "/api/voice/networks",
17263 "title": "Create a new network",
17266 "title": "Example usage:",
17267 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17272 "group": "Networks",
17273 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17274 "version": "0.0.0",
17275 "filename": "server/api/network/index.js",
17276 "groupTitle": "Networks"
17280 "url": "/api/voice/networks/{id}",
17281 "title": "Deletes a network",
17284 "title": "Example usage:",
17285 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17290 "group": "Networks",
17291 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17292 "version": "0.0.0",
17293 "filename": "server/api/network/index.js",
17294 "groupTitle": "Networks"
17298 "url": "/api/networks",
17299 "title": "Gets a list of Networks",
17302 "title": "Example usage:",
17303 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17307 "name": "GetNetworks",
17308 "group": "Networks",
17309 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17310 "version": "0.0.0",
17311 "filename": "server/api/network/index.js",
17312 "groupTitle": "Networks"
17316 "url": "/api/networks/{id}",
17317 "title": "Gets a single Network",
17320 "title": "Example usage:",
17321 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17325 "name": "ShowNetworks",
17326 "group": "Networks",
17327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17328 "version": "0.0.0",
17329 "filename": "server/api/network/index.js",
17330 "groupTitle": "Networks"
17334 "url": "/api/voice/networks/{id}",
17335 "title": "Update an existing network",
17338 "title": "Example usage:",
17339 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17344 "group": "Networks",
17345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17346 "version": "0.0.0",
17347 "filename": "server/api/network/index.js",
17348 "groupTitle": "Networks"
17352 "url": "/api/openchannel/accounts/{id}/users",
17353 "title": "Add agents to a openchannel account",
17356 "title": "Example usage:",
17357 "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",
17361 "name": "AddAgents",
17362 "group": "Openchannel_Accounts",
17363 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17364 "version": "0.0.0",
17365 "filename": "server/api/openchannelAccount/index.js",
17366 "groupTitle": "Openchannel_Accounts"
17370 "url": "/api/openchannel/accounts",
17371 "title": "Creates a new Account",
17374 "title": "Example usage:",
17375 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17379 "name": "CreateAccounts",
17380 "group": "Openchannel_Accounts",
17395 "field": "description",
17409 "field": "replyUri",
17423 "field": "notificationTemplate",
17430 "field": "notificationSound",
17437 "field": "notificationShake",
17444 "field": "waitForTheAssignedAgent",
17458 "field": "queueTransfer",
17465 "field": "queueTransferTimeout",
17472 "field": "agentTransfer",
17479 "field": "agentTransferTimeout",
17486 "field": "mandatoryDispositionPauseId",
17487 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17493 "field": "mandatoryDisposition",
17494 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17500 "version": "0.0.0",
17501 "filename": "server/api/openchannelAccount/index.js",
17502 "groupTitle": "Openchannel_Accounts"
17506 "url": "/api/openchannel/accounts/{id}",
17507 "title": "Deletes a Account",
17510 "title": "Example usage:",
17511 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17515 "name": "DeleteAccounts",
17516 "group": "Openchannel_Accounts",
17517 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17518 "version": "0.0.0",
17519 "filename": "server/api/openchannelAccount/index.js",
17520 "groupTitle": "Openchannel_Accounts"
17524 "url": "/api/openchannel/accounts/describe",
17525 "title": "Gets table info about Accounts",
17528 "title": "Example usage:",
17529 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17533 "name": "DescribeAccounts",
17534 "group": "Openchannel_Accounts",
17535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17536 "version": "0.0.0",
17537 "filename": "server/api/openchannelAccount/index.js",
17538 "groupTitle": "Openchannel_Accounts"
17542 "url": "/api/openchannel/accounts",
17543 "title": "Gets a list of Accounts",
17546 "title": "Example usage:",
17547 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17551 "name": "GetAccounts",
17552 "group": "Openchannel_Accounts",
17553 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17554 "version": "0.0.0",
17555 "filename": "server/api/openchannelAccount/index.js",
17556 "groupTitle": "Openchannel_Accounts"
17560 "url": "/api/openchannel/accounts/{id}/users",
17561 "title": "Gets agents from openchannel account",
17564 "title": "Example usage:",
17565 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17569 "name": "GetAgents",
17570 "group": "Openchannel_Accounts",
17571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17572 "version": "0.0.0",
17573 "filename": "server/api/openchannelAccount/index.js",
17574 "groupTitle": "Openchannel_Accounts"
17578 "url": "/api/openchannel/accounts/{id}/users",
17579 "title": "Removes agents from a openchannel account",
17582 "title": "Example usage:",
17583 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17587 "name": "RemoveAgents",
17588 "group": "Openchannel_Accounts",
17589 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17590 "version": "0.0.0",
17591 "filename": "server/api/openchannelAccount/index.js",
17592 "groupTitle": "Openchannel_Accounts"
17596 "url": "/api/openchannel/accounts/{id}/canned_answers",
17597 "title": "Removes canned answers from account",
17600 "title": "Example usage:",
17601 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17605 "name": "RemoveAnswers",
17606 "group": "Openchannel_Accounts",
17607 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17608 "version": "0.0.0",
17609 "filename": "server/api/openchannelAccount/index.js",
17610 "groupTitle": "Openchannel_Accounts"
17614 "url": "/api/openchannel/accounts/{id}/dispositions",
17615 "title": "Removes dispositions from account",
17618 "title": "Example usage:",
17619 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17623 "name": "RemoveDispositions",
17624 "group": "Openchannel_Accounts",
17625 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17626 "version": "0.0.0",
17627 "filename": "server/api/openchannelAccount/index.js",
17628 "groupTitle": "Openchannel_Accounts"
17632 "url": "/api/openchannel/accounts/{id}",
17633 "title": "Gets a single Account",
17636 "title": "Example usage:",
17637 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17641 "name": "ShowAccounts",
17642 "group": "Openchannel_Accounts",
17643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17644 "version": "0.0.0",
17645 "filename": "server/api/openchannelAccount/index.js",
17646 "groupTitle": "Openchannel_Accounts"
17650 "url": "/api/openchannel/accounts/{id}/canned_answers",
17651 "title": "Creates new canned answer",
17654 "title": "Example usage:",
17655 "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",
17659 "name": "addAnswer",
17660 "group": "Openchannel_Accounts",
17682 "field": "description",
17695 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17696 "version": "0.0.0",
17697 "filename": "server/api/openchannelAccount/index.js",
17698 "groupTitle": "Openchannel_Accounts"
17702 "url": "/api/openchannel/accounts/{id}/applications",
17703 "title": "Creates new applications",
17706 "title": "Example usage:",
17707 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17711 "name": "addApplications",
17712 "group": "Openchannel_Accounts",
17720 "field": "priority",
17734 "field": "appdata",
17741 "field": "description",
17748 "field": "interval",
17754 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17755 "version": "0.0.0",
17756 "filename": "server/api/openchannelAccount/index.js",
17757 "groupTitle": "Openchannel_Accounts"
17761 "url": "/api/openchannel/accounts/{id}/dispositions",
17762 "title": "Creates new disposition",
17765 "title": "Example usage:",
17766 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17770 "name": "addDisposition",
17771 "group": "Openchannel_Accounts",
17798 "field": "description",
17804 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17805 "version": "0.0.0",
17806 "filename": "server/api/openchannelAccount/index.js",
17807 "groupTitle": "Openchannel_Accounts"
17811 "url": "/api/openchannel/accounts/{id}/canned_answers",
17812 "title": "Gets account canned answers",
17815 "title": "Example usage:",
17816 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17820 "name": "getAnswers",
17821 "group": "Openchannel_Accounts",
17822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17823 "version": "0.0.0",
17824 "filename": "server/api/openchannelAccount/index.js",
17825 "groupTitle": "Openchannel_Accounts"
17829 "url": "/api/openchannel/accounts/{id}/applications",
17830 "title": "Gets account applications",
17833 "title": "Example usage:",
17834 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17838 "name": "getApplications",
17839 "group": "Openchannel_Accounts",
17840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17841 "version": "0.0.0",
17842 "filename": "server/api/openchannelAccount/index.js",
17843 "groupTitle": "Openchannel_Accounts"
17847 "url": "/api/openchannel/accounts/{id}/dispositions",
17848 "title": "Gets account dispositions",
17851 "title": "Example usage:",
17852 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17856 "name": "getDispositions",
17857 "group": "Openchannel_Accounts",
17858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17859 "version": "0.0.0",
17860 "filename": "server/api/openchannelAccount/index.js",
17861 "groupTitle": "Openchannel_Accounts"
17865 "url": "/api/openchannel/accounts/{id}/interactions",
17866 "title": "Gets Openchannel Account Interactions",
17869 "title": "Example usage:",
17870 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17874 "name": "getInteractions",
17875 "group": "Openchannel_Accounts",
17876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17877 "version": "0.0.0",
17878 "filename": "server/api/openchannelAccount/index.js",
17879 "groupTitle": "Openchannel_Accounts"
17883 "url": "/api/openchannel/accounts/{id}/notify",
17884 "title": "Notify new message",
17887 "title": "Example usage:",
17888 "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",
17893 "group": "Openchannel_Accounts",
17894 "description": "<p>Motion 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>",
17895 "version": "0.0.0",
17896 "filename": "server/api/openchannelAccount/index.js",
17897 "groupTitle": "Openchannel_Accounts"
17901 "url": "/api/openchannel/accounts/{id}/send",
17902 "title": "Send new openchannel message",
17905 "title": "Example usage:",
17906 "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",
17910 "name": "sendOpenchannel",
17911 "group": "Openchannel_Accounts",
17912 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17913 "version": "0.0.0",
17914 "filename": "server/api/openchannelAccount/index.js",
17915 "groupTitle": "Openchannel_Accounts"
17919 "url": "/api/openchannel/accounts/{id}",
17920 "title": "Update an existing Account",
17923 "title": "Example usage:",
17924 "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",
17928 "name": "updateAccounts",
17929 "group": "Openchannel_Accounts",
17930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17931 "version": "0.0.0",
17932 "filename": "server/api/openchannelAccount/index.js",
17933 "groupTitle": "Openchannel_Accounts"
17937 "url": "/api/openchannel/applications",
17938 "title": "Creates a new Application",
17941 "title": "Example usage:",
17942 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17946 "name": "CreateApplications",
17947 "group": "Openchannel_Applications",
17955 "field": "priority",
17969 "field": "appdata",
17976 "field": "description",
17983 "field": "interval",
17989 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17990 "version": "0.0.0",
17991 "filename": "server/api/openchannelApplication/index.js",
17992 "groupTitle": "Openchannel_Applications"
17996 "url": "/api/openchannel/applications/{id}",
17997 "title": "Deletes a Application",
18000 "title": "Example usage:",
18001 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18005 "name": "DeleteApplications",
18006 "group": "Openchannel_Applications",
18007 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18008 "version": "0.0.0",
18009 "filename": "server/api/openchannelApplication/index.js",
18010 "groupTitle": "Openchannel_Applications"
18014 "url": "/api/openchannel/applications",
18015 "title": "Gets a list of Applications",
18018 "title": "Example usage:",
18019 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18023 "name": "GetApplications",
18024 "group": "Openchannel_Applications",
18025 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18026 "version": "0.0.0",
18027 "filename": "server/api/openchannelApplication/index.js",
18028 "groupTitle": "Openchannel_Applications"
18032 "url": "/api/openchannel/applications/{id}",
18033 "title": "Gets a single Application",
18036 "title": "Example usage:",
18037 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18041 "name": "ShowApplications",
18042 "group": "Openchannel_Applications",
18043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18044 "version": "0.0.0",
18045 "filename": "server/api/openchannelApplication/index.js",
18046 "groupTitle": "Openchannel_Applications"
18050 "url": "/api/openchannel/applications/{id}",
18051 "title": "Update an existing Application",
18054 "title": "Example usage:",
18055 "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",
18059 "name": "updateApplications",
18060 "group": "Openchannel_Applications",
18061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18062 "version": "0.0.0",
18063 "filename": "server/api/openchannelApplication/index.js",
18064 "groupTitle": "Openchannel_Applications"
18068 "url": "/api/openchannel/interactions/{id}/tags",
18069 "title": "Add tags to the interaction",
18072 "title": "Example usage:",
18073 "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",
18078 "group": "Openchannel_Interactions",
18079 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18080 "version": "0.0.0",
18081 "filename": "server/api/openchannelInteraction/index.js",
18082 "groupTitle": "Openchannel_Interactions"
18086 "url": "/api/openchannel/interactions",
18087 "title": "Creates a new Interaction",
18090 "title": "Example usage:",
18091 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18095 "name": "CreateInteractions",
18096 "group": "Openchannel_Interactions",
18111 "field": "closedAt",
18118 "field": "disposition",
18125 "field": "secondDisposition",
18132 "field": "thirdDisposition",
18146 "field": "read1stAt",
18153 "field": "threadId",
18160 "field": "externalUrl",
18167 "field": "lastMsgAt",
18178 "field": "lastMsgDirection",
18192 "field": "autoreplyExecuted",
18198 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18199 "version": "0.0.0",
18200 "filename": "server/api/openchannelInteraction/index.js",
18201 "groupTitle": "Openchannel_Interactions"
18205 "url": "/api/openchannel/interactions/{id}",
18206 "title": "Deletes a Interaction",
18209 "title": "Example usage:",
18210 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18214 "name": "DeleteInteractions",
18215 "group": "Openchannel_Interactions",
18216 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18217 "version": "0.0.0",
18218 "filename": "server/api/openchannelInteraction/index.js",
18219 "groupTitle": "Openchannel_Interactions"
18223 "url": "/api/openchannel/interactions/describe",
18224 "title": "Gets table info about Interactions",
18227 "title": "Example usage:",
18228 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18232 "name": "DescribeInteractions",
18233 "group": "Openchannel_Interactions",
18234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18235 "version": "0.0.0",
18236 "filename": "server/api/openchannelInteraction/index.js",
18237 "groupTitle": "Openchannel_Interactions"
18241 "url": "/api/openchannel/interactions",
18242 "title": "Gets a list of Interactions",
18245 "title": "Example usage:",
18246 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18250 "name": "GetInteractions",
18251 "group": "Openchannel_Interactions",
18252 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18253 "version": "0.0.0",
18254 "filename": "server/api/openchannelInteraction/index.js",
18255 "groupTitle": "Openchannel_Interactions"
18259 "url": "/api/openchannel/interactions/{id}/tags",
18260 "title": "Removes tags from interaction",
18263 "title": "Example usage:",
18264 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18268 "name": "RemoveTags",
18269 "group": "Openchannel_Interactions",
18270 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18271 "version": "0.0.0",
18272 "filename": "server/api/openchannelInteraction/index.js",
18273 "groupTitle": "Openchannel_Interactions"
18277 "url": "/api/openchannel/interactions/{id}",
18278 "title": "Gets a single Interaction",
18281 "title": "Example usage:",
18282 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18286 "name": "ShowInteractions",
18287 "group": "Openchannel_Interactions",
18288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18289 "version": "0.0.0",
18290 "filename": "server/api/openchannelInteraction/index.js",
18291 "groupTitle": "Openchannel_Interactions"
18295 "url": "/api/openchannel/interactions/{id}/messages",
18296 "title": "Creates new messages",
18299 "title": "Example usage:",
18300 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18304 "name": "addMessage",
18305 "group": "Openchannel_Interactions",
18338 "field": "direction",
18352 "field": "providerName",
18359 "field": "providerResponse",
18365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18366 "version": "0.0.0",
18367 "filename": "server/api/openchannelInteraction/index.js",
18368 "groupTitle": "Openchannel_Interactions"
18372 "url": "/api/openchannel/interactions/{id}/download",
18373 "title": "Gets interaction",
18376 "title": "Example usage:",
18377 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18381 "name": "download",
18382 "group": "Openchannel_Interactions",
18383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18384 "version": "0.0.0",
18385 "filename": "server/api/openchannelInteraction/index.js",
18386 "groupTitle": "Openchannel_Interactions"
18390 "url": "/api/openchannel/interactions/{id}/messages",
18391 "title": "Gets interaction messages",
18394 "title": "Example usage:",
18395 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18399 "name": "getMessages",
18400 "group": "Openchannel_Interactions",
18401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18402 "version": "0.0.0",
18403 "filename": "server/api/openchannelInteraction/index.js",
18404 "groupTitle": "Openchannel_Interactions"
18408 "url": "/api/openchannel/interactions/{id}",
18409 "title": "Update an existing Interaction",
18412 "title": "Example usage:",
18413 "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",
18417 "name": "updateInteractions",
18418 "group": "Openchannel_Interactions",
18419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18420 "version": "0.0.0",
18421 "filename": "server/api/openchannelInteraction/index.js",
18422 "groupTitle": "Openchannel_Interactions"
18426 "url": "/api/openchannel/messages",
18427 "title": "Creates a new Message",
18430 "title": "Example usage:",
18431 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18435 "name": "CreateMessages",
18436 "group": "Openchannel_Messages",
18469 "field": "direction",
18483 "field": "providerName",
18490 "field": "providerResponse",
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/openchannelMessage/index.js",
18499 "groupTitle": "Openchannel_Messages"
18503 "url": "/api/openchannel/messages/{id}",
18504 "title": "Deletes a Message",
18507 "title": "Example usage:",
18508 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18512 "name": "DeleteMessages",
18513 "group": "Openchannel_Messages",
18514 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18515 "version": "0.0.0",
18516 "filename": "server/api/openchannelMessage/index.js",
18517 "groupTitle": "Openchannel_Messages"
18521 "url": "/api/openchannel/messages/describe",
18522 "title": "Gets table info about Messages",
18525 "title": "Example usage:",
18526 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18530 "name": "DescribeMessages",
18531 "group": "Openchannel_Messages",
18532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18533 "version": "0.0.0",
18534 "filename": "server/api/openchannelMessage/index.js",
18535 "groupTitle": "Openchannel_Messages"
18539 "url": "/api/openchannel/messages",
18540 "title": "Gets a list of Messages",
18543 "title": "Example usage:",
18544 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18548 "name": "GetMessages",
18549 "group": "Openchannel_Messages",
18550 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18551 "version": "0.0.0",
18552 "filename": "server/api/openchannelMessage/index.js",
18553 "groupTitle": "Openchannel_Messages"
18557 "url": "/api/openchannel/messages/{id}",
18558 "title": "Gets a single Message",
18561 "title": "Example usage:",
18562 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18566 "name": "ShowMessages",
18567 "group": "Openchannel_Messages",
18568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18569 "version": "0.0.0",
18570 "filename": "server/api/openchannelMessage/index.js",
18571 "groupTitle": "Openchannel_Messages"
18575 "url": "/api/openchannel/messages/{id}/accept",
18576 "title": "Accepts message",
18579 "title": "Example usage:",
18580 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18584 "name": "acceptMessage",
18585 "group": "Openchannel_Messages",
18586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18587 "version": "0.0.0",
18588 "filename": "server/api/openchannelMessage/index.js",
18589 "groupTitle": "Openchannel_Messages"
18593 "url": "/api/openchannel/messages/{id}/reject",
18594 "title": "Rejects message",
18597 "title": "Example usage:",
18598 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18602 "name": "rejectMessage",
18603 "group": "Openchannel_Messages",
18604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18605 "version": "0.0.0",
18606 "filename": "server/api/openchannelMessage/index.js",
18607 "groupTitle": "Openchannel_Messages"
18611 "url": "/api/openchannel/messages/{id}",
18612 "title": "Update an existing Message",
18615 "title": "Example usage:",
18616 "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",
18620 "name": "updateMessages",
18621 "group": "Openchannel_Messages",
18622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18623 "version": "0.0.0",
18624 "filename": "server/api/openchannelMessage/index.js",
18625 "groupTitle": "Openchannel_Messages"
18629 "url": "/api/openchannel/reports/queue",
18630 "title": "Creates a new Openchannel Queue Report",
18633 "title": "Example usage:",
18634 "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",
18638 "name": "CreateOpenchannel_Queue_Reports",
18639 "group": "Openchannel_Queue_Reports",
18647 "field": "uniqueid",
18668 "field": "leaveAt",
18675 "field": "acceptAt",
18695 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18696 "version": "0.0.0",
18697 "filename": "server/api/openchannelQueueReport/index.js",
18698 "groupTitle": "Openchannel_Queue_Reports"
18702 "url": "/api/openchannel/reports/queue/{id}",
18703 "title": "Deletes a Openchannel Queue Report",
18706 "title": "Example usage:",
18707 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18711 "name": "DeleteOpenchannel_Queue_Reports",
18712 "group": "Openchannel_Queue_Reports",
18713 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18714 "version": "0.0.0",
18715 "filename": "server/api/openchannelQueueReport/index.js",
18716 "groupTitle": "Openchannel_Queue_Reports"
18720 "url": "/api/openchannel/reports/queue/describe",
18721 "title": "Gets table info about Openchannel Queue Reports",
18724 "title": "Example usage:",
18725 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18729 "name": "DescribeOpenchannel_Queue_Reports",
18730 "group": "Openchannel_Queue_Reports",
18731 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18732 "version": "0.0.0",
18733 "filename": "server/api/openchannelQueueReport/index.js",
18734 "groupTitle": "Openchannel_Queue_Reports"
18738 "url": "/api/openchannel/reports/queue",
18739 "title": "Gets a list of Openchannel Queue Reports",
18742 "title": "Example usage:",
18743 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18747 "name": "GetOpenchannel_Queue_Reports",
18748 "group": "Openchannel_Queue_Reports",
18749 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18750 "version": "0.0.0",
18751 "filename": "server/api/openchannelQueueReport/index.js",
18752 "groupTitle": "Openchannel_Queue_Reports"
18756 "url": "/api/openchannel/reports/queue/{id}",
18757 "title": "Gets a single Openchannel Queue Report",
18760 "title": "Example usage:",
18761 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18765 "name": "ShowOpenchannel_Queue_Reports",
18766 "group": "Openchannel_Queue_Reports",
18767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18768 "version": "0.0.0",
18769 "filename": "server/api/openchannelQueueReport/index.js",
18770 "groupTitle": "Openchannel_Queue_Reports"
18774 "url": "/api/openchannel/reports/queue/{id}",
18775 "title": "Update an existing Openchannel Queue Report",
18778 "title": "Example usage:",
18779 "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",
18783 "name": "updateOpenchannel_Queue_Reports",
18784 "group": "Openchannel_Queue_Reports",
18785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18786 "version": "0.0.0",
18787 "filename": "server/api/openchannelQueueReport/index.js",
18788 "groupTitle": "Openchannel_Queue_Reports"
18792 "url": "/api/openchannel/queues/{id}/users",
18793 "title": "Add agents to a queue",
18796 "title": "Example usage:",
18797 "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",
18801 "name": "AddAgents",
18802 "group": "Openchannel_Queues",
18803 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18804 "version": "0.0.0",
18805 "filename": "server/api/openchannelQueue/index.js",
18806 "groupTitle": "Openchannel_Queues"
18810 "url": "/api/openchannel/queues/{id}/teams",
18811 "title": "Add teams to a queue",
18814 "title": "Example usage:",
18815 "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",
18819 "name": "AddTeams",
18820 "group": "Openchannel_Queues",
18821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18822 "version": "0.0.0",
18823 "filename": "server/api/openchannelQueue/index.js",
18824 "groupTitle": "Openchannel_Queues"
18828 "url": "/api/openchannel/queues",
18829 "title": "Creates a new Queue",
18832 "title": "Example usage:",
18833 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18837 "name": "CreateQueues",
18838 "group": "Openchannel_Queues",
18853 "field": "description",
18860 "field": "timeout",
18872 "field": "strategy",
18878 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18879 "version": "0.0.0",
18880 "filename": "server/api/openchannelQueue/index.js",
18881 "groupTitle": "Openchannel_Queues"
18885 "url": "/api/openchannel/queues/{id}",
18886 "title": "Deletes a Queue",
18889 "title": "Example usage:",
18890 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18894 "name": "DeleteQueues",
18895 "group": "Openchannel_Queues",
18896 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18897 "version": "0.0.0",
18898 "filename": "server/api/openchannelQueue/index.js",
18899 "groupTitle": "Openchannel_Queues"
18903 "url": "/api/openchannel/queues/describe",
18904 "title": "Gets table info about Queues",
18907 "title": "Example usage:",
18908 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18912 "name": "DescribeQueues",
18913 "group": "Openchannel_Queues",
18914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18915 "version": "0.0.0",
18916 "filename": "server/api/openchannelQueue/index.js",
18917 "groupTitle": "Openchannel_Queues"
18921 "url": "/api/openchannel/queues/{id}/users",
18922 "title": "Gets queue agents",
18925 "title": "Example usage:",
18926 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18930 "name": "GetAgents",
18931 "group": "Openchannel_Queues",
18932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18933 "version": "0.0.0",
18934 "filename": "server/api/openchannelQueue/index.js",
18935 "groupTitle": "Openchannel_Queues"
18939 "url": "/api/openchannel/queues/{id}/members",
18940 "title": "GetMembers",
18943 "title": "Example usage:",
18944 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18948 "name": "GetMembers",
18949 "group": "Openchannel_Queues",
18950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18951 "version": "0.0.0",
18952 "filename": "server/api/openchannelQueue/index.js",
18953 "groupTitle": "Openchannel_Queues"
18957 "url": "/api/openchannel/queues",
18958 "title": "Gets a list of Queues",
18961 "title": "Example usage:",
18962 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18966 "name": "GetQueues",
18967 "group": "Openchannel_Queues",
18968 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18969 "version": "0.0.0",
18970 "filename": "server/api/openchannelQueue/index.js",
18971 "groupTitle": "Openchannel_Queues"
18975 "url": "/api/openchannel/queues/{id}/teams",
18976 "title": "Gets queues list",
18979 "title": "Example usage:",
18980 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18984 "name": "GetTeams",
18985 "group": "Openchannel_Queues",
18986 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18987 "version": "0.0.0",
18988 "filename": "server/api/openchannelQueue/index.js",
18989 "groupTitle": "Openchannel_Queues"
18993 "url": "/api/openchannel/queues/{id}/users",
18994 "title": "Removes agents from a queue",
18997 "title": "Example usage:",
18998 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19002 "name": "RemoveAgents",
19003 "group": "Openchannel_Queues",
19004 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19005 "version": "0.0.0",
19006 "filename": "server/api/openchannelQueue/index.js",
19007 "groupTitle": "Openchannel_Queues"
19011 "url": "/api/openchannel/queues/{id}",
19012 "title": "Gets a single Queue",
19015 "title": "Example usage:",
19016 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19020 "name": "ShowQueues",
19021 "group": "Openchannel_Queues",
19022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19023 "version": "0.0.0",
19024 "filename": "server/api/openchannelQueue/index.js",
19025 "groupTitle": "Openchannel_Queues"
19029 "url": "/api/openchannel/queues/{id}",
19030 "title": "Update an existing Queue",
19033 "title": "Example usage:",
19034 "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",
19038 "name": "updateQueues",
19039 "group": "Openchannel_Queues",
19040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19041 "version": "0.0.0",
19042 "filename": "server/api/openchannelQueue/index.js",
19043 "groupTitle": "Openchannel_Queues"
19047 "url": "/api/openchannel/reports/transfer",
19048 "title": "Creates a new Openchannel Transfer Report",
19051 "title": "Example usage:",
19052 "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",
19056 "name": "CreateOpenchannel_Transfer_Reports",
19057 "group": "Openchannel_Transfer_Reports",
19065 "field": "uniqueid",
19084 "field": "transferredAt",
19090 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19091 "version": "0.0.0",
19092 "filename": "server/api/openchannelTransferReport/index.js",
19093 "groupTitle": "Openchannel_Transfer_Reports"
19097 "url": "/api/openchannel/reports/transfer/{id}",
19098 "title": "Deletes a Openchannel Transfer Report",
19101 "title": "Example usage:",
19102 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19106 "name": "DeleteOpenchannel_Transfer_Reports",
19107 "group": "Openchannel_Transfer_Reports",
19108 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19109 "version": "0.0.0",
19110 "filename": "server/api/openchannelTransferReport/index.js",
19111 "groupTitle": "Openchannel_Transfer_Reports"
19115 "url": "/api/openchannel/reports/transfer/describe",
19116 "title": "Gets table info about Openchannel Transfer Reports",
19119 "title": "Example usage:",
19120 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19124 "name": "DescribeOpenchannel_Transfer_Reports",
19125 "group": "Openchannel_Transfer_Reports",
19126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19127 "version": "0.0.0",
19128 "filename": "server/api/openchannelTransferReport/index.js",
19129 "groupTitle": "Openchannel_Transfer_Reports"
19133 "url": "/api/openchannel/reports/transfer",
19134 "title": "Gets a list of Openchannel Transfer Reports",
19137 "title": "Example usage:",
19138 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19142 "name": "GetOpenchannel_Transfer_Reports",
19143 "group": "Openchannel_Transfer_Reports",
19144 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19145 "version": "0.0.0",
19146 "filename": "server/api/openchannelTransferReport/index.js",
19147 "groupTitle": "Openchannel_Transfer_Reports"
19151 "url": "/api/openchannel/reports/transfer/{id}",
19152 "title": "Gets a single Openchannel Transfer Report",
19155 "title": "Example usage:",
19156 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19160 "name": "ShowOpenchannel_Transfer_Reports",
19161 "group": "Openchannel_Transfer_Reports",
19162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19163 "version": "0.0.0",
19164 "filename": "server/api/openchannelTransferReport/index.js",
19165 "groupTitle": "Openchannel_Transfer_Reports"
19169 "url": "/api/openchannel/reports/transfer/{id}",
19170 "title": "Update an existing Openchannel Transfer Report",
19173 "title": "Example usage:",
19174 "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",
19178 "name": "updateOpenchannel_Transfer_Reports",
19179 "group": "Openchannel_Transfer_Reports",
19180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19181 "version": "0.0.0",
19182 "filename": "server/api/openchannelTransferReport/index.js",
19183 "groupTitle": "Openchannel_Transfer_Reports"
19187 "url": "/api/pauses",
19188 "title": "Creates a new Pause",
19191 "title": "Example usage:",
19192 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19196 "name": "CreatePauses",
19212 "field": "description",
19218 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19219 "version": "0.0.0",
19220 "filename": "server/api/pause/index.js",
19221 "groupTitle": "Pauses"
19225 "url": "/api/pauses/{id}",
19226 "title": "Deletes a Pause",
19229 "title": "Example usage:",
19230 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19234 "name": "DeletePauses",
19236 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19237 "version": "0.0.0",
19238 "filename": "server/api/pause/index.js",
19239 "groupTitle": "Pauses"
19243 "url": "/api/pauses",
19244 "title": "Gets a list of Pauses",
19247 "title": "Example usage:",
19248 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19252 "name": "GetPauses",
19254 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19255 "version": "0.0.0",
19256 "filename": "server/api/pause/index.js",
19257 "groupTitle": "Pauses"
19261 "url": "/api/pauses/{id}",
19262 "title": "Gets a single Pause",
19265 "title": "Example usage:",
19266 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19270 "name": "ShowPauses",
19272 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19273 "version": "0.0.0",
19274 "filename": "server/api/pause/index.js",
19275 "groupTitle": "Pauses"
19279 "url": "/api/pauses/{id}",
19280 "title": "Update an existing Pause",
19283 "title": "Example usage:",
19284 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19288 "name": "updatePauses",
19290 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19291 "version": "0.0.0",
19292 "filename": "server/api/pause/index.js",
19293 "groupTitle": "Pauses"
19297 "url": "/api/plugins",
19298 "title": "Gets a list of Plugins",
19301 "title": "Example usage:",
19302 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19306 "name": "GetPlugins",
19307 "group": "Plugins",
19308 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19309 "version": "0.0.0",
19310 "filename": "server/api/plugin/index.js",
19311 "groupTitle": "Plugins"
19315 "url": "/api/plugins/{id}",
19316 "title": "Gets a single Plugin",
19319 "title": "Example usage:",
19320 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19324 "name": "ShowPlugins",
19325 "group": "Plugins",
19326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19327 "version": "0.0.0",
19328 "filename": "server/api/plugin/index.js",
19329 "groupTitle": "Plugins"
19333 "url": "/api/plugins/{id}",
19334 "title": "Delete a plugin",
19337 "title": "Example usage:",
19338 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19342 "name": "destroyPlugin",
19343 "group": "Plugins",
19344 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19345 "version": "0.0.0",
19346 "filename": "server/api/plugin/index.js",
19347 "groupTitle": "Plugins"
19351 "url": "/api/plugins/{id}/download",
19352 "title": "Download plugin source code",
19355 "title": "Example usage:",
19356 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19360 "name": "download",
19361 "group": "Plugins",
19362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19363 "version": "0.0.0",
19364 "filename": "server/api/plugin/index.js",
19365 "groupTitle": "Plugins"
19369 "url": "/api/plugins/{id}",
19370 "title": "Update an existing plugin",
19373 "title": "Example usage:",
19374 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19378 "name": "updatePlugin",
19379 "group": "Plugins",
19380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19381 "version": "0.0.0",
19382 "filename": "server/api/plugin/index.js",
19383 "groupTitle": "Plugins"
19387 "url": "/api/plugins",
19388 "title": "Upload new plugin",
19391 "title": "Example usage:",
19392 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19396 "name": "uploadPlugin",
19397 "group": "Plugins",
19398 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19399 "version": "0.0.0",
19400 "filename": "server/api/plugin/index.js",
19401 "groupTitle": "Plugins"
19405 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19406 "title": "Redirect a plugin request to the specified path",
19409 "title": "Example usage:",
19410 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19414 "name": "webhookPlugin",
19415 "group": "Plugins",
19416 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19417 "version": "0.0.0",
19418 "filename": "server/api/plugin/index.js",
19419 "groupTitle": "Plugins"
19423 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19424 "title": "Redirect a plugin request to the specified path",
19427 "title": "Example usage:",
19428 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19432 "name": "webhookPlugin",
19433 "group": "Plugins",
19434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19435 "version": "0.0.0",
19436 "filename": "server/api/plugin/index.js",
19437 "groupTitle": "Plugins"
19441 "url": "/api/pm2/{id}",
19442 "title": "Deletes an existing process",
19445 "title": "Example usage:",
19446 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19450 "name": "DeletePm2Process",
19452 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19453 "version": "0.0.0",
19454 "filename": "server/api/pm2/index.js",
19455 "groupTitle": "Pm2"
19459 "url": "/api/pm2/{id}",
19460 "title": "Gets a single pm2 process",
19463 "title": "Example usage:",
19464 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19468 "name": "GetPm2Process",
19470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19471 "version": "0.0.0",
19472 "filename": "server/api/pm2/index.js",
19473 "groupTitle": "Pm2"
19478 "title": "Gets pm2 processes",
19481 "title": "Example usage:",
19482 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19486 "name": "GetPm2Processes",
19488 "description": "<p>Motion returns the pm2 processes list.</p>",
19489 "version": "0.0.0",
19490 "filename": "server/api/pm2/index.js",
19491 "groupTitle": "Pm2"
19496 "title": "Start a single pm2 process",
19499 "title": "Example usage:",
19500 "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",
19504 "name": "StartPm2Process",
19526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19527 "version": "0.0.0",
19528 "filename": "server/api/pm2/index.js",
19529 "groupTitle": "Pm2"
19533 "url": "/api/pm2/{id}",
19534 "title": "Update an existing process",
19537 "title": "Example usage:",
19538 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19542 "name": "UpdatePm2Process",
19544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19545 "version": "0.0.0",
19546 "filename": "server/api/pm2/index.js",
19547 "groupTitle": "Pm2"
19551 "url": "/api/rpc/campaigns/",
19552 "title": "Gets a list of campaigns",
19555 "title": "Example usage:",
19556 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19560 "name": "Campaigns",
19561 "group": "RPC_Realtime",
19562 "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>",
19563 "version": "0.0.0",
19564 "filename": "server/api/rpc/index.js",
19565 "groupTitle": "RPC_Realtime"
19569 "url": "/api/rpc/fax/accounts",
19570 "title": "Gets a list of FaxAccounts",
19573 "title": "Example usage:",
19574 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19578 "name": "FaxAccounts",
19579 "group": "RPC_Realtime",
19580 "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>",
19581 "version": "0.0.0",
19582 "filename": "server/api/rpc/index.js",
19583 "groupTitle": "RPC_Realtime"
19587 "url": "/api/rpc/agents/:id/capacity",
19588 "title": "Sets agent capacity",
19591 "title": "Example usage:",
19592 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19596 "name": "RTAgentCapacity",
19597 "group": "RPC_Realtime",
19598 "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>",
19599 "version": "0.0.0",
19600 "filename": "server/api/rpc/index.js",
19601 "groupTitle": "RPC_Realtime"
19605 "url": "/api/rpc/agents",
19606 "title": "Gets a list of RTAgents",
19609 "title": "Example usage:",
19610 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19614 "name": "RTAgents",
19615 "group": "RPC_Realtime",
19616 "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>",
19617 "version": "0.0.0",
19618 "filename": "server/api/rpc/index.js",
19619 "groupTitle": "RPC_Realtime"
19623 "url": "/api/rpc/chat/queues",
19624 "title": "Gets a list of RTChatQueues",
19627 "title": "Example usage:",
19628 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19632 "name": "RTChatQueues",
19633 "group": "RPC_Realtime",
19634 "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>",
19635 "version": "0.0.0",
19636 "filename": "server/api/rpc/index.js",
19637 "groupTitle": "RPC_Realtime"
19641 "url": "/api/rpc/fax/queues",
19642 "title": "Gets a list of RTFaxQueues",
19645 "title": "Example usage:",
19646 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19650 "name": "RTFaxQueues",
19651 "group": "RPC_Realtime",
19652 "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>",
19653 "version": "0.0.0",
19654 "filename": "server/api/rpc/index.js",
19655 "groupTitle": "RPC_Realtime"
19659 "url": "/api/rpc/mail/accounts",
19660 "title": "Gets a list of RTMailAccounts",
19663 "title": "Example usage:",
19664 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19668 "name": "RTMailAccounts",
19669 "group": "RPC_Realtime",
19670 "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>",
19671 "version": "0.0.0",
19672 "filename": "server/api/rpc/index.js",
19673 "groupTitle": "RPC_Realtime"
19677 "url": "/api/rpc/mail/queues",
19678 "title": "Gets a list of RTMailQueues",
19681 "title": "Example usage:",
19682 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19686 "name": "RTMailQueues",
19687 "group": "RPC_Realtime",
19688 "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>",
19689 "version": "0.0.0",
19690 "filename": "server/api/rpc/index.js",
19691 "groupTitle": "RPC_Realtime"
19695 "url": "/api/rpc/openchannel/queues",
19696 "title": "Gets a list of RTOpenchannelQueues",
19699 "title": "Example usage:",
19700 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19704 "name": "RTOpenchannelQueues",
19705 "group": "RPC_Realtime",
19706 "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>",
19707 "version": "0.0.0",
19708 "filename": "server/api/rpc/index.js",
19709 "groupTitle": "RPC_Realtime"
19713 "url": "/api/rpc/outbound/channels",
19714 "title": "Gets a list of RTOutboundChannels",
19717 "title": "Example usage:",
19718 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19722 "name": "RTOutboundChannels",
19723 "group": "RPC_Realtime",
19724 "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>",
19725 "version": "0.0.0",
19726 "filename": "server/api/rpc/index.js",
19727 "groupTitle": "RPC_Realtime"
19731 "url": "/api/rpc/sms/queues",
19732 "title": "Gets a list of RTSmsQueues",
19735 "title": "Example usage:",
19736 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19740 "name": "RTSmsQueues",
19741 "group": "RPC_Realtime",
19742 "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>",
19743 "version": "0.0.0",
19744 "filename": "server/api/rpc/index.js",
19745 "groupTitle": "RPC_Realtime"
19749 "url": "/api/rpc/telephones",
19750 "title": "Gets a list of RTTelephones",
19753 "title": "Example usage:",
19754 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19758 "name": "RTTelephones",
19759 "group": "RPC_Realtime",
19760 "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>",
19761 "version": "0.0.0",
19762 "filename": "server/api/rpc/index.js",
19763 "groupTitle": "RPC_Realtime"
19767 "url": "/api/rpc/trunks",
19768 "title": "Gets a list of RTTrunks",
19771 "title": "Example usage:",
19772 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19776 "name": "RTTrunks",
19777 "group": "RPC_Realtime",
19778 "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>",
19779 "version": "0.0.0",
19780 "filename": "server/api/rpc/index.js",
19781 "groupTitle": "RPC_Realtime"
19785 "url": "/api/rpc/voice/channels",
19786 "title": "Gets a list of RTVoiceChannelMixMonitor",
19789 "title": "Example usage:",
19790 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19794 "name": "RTVoiceChannelMixMonitor",
19795 "group": "RPC_Realtime",
19796 "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>",
19797 "version": "0.0.0",
19798 "filename": "server/api/rpc/index.js",
19799 "groupTitle": "RPC_Realtime"
19803 "url": "/api/rpc/voice/channels",
19804 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19807 "title": "Example usage:",
19808 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19812 "name": "RTVoiceChannelStopMixMonitor",
19813 "group": "RPC_Realtime",
19814 "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>",
19815 "version": "0.0.0",
19816 "filename": "server/api/rpc/index.js",
19817 "groupTitle": "RPC_Realtime"
19821 "url": "/api/rpc/voice/channels",
19822 "title": "Gets a list of RTVoiceChannels",
19825 "title": "Example usage:",
19826 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19830 "name": "RTVoiceChannels",
19831 "group": "RPC_Realtime",
19832 "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>",
19833 "version": "0.0.0",
19834 "filename": "server/api/rpc/index.js",
19835 "groupTitle": "RPC_Realtime"
19839 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19840 "title": "Gets a single RTVoiceQueueChannel",
19843 "title": "Example usage:",
19844 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19848 "name": "RTVoiceQueueChannel",
19849 "group": "RPC_Realtime",
19850 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19851 "version": "0.0.0",
19852 "filename": "server/api/rpc/index.js",
19853 "groupTitle": "RPC_Realtime"
19857 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19858 "title": "Hangup a single RTVoiceQueueChannel",
19861 "title": "Example usage:",
19862 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19866 "name": "RTVoiceQueueChannelHangup",
19867 "group": "RPC_Realtime",
19868 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19869 "version": "0.0.0",
19870 "filename": "server/api/rpc/index.js",
19871 "groupTitle": "RPC_Realtime"
19875 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19876 "title": "Hangup a single RTVoiceQueueChannel",
19879 "title": "Example usage:",
19880 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19884 "name": "RTVoiceQueueChannelRedirect",
19885 "group": "RPC_Realtime",
19886 "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>",
19887 "version": "0.0.0",
19888 "filename": "server/api/rpc/index.js",
19889 "groupTitle": "RPC_Realtime"
19893 "url": "/api/rpc/voice/queues/preview/{id}",
19894 "title": "Gets a single preview contact",
19897 "title": "Example usage:",
19898 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19902 "name": "RTVoiceQueuePreview",
19903 "group": "RPC_Realtime",
19904 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19905 "version": "0.0.0",
19906 "filename": "server/api/rpc/index.js",
19907 "groupTitle": "RPC_Realtime"
19911 "url": "/api/rpc/outbound",
19912 "title": "Gets a list of RTOutbound",
19915 "title": "Example usage:",
19916 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19920 "name": "RTVoiceQueues",
19921 "group": "RPC_Realtime",
19922 "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>",
19923 "version": "0.0.0",
19924 "filename": "server/api/rpc/index.js",
19925 "groupTitle": "RPC_Realtime"
19929 "url": "/api/rpc/voice/queues",
19930 "title": "Gets a list of RTVoiceQueues",
19933 "title": "Example usage:",
19934 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19938 "name": "RTVoiceQueues",
19939 "group": "RPC_Realtime",
19940 "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>",
19941 "version": "0.0.0",
19942 "filename": "server/api/rpc/index.js",
19943 "groupTitle": "RPC_Realtime"
19947 "url": "/api/rpc/voice/queues/channels",
19948 "title": "Gets a list of RTVoiceQueuesChannels",
19951 "title": "Example usage:",
19952 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19956 "name": "RTVoiceQueuesChannels",
19957 "group": "RPC_Realtime",
19958 "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>",
19959 "version": "0.0.0",
19960 "filename": "server/api/rpc/index.js",
19961 "groupTitle": "RPC_Realtime"
19965 "url": "/api/rpc/chat/queues/{id}",
19966 "title": "Gets a single RTChatQueue",
19969 "title": "Example usage:",
19970 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19974 "name": "ShowRTChatQueues",
19975 "group": "RPC_Realtime",
19976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19977 "version": "0.0.0",
19978 "filename": "server/api/rpc/index.js",
19979 "groupTitle": "RPC_Realtime"
19983 "url": "/api/rpc/fax/queues/{id}",
19984 "title": "Gets a single RTFaxQueue",
19987 "title": "Example usage:",
19988 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19992 "name": "ShowRTFaxQueues",
19993 "group": "RPC_Realtime",
19994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19995 "version": "0.0.0",
19996 "filename": "server/api/rpc/index.js",
19997 "groupTitle": "RPC_Realtime"
20001 "url": "/api/rpc/mail/queues/{id}",
20002 "title": "Gets a single RTMailQueue",
20005 "title": "Example usage:",
20006 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20010 "name": "ShowRTMailQueues",
20011 "group": "RPC_Realtime",
20012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20013 "version": "0.0.0",
20014 "filename": "server/api/rpc/index.js",
20015 "groupTitle": "RPC_Realtime"
20019 "url": "/api/rpc/openchannel/queues/{id}",
20020 "title": "Gets a single RTOpenchannelQueue",
20023 "title": "Example usage:",
20024 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20028 "name": "ShowRTOpenchannelQueues",
20029 "group": "RPC_Realtime",
20030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20031 "version": "0.0.0",
20032 "filename": "server/api/rpc/index.js",
20033 "groupTitle": "RPC_Realtime"
20037 "url": "/api/rpc/sms/queues/{id}",
20038 "title": "Gets a single RTSmsQueue",
20041 "title": "Example usage:",
20042 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20046 "name": "ShowRTSmsQueues",
20047 "group": "RPC_Realtime",
20048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20049 "version": "0.0.0",
20050 "filename": "server/api/rpc/index.js",
20051 "groupTitle": "RPC_Realtime"
20055 "url": "/api/rpc/voice/queues/{id}",
20056 "title": "Gets a single RTVoiceQueue",
20059 "title": "Example usage:",
20060 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20064 "name": "ShowRTVoiceQueues",
20065 "group": "RPC_Realtime",
20066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20067 "version": "0.0.0",
20068 "filename": "server/api/rpc/index.js",
20069 "groupTitle": "RPC_Realtime"
20073 "url": "/api/rpc/voice/{id}/queues",
20074 "title": "Updates a single VoiceQueue",
20077 "title": "Example usage:",
20078 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20082 "name": "UpdateVoiceQueues",
20083 "group": "RPC_Realtime",
20084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20085 "version": "0.0.0",
20086 "filename": "server/api/rpc/index.js",
20087 "groupTitle": "RPC_Realtime"
20091 "url": "/api/rpc/agents/:id/notify",
20092 "title": "Notify message to a specific agent",
20095 "title": "Example usage:",
20096 "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",
20100 "name": "agentNotify",
20101 "group": "RPC_Realtime",
20102 "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>",
20103 "version": "0.0.0",
20104 "filename": "server/api/rpc/index.js",
20105 "groupTitle": "RPC_Realtime"
20109 "url": "/api/rpc/chat/queues/:id/notify",
20110 "title": "Notify message to a specific queue",
20113 "title": "Example usage:",
20114 "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",
20118 "name": "chatQueueNotify",
20119 "group": "RPC_Realtime",
20120 "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>",
20121 "version": "0.0.0",
20122 "filename": "server/api/rpc/index.js",
20123 "groupTitle": "RPC_Realtime"
20127 "url": "/api/rpc/chat/queues/waitinginteractions",
20128 "title": "Gets a list of chatQueuesWaitingInteractions",
20131 "title": "Example usage:",
20132 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20136 "name": "chatQueuesWaitingInteractions",
20137 "group": "RPC_Realtime",
20138 "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>",
20139 "version": "0.0.0",
20140 "filename": "server/api/rpc/index.js",
20141 "groupTitle": "RPC_Realtime"
20145 "url": "/api/rpc/fax/queues/:id/notify",
20146 "title": "Notify message to a specific queue",
20149 "title": "Example usage:",
20150 "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",
20154 "name": "faxQueueNotify",
20155 "group": "RPC_Realtime",
20156 "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>",
20157 "version": "0.0.0",
20158 "filename": "server/api/rpc/index.js",
20159 "groupTitle": "RPC_Realtime"
20163 "url": "/api/rpc/fax/queues/waitinginteractions",
20164 "title": "Gets a list of faxQueuesWaitingInteractions",
20167 "title": "Example usage:",
20168 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20172 "name": "faxQueuesWaitingInteractions",
20173 "group": "RPC_Realtime",
20174 "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>",
20175 "version": "0.0.0",
20176 "filename": "server/api/rpc/index.js",
20177 "groupTitle": "RPC_Realtime"
20181 "url": "/api/rpc/mail/queues/:id/notify",
20182 "title": "Notify message to a specific queue",
20185 "title": "Example usage:",
20186 "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",
20190 "name": "mailQueueNotify",
20191 "group": "RPC_Realtime",
20192 "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>",
20193 "version": "0.0.0",
20194 "filename": "server/api/rpc/index.js",
20195 "groupTitle": "RPC_Realtime"
20199 "url": "/api/rpc/mail/queues/waitinginteractions",
20200 "title": "Gets a list of mailQueuesWaitingInteractions",
20203 "title": "Example usage:",
20204 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20208 "name": "mailQueuesWaitingInteractions",
20209 "group": "RPC_Realtime",
20210 "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>",
20211 "version": "0.0.0",
20212 "filename": "server/api/rpc/index.js",
20213 "groupTitle": "RPC_Realtime"
20217 "url": "/api/rpc/openchannel/queues/:id/notify",
20218 "title": "Notify message to a specific queue",
20221 "title": "Example usage:",
20222 "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",
20226 "name": "openchannelQueueNotify",
20227 "group": "RPC_Realtime",
20228 "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>",
20229 "version": "0.0.0",
20230 "filename": "server/api/rpc/index.js",
20231 "groupTitle": "RPC_Realtime"
20235 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20236 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20239 "title": "Example usage:",
20240 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20244 "name": "openchannelQueuesIdWaitingInteractions",
20245 "group": "RPC_Realtime",
20246 "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>",
20247 "version": "0.0.0",
20248 "filename": "server/api/rpc/index.js",
20249 "groupTitle": "RPC_Realtime"
20253 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20254 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20257 "title": "Example usage:",
20258 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20262 "name": "openchannelQueuesWaitingInteractions",
20263 "group": "RPC_Realtime",
20264 "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>",
20265 "version": "0.0.0",
20266 "filename": "server/api/rpc/index.js",
20267 "groupTitle": "RPC_Realtime"
20271 "url": "/api/rpc/sms/queues/:id/notify",
20272 "title": "Notify message to a specific queue",
20275 "title": "Example usage:",
20276 "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",
20280 "name": "smsQueueNotify",
20281 "group": "RPC_Realtime",
20282 "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>",
20283 "version": "0.0.0",
20284 "filename": "server/api/rpc/index.js",
20285 "groupTitle": "RPC_Realtime"
20289 "url": "/api/rpc/sms/queues/waitinginteractions",
20290 "title": "Gets a list of smsQueuesWaitingInteractions",
20293 "title": "Example usage:",
20294 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20298 "name": "smsQueuesWaitingInteractions",
20299 "group": "RPC_Realtime",
20300 "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>",
20301 "version": "0.0.0",
20302 "filename": "server/api/rpc/index.js",
20303 "groupTitle": "RPC_Realtime"
20307 "url": "/api/realtime/agents",
20308 "title": "Gets realtime agents info",
20311 "title": "Example usage:",
20312 "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
20316 "name": "getAgents",
20317 "group": "Realtime",
20318 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20319 "version": "0.0.0",
20320 "filename": "server/api/realtime/index.js",
20321 "groupTitle": "Realtime"
20325 "url": "/api/realtime/queues",
20326 "title": "Gets realtime queues info",
20329 "title": "Example usage:",
20330 "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
20334 "name": "getQueues",
20335 "group": "Realtime",
20336 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20337 "version": "0.0.0",
20338 "filename": "server/api/realtime/index.js",
20339 "groupTitle": "Realtime"
20343 "url": "/api/integrations/salesforce/accounts",
20344 "title": "Creates a new Salesforce Account",
20347 "title": "Example usage:",
20348 "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",
20352 "name": "CreateSalesforce_Accounts",
20353 "group": "Salesforce_Accounts",
20368 "field": "description",
20375 "field": "username",
20382 "field": "remoteUri",
20389 "field": "password",
20396 "field": "clientId",
20403 "field": "clientSecret",
20410 "field": "securityToken",
20417 "field": "serverUrl",
20424 "\"integrationTab\"",
20434 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20435 "version": "0.0.0",
20436 "filename": "server/api/intSalesforceAccount/index.js",
20437 "groupTitle": "Salesforce_Accounts"
20441 "url": "/api/integrations/salesforce/accounts/{id}",
20442 "title": "Deletes a Salesforce Account",
20445 "title": "Example usage:",
20446 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20450 "name": "DeleteSalesforce_Accounts",
20451 "group": "Salesforce_Accounts",
20452 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20453 "version": "0.0.0",
20454 "filename": "server/api/intSalesforceAccount/index.js",
20455 "groupTitle": "Salesforce_Accounts"
20459 "url": "/api/integrations/salesforce/accounts",
20460 "title": "Gets a list of Salesforce Accounts",
20463 "title": "Example usage:",
20464 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20468 "name": "GetSalesforce_Accounts",
20469 "group": "Salesforce_Accounts",
20470 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20471 "version": "0.0.0",
20472 "filename": "server/api/intSalesforceAccount/index.js",
20473 "groupTitle": "Salesforce_Accounts"
20477 "url": "/api/integrations/salesforce/accounts/{id}",
20478 "title": "Gets a single Salesforce Account",
20481 "title": "Example usage:",
20482 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20486 "name": "ShowSalesforce_Accounts",
20487 "group": "Salesforce_Accounts",
20488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20489 "version": "0.0.0",
20490 "filename": "server/api/intSalesforceAccount/index.js",
20491 "groupTitle": "Salesforce_Accounts"
20495 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20496 "title": "Creates new configuration",
20499 "title": "Example usage:",
20500 "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",
20504 "name": "addConfiguration",
20505 "group": "Salesforce_Accounts",
20506 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20507 "version": "0.0.0",
20508 "filename": "server/api/intSalesforceAccount/index.js",
20509 "groupTitle": "Salesforce_Accounts"
20513 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20514 "title": "Gets account configurations",
20517 "title": "Example usage:",
20518 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20522 "name": "getConfigurations",
20523 "group": "Salesforce_Accounts",
20524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20525 "version": "0.0.0",
20526 "filename": "server/api/intSalesforceAccount/index.js",
20527 "groupTitle": "Salesforce_Accounts"
20531 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20532 "title": "Gets account fields",
20535 "title": "Example usage:",
20536 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20540 "name": "getFields",
20541 "group": "Salesforce_Accounts",
20542 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20543 "version": "0.0.0",
20544 "filename": "server/api/intSalesforceAccount/index.js",
20545 "groupTitle": "Salesforce_Accounts"
20549 "url": "/api/integrations/salesforce/accounts/{id}",
20550 "title": "Update an existing Salesforce Account",
20553 "title": "Example usage:",
20554 "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",
20558 "name": "updateSalesforce_Accounts",
20559 "group": "Salesforce_Accounts",
20560 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20561 "version": "0.0.0",
20562 "filename": "server/api/intSalesforceAccount/index.js",
20563 "groupTitle": "Salesforce_Accounts"
20567 "url": "/api/integrations/salesforce/configurations",
20568 "title": "Creates a new Salesforce Configuration",
20571 "title": "Example usage:",
20572 "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",
20576 "name": "CreateSalesforce_Configurations",
20577 "group": "Salesforce_Configurations",
20592 "field": "description",
20603 "field": "ticketType",
20610 "\"contact_lead\"",
20613 "\"account_contact_lead\"",
20617 "field": "moduleSearch",
20630 "field": "moduleCreate",
20644 "field": "additionalSearchAccount",
20651 "field": "additionalSearchContact",
20658 "field": "additionalSearchLead",
20664 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20665 "version": "0.0.0",
20666 "filename": "server/api/intSalesforceConfiguration/index.js",
20667 "groupTitle": "Salesforce_Configurations"
20671 "url": "/api/integrations/salesforce/configurations/{id}",
20672 "title": "Deletes a Salesforce Configuration",
20675 "title": "Example usage:",
20676 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20680 "name": "DeleteSalesforce_Configurations",
20681 "group": "Salesforce_Configurations",
20682 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20683 "version": "0.0.0",
20684 "filename": "server/api/intSalesforceConfiguration/index.js",
20685 "groupTitle": "Salesforce_Configurations"
20689 "url": "/api/integrations/salesforce/configurations",
20690 "title": "Gets a list of Salesforce Configurations",
20693 "title": "Example usage:",
20694 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20698 "name": "GetSalesforce_Configurations",
20699 "group": "Salesforce_Configurations",
20700 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20701 "version": "0.0.0",
20702 "filename": "server/api/intSalesforceConfiguration/index.js",
20703 "groupTitle": "Salesforce_Configurations"
20707 "url": "/api/integrations/salesforce/configurations/{id}",
20708 "title": "Gets a single Salesforce Configuration",
20711 "title": "Example usage:",
20712 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20716 "name": "ShowSalesforce_Configurations",
20717 "group": "Salesforce_Configurations",
20718 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20719 "version": "0.0.0",
20720 "filename": "server/api/intSalesforceConfiguration/index.js",
20721 "groupTitle": "Salesforce_Configurations"
20725 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20726 "title": "Gets configurations descriptions",
20729 "title": "Example usage:",
20730 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20734 "name": "getDescriptions",
20735 "group": "Salesforce_Configurations",
20736 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20737 "version": "0.0.0",
20738 "filename": "server/api/intSalesforceConfiguration/index.js",
20739 "groupTitle": "Salesforce_Configurations"
20743 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20744 "title": "Gets configurations fields",
20747 "title": "Example usage:",
20748 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20752 "name": "getFields",
20753 "group": "Salesforce_Configurations",
20754 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20755 "version": "0.0.0",
20756 "filename": "server/api/intSalesforceConfiguration/index.js",
20757 "groupTitle": "Salesforce_Configurations"
20761 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20762 "title": "Gets configurations subjects",
20765 "title": "Example usage:",
20766 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20770 "name": "getSubjects",
20771 "group": "Salesforce_Configurations",
20772 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20773 "version": "0.0.0",
20774 "filename": "server/api/intSalesforceConfiguration/index.js",
20775 "groupTitle": "Salesforce_Configurations"
20779 "url": "/api/integrations/salesforce/configurations/{id}",
20780 "title": "Update an existing Salesforce Configuration",
20783 "title": "Example usage:",
20784 "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",
20788 "name": "updateSalesforce_Configurations",
20789 "group": "Salesforce_Configurations",
20790 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20791 "version": "0.0.0",
20792 "filename": "server/api/intSalesforceConfiguration/index.js",
20793 "groupTitle": "Salesforce_Configurations"
20797 "url": "/api/integrations/salesforce/fields",
20798 "title": "Creates a new Salesforce Field",
20801 "title": "Example usage:",
20802 "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",
20806 "name": "CreateSalesforce_Fields",
20807 "group": "Salesforce_Fields",
20817 "\"customVariable\"",
20829 "field": "content",
20845 "\"customVariable\""
20848 "field": "keyType",
20855 "field": "keyContent",
20862 "field": "idField",
20869 "field": "variableName",
20875 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20876 "version": "0.0.0",
20877 "filename": "server/api/intSalesforceField/index.js",
20878 "groupTitle": "Salesforce_Fields"
20882 "url": "/api/integrations/salesforce/fields/{id}",
20883 "title": "Deletes a Salesforce Field",
20886 "title": "Example usage:",
20887 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20891 "name": "DeleteSalesforce_Fields",
20892 "group": "Salesforce_Fields",
20893 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20894 "version": "0.0.0",
20895 "filename": "server/api/intSalesforceField/index.js",
20896 "groupTitle": "Salesforce_Fields"
20900 "url": "/api/integrations/salesforce/fields",
20901 "title": "Gets a list of Salesforce Fields",
20904 "title": "Example usage:",
20905 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20909 "name": "GetSalesforce_Fields",
20910 "group": "Salesforce_Fields",
20911 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20912 "version": "0.0.0",
20913 "filename": "server/api/intSalesforceField/index.js",
20914 "groupTitle": "Salesforce_Fields"
20918 "url": "/api/integrations/salesforce/fields/{id}",
20919 "title": "Gets a single Salesforce Field",
20922 "title": "Example usage:",
20923 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20927 "name": "ShowSalesforce_Fields",
20928 "group": "Salesforce_Fields",
20929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20930 "version": "0.0.0",
20931 "filename": "server/api/intSalesforceField/index.js",
20932 "groupTitle": "Salesforce_Fields"
20936 "url": "/api/integrations/salesforce/fields/{id}",
20937 "title": "Update an existing Salesforce Field",
20940 "title": "Example usage:",
20941 "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",
20945 "name": "updateSalesforce_Fields",
20946 "group": "Salesforce_Fields",
20947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20948 "version": "0.0.0",
20949 "filename": "server/api/intSalesforceField/index.js",
20950 "groupTitle": "Salesforce_Fields"
20954 "url": "/api/schedules",
20955 "title": "Creates a new Schedule",
20958 "title": "Example usage:",
20959 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20963 "name": "CreateSchedules",
20964 "group": "Schedules",
20979 "field": "description",
21000 "field": "startAt",
21014 "field": "subtractNumber",
21030 "field": "subtractUnit",
21060 "field": "sendMail",
21088 "field": "sendIfEmpty",
21094 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21095 "version": "0.0.0",
21096 "filename": "server/api/schedule/index.js",
21097 "groupTitle": "Schedules"
21101 "url": "/api/schedules/{id}",
21102 "title": "Deletes a Schedule",
21105 "title": "Example usage:",
21106 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21110 "name": "DeleteSchedules",
21111 "group": "Schedules",
21112 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21113 "version": "0.0.0",
21114 "filename": "server/api/schedule/index.js",
21115 "groupTitle": "Schedules"
21119 "url": "/api/schedules",
21120 "title": "Gets a list of Schedules",
21123 "title": "Example usage:",
21124 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21128 "name": "GetSchedules",
21129 "group": "Schedules",
21130 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21131 "version": "0.0.0",
21132 "filename": "server/api/schedule/index.js",
21133 "groupTitle": "Schedules"
21137 "url": "/api/schedules/{id}",
21138 "title": "Gets a single Schedule",
21141 "title": "Example usage:",
21142 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21146 "name": "ShowSchedules",
21147 "group": "Schedules",
21148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21149 "version": "0.0.0",
21150 "filename": "server/api/schedule/index.js",
21151 "groupTitle": "Schedules"
21155 "url": "/api/schedules/{id}/run",
21156 "title": "Run Scheduler",
21159 "title": "Example usage:",
21160 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21165 "group": "Schedules",
21166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21167 "version": "0.0.0",
21168 "filename": "server/api/schedule/index.js",
21169 "groupTitle": "Schedules"
21173 "url": "/api/schedules/{id}",
21174 "title": "Update an existing Schedule",
21177 "title": "Example usage:",
21178 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21182 "name": "updateSchedules",
21183 "group": "Schedules",
21184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21185 "version": "0.0.0",
21186 "filename": "server/api/schedule/index.js",
21187 "groupTitle": "Schedules"
21191 "url": "/api/screen/recordings",
21192 "title": "Creates a new Recording",
21195 "title": "Example usage:",
21196 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21200 "name": "CreateRecordings",
21201 "group": "Screen_Recordings",
21216 "field": "interactionid",
21223 "field": "channel",
21244 "field": "duration",
21251 "field": "startedAt",
21258 "field": "closedAt",
21265 "field": "createdAt",
21272 "field": "updatedAt",
21278 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21279 "version": "0.0.0",
21280 "filename": "server/api/screenRecording/index.js",
21281 "groupTitle": "Screen_Recordings"
21285 "url": "/api/screen/recordings/describe",
21286 "title": "Gets table info about Recordings",
21289 "title": "Example usage:",
21290 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21294 "name": "DescribeRecordings",
21295 "group": "Screen_Recordings",
21296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21297 "version": "0.0.0",
21298 "filename": "server/api/screenRecording/index.js",
21299 "groupTitle": "Screen_Recordings"
21303 "url": "/api/screen/recordings",
21304 "title": "Gets a list of Recordings",
21307 "title": "Example usage:",
21308 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21312 "name": "GetRecordings",
21313 "group": "Screen_Recordings",
21314 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
21315 "version": "0.0.0",
21316 "filename": "server/api/screenRecording/index.js",
21317 "groupTitle": "Screen_Recordings"
21321 "url": "/api/screen/recordings/{id}",
21322 "title": "Gets a single Recording",
21325 "title": "Example usage:",
21326 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21330 "name": "ShowRecordings",
21331 "group": "Screen_Recordings",
21332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21333 "version": "0.0.0",
21334 "filename": "server/api/screenRecording/index.js",
21335 "groupTitle": "Screen_Recordings"
21339 "url": "/api/screen/recordings/{id}",
21340 "title": "Delete screen recording",
21343 "title": "Example usage:",
21344 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21349 "group": "Screen_Recordings",
21350 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21351 "version": "0.0.0",
21352 "filename": "server/api/screenRecording/index.js",
21353 "groupTitle": "Screen_Recordings"
21357 "url": "/api/screen/recordings/{id}/download",
21358 "title": "Download Recording",
21361 "title": "Example usage:",
21362 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21366 "name": "download",
21367 "group": "Screen_Recordings",
21368 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21369 "version": "0.0.0",
21370 "filename": "server/api/screenRecording/index.js",
21371 "groupTitle": "Screen_Recordings"
21375 "url": "/api/screen/recordings/{id}",
21376 "title": "Update an existing Recording",
21379 "title": "Example usage:",
21380 "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",
21384 "name": "updateRecordings",
21385 "group": "Screen_Recordings",
21386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21387 "version": "0.0.0",
21388 "filename": "server/api/screenRecording/index.js",
21389 "groupTitle": "Screen_Recordings"
21393 "url": "/api/integrations/servicenow/accounts",
21394 "title": "Creates a new Servicenow Account",
21397 "title": "Example usage:",
21398 "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",
21402 "name": "CreateServicenow_Accounts",
21403 "group": "Servicenow_Accounts",
21418 "field": "description",
21425 "field": "username",
21432 "field": "password",
21446 "field": "remoteUri",
21453 "field": "serverUrl",
21459 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21460 "version": "0.0.0",
21461 "filename": "server/api/intServicenowAccount/index.js",
21462 "groupTitle": "Servicenow_Accounts"
21466 "url": "/api/integrations/servicenow/accounts/{id}",
21467 "title": "Deletes a Servicenow Account",
21470 "title": "Example usage:",
21471 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21475 "name": "DeleteServicenow_Accounts",
21476 "group": "Servicenow_Accounts",
21477 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21478 "version": "0.0.0",
21479 "filename": "server/api/intServicenowAccount/index.js",
21480 "groupTitle": "Servicenow_Accounts"
21484 "url": "/api/integrations/servicenow/accounts",
21485 "title": "Gets a list of Servicenow Accounts",
21488 "title": "Example usage:",
21489 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21493 "name": "GetServicenow_Accounts",
21494 "group": "Servicenow_Accounts",
21495 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21496 "version": "0.0.0",
21497 "filename": "server/api/intServicenowAccount/index.js",
21498 "groupTitle": "Servicenow_Accounts"
21502 "url": "/api/integrations/servicenow/accounts/{id}",
21503 "title": "Gets a single Servicenow Account",
21506 "title": "Example usage:",
21507 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21511 "name": "ShowServicenow_Accounts",
21512 "group": "Servicenow_Accounts",
21513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21514 "version": "0.0.0",
21515 "filename": "server/api/intServicenowAccount/index.js",
21516 "groupTitle": "Servicenow_Accounts"
21520 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21521 "title": "Creates new configuration",
21524 "title": "Example usage:",
21525 "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",
21529 "name": "addConfiguration",
21530 "group": "Servicenow_Accounts",
21531 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21532 "version": "0.0.0",
21533 "filename": "server/api/intServicenowAccount/index.js",
21534 "groupTitle": "Servicenow_Accounts"
21538 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21539 "title": "Gets account configurations",
21542 "title": "Example usage:",
21543 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21547 "name": "getConfigurations",
21548 "group": "Servicenow_Accounts",
21549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21550 "version": "0.0.0",
21551 "filename": "server/api/intServicenowAccount/index.js",
21552 "groupTitle": "Servicenow_Accounts"
21556 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21557 "title": "Gets account fields",
21560 "title": "Example usage:",
21561 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21565 "name": "getFields",
21566 "group": "Servicenow_Accounts",
21567 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21568 "version": "0.0.0",
21569 "filename": "server/api/intServicenowAccount/index.js",
21570 "groupTitle": "Servicenow_Accounts"
21574 "url": "/api/integrations/servicenow/accounts/{id}",
21575 "title": "Update an existing Servicenow Account",
21578 "title": "Example usage:",
21579 "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",
21583 "name": "updateServicenow_Accounts",
21584 "group": "Servicenow_Accounts",
21585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21586 "version": "0.0.0",
21587 "filename": "server/api/intServicenowAccount/index.js",
21588 "groupTitle": "Servicenow_Accounts"
21592 "url": "/api/integrations/servicenow/configurations",
21593 "title": "Creates a new Servicenow Configuration",
21596 "title": "Example usage:",
21597 "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",
21601 "name": "CreateServicenow_Configurations",
21602 "group": "Servicenow_Configurations",
21617 "field": "description",
21623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21624 "version": "0.0.0",
21625 "filename": "server/api/intServicenowConfiguration/index.js",
21626 "groupTitle": "Servicenow_Configurations"
21630 "url": "/api/integrations/servicenow/configurations/{id}",
21631 "title": "Deletes a Servicenow Configuration",
21634 "title": "Example usage:",
21635 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21639 "name": "DeleteServicenow_Configurations",
21640 "group": "Servicenow_Configurations",
21641 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21642 "version": "0.0.0",
21643 "filename": "server/api/intServicenowConfiguration/index.js",
21644 "groupTitle": "Servicenow_Configurations"
21648 "url": "/api/integrations/servicenow/configurations",
21649 "title": "Gets a list of Servicenow Configurations",
21652 "title": "Example usage:",
21653 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21657 "name": "GetServicenow_Configurations",
21658 "group": "Servicenow_Configurations",
21659 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21660 "version": "0.0.0",
21661 "filename": "server/api/intServicenowConfiguration/index.js",
21662 "groupTitle": "Servicenow_Configurations"
21666 "url": "/api/integrations/servicenow/configurations/{id}",
21667 "title": "Gets a single Servicenow Configuration",
21670 "title": "Example usage:",
21671 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21675 "name": "ShowServicenow_Configurations",
21676 "group": "Servicenow_Configurations",
21677 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21678 "version": "0.0.0",
21679 "filename": "server/api/intServicenowConfiguration/index.js",
21680 "groupTitle": "Servicenow_Configurations"
21684 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21685 "title": "Gets configurations descriptions",
21688 "title": "Example usage:",
21689 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21693 "name": "getDescriptions",
21694 "group": "Servicenow_Configurations",
21695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21696 "version": "0.0.0",
21697 "filename": "server/api/intServicenowConfiguration/index.js",
21698 "groupTitle": "Servicenow_Configurations"
21702 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21703 "title": "Gets configurations fields",
21706 "title": "Example usage:",
21707 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21711 "name": "getFields",
21712 "group": "Servicenow_Configurations",
21713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21714 "version": "0.0.0",
21715 "filename": "server/api/intServicenowConfiguration/index.js",
21716 "groupTitle": "Servicenow_Configurations"
21720 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21721 "title": "Gets configurations subjects",
21724 "title": "Example usage:",
21725 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21729 "name": "getSubjects",
21730 "group": "Servicenow_Configurations",
21731 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21732 "version": "0.0.0",
21733 "filename": "server/api/intServicenowConfiguration/index.js",
21734 "groupTitle": "Servicenow_Configurations"
21738 "url": "/api/integrations/servicenow/configurations/{id}",
21739 "title": "Update an existing Servicenow Configuration",
21742 "title": "Example usage:",
21743 "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",
21747 "name": "updateServicenow_Configurations",
21748 "group": "Servicenow_Configurations",
21749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21750 "version": "0.0.0",
21751 "filename": "server/api/intServicenowConfiguration/index.js",
21752 "groupTitle": "Servicenow_Configurations"
21756 "url": "/api/integrations/servicenow/fields",
21757 "title": "Creates a new Servicenow Field",
21760 "title": "Example usage:",
21761 "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",
21765 "name": "CreateServicenow_Fields",
21766 "group": "Servicenow_Fields",
21776 "\"customVariable\"",
21788 "field": "content",
21804 "\"customVariable\""
21807 "field": "keyType",
21814 "field": "keyContent",
21821 "field": "idField",
21828 "field": "nameField",
21835 "field": "customField",
21842 "field": "variableName",
21848 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21849 "version": "0.0.0",
21850 "filename": "server/api/intServicenowField/index.js",
21851 "groupTitle": "Servicenow_Fields"
21855 "url": "/api/integrations/servicenow/fields/{id}",
21856 "title": "Deletes a Servicenow Field",
21859 "title": "Example usage:",
21860 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21864 "name": "DeleteServicenow_Fields",
21865 "group": "Servicenow_Fields",
21866 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21867 "version": "0.0.0",
21868 "filename": "server/api/intServicenowField/index.js",
21869 "groupTitle": "Servicenow_Fields"
21873 "url": "/api/integrations/servicenow/fields",
21874 "title": "Gets a list of Servicenow Fields",
21877 "title": "Example usage:",
21878 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21882 "name": "GetServicenow_Fields",
21883 "group": "Servicenow_Fields",
21884 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21885 "version": "0.0.0",
21886 "filename": "server/api/intServicenowField/index.js",
21887 "groupTitle": "Servicenow_Fields"
21891 "url": "/api/integrations/servicenow/fields/{id}",
21892 "title": "Gets a single Servicenow Field",
21895 "title": "Example usage:",
21896 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21900 "name": "ShowServicenow_Fields",
21901 "group": "Servicenow_Fields",
21902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21903 "version": "0.0.0",
21904 "filename": "server/api/intServicenowField/index.js",
21905 "groupTitle": "Servicenow_Fields"
21909 "url": "/api/integrations/servicenow/fields/{id}",
21910 "title": "Update an existing Servicenow Field",
21913 "title": "Example usage:",
21914 "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",
21918 "name": "updateServicenow_Fields",
21919 "group": "Servicenow_Fields",
21920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21921 "version": "0.0.0",
21922 "filename": "server/api/intServicenowField/index.js",
21923 "groupTitle": "Servicenow_Fields"
21927 "url": "/api/settings",
21928 "title": "Gets a list of Settings",
21931 "title": "Example usage:",
21932 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21936 "name": "GetSettings",
21937 "group": "Settings",
21938 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21939 "version": "0.0.0",
21940 "filename": "server/api/setting/index.js",
21941 "groupTitle": "Settings"
21945 "url": "/api/settings/{id}",
21946 "title": "Gets a single Setting",
21949 "title": "Example usage:",
21950 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21954 "name": "ShowSettings",
21955 "group": "Settings",
21956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21957 "version": "0.0.0",
21958 "filename": "server/api/setting/index.js",
21959 "groupTitle": "Settings"
21963 "url": "/api/settings/{id}/favicon",
21964 "title": "Add Favicon",
21967 "title": "Example usage:",
21968 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21972 "name": "addFavicon",
21973 "group": "Settings",
21974 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21975 "version": "0.0.0",
21976 "filename": "server/api/setting/index.js",
21977 "groupTitle": "Settings"
21981 "url": "/api/settings/{id}/logo",
21982 "title": "Add logo",
21985 "title": "Example usage:",
21986 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21991 "group": "Settings",
21992 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21993 "version": "0.0.0",
21994 "filename": "server/api/setting/index.js",
21995 "groupTitle": "Settings"
21999 "url": "/api/settings/{id}/logo_login",
22000 "title": "Add logo login",
22003 "title": "Example usage:",
22004 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22008 "name": "addLogoLogin",
22009 "group": "Settings",
22010 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22011 "version": "0.0.0",
22012 "filename": "server/api/setting/index.js",
22013 "groupTitle": "Settings"
22017 "url": "/api/settings/{id}/preferred",
22018 "title": "Add Preferred",
22021 "title": "Example usage:",
22022 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22026 "name": "addPreferred",
22027 "group": "Settings",
22028 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029 "version": "0.0.0",
22030 "filename": "server/api/setting/index.js",
22031 "groupTitle": "Settings"
22035 "url": "/api/settings/now",
22036 "title": "Get Server Current Date",
22039 "title": "Example usage:",
22040 "content": "curl https://{domain}/api/settings/now -v -X GET",
22045 "group": "Settings",
22046 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22047 "version": "0.0.0",
22048 "filename": "server/api/setting/index.js",
22049 "groupTitle": "Settings"
22053 "url": "/api/settings/{id}/favicon",
22054 "title": "Get Favicon",
22057 "title": "Example usage:",
22058 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22062 "name": "getFavicon",
22063 "group": "Settings",
22064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22065 "version": "0.0.0",
22066 "filename": "server/api/setting/index.js",
22067 "groupTitle": "Settings"
22071 "url": "/api/settings/{id}/gdpr",
22072 "title": "Get gdpr settings",
22075 "title": "Example usage:",
22076 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22081 "group": "Settings",
22082 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22083 "version": "0.0.0",
22084 "filename": "server/api/setting/index.js",
22085 "groupTitle": "Settings"
22089 "url": "/api/settings/{id}/logo",
22090 "title": "Get logo",
22093 "title": "Example usage:",
22094 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22099 "group": "Settings",
22100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22101 "version": "0.0.0",
22102 "filename": "server/api/setting/index.js",
22103 "groupTitle": "Settings"
22107 "url": "/api/settings/{id}/logo_login",
22108 "title": "Get logo login",
22111 "title": "Example usage:",
22112 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22116 "name": "getLogoLogin",
22117 "group": "Settings",
22118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22119 "version": "0.0.0",
22120 "filename": "server/api/setting/index.js",
22121 "groupTitle": "Settings"
22125 "url": "/api/settings/{id}/preferred",
22126 "title": "Get Preferred",
22129 "title": "Example usage:",
22130 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22134 "name": "getPreferred",
22135 "group": "Settings",
22136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22137 "version": "0.0.0",
22138 "filename": "server/api/setting/index.js",
22139 "groupTitle": "Settings"
22143 "url": "/api/settings/{id}",
22144 "title": "Update an existing Setting",
22147 "title": "Example usage:",
22148 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22152 "name": "updateSettings",
22153 "group": "Settings",
22154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22155 "version": "0.0.0",
22156 "filename": "server/api/setting/index.js",
22157 "groupTitle": "Settings"
22161 "url": "/api/sms/accounts/{id}/users",
22162 "title": "Add agents to a sms account",
22165 "title": "Example usage:",
22166 "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",
22170 "name": "AddAgents",
22171 "group": "Sms_Accounts",
22172 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22173 "version": "0.0.0",
22174 "filename": "server/api/smsAccount/index.js",
22175 "groupTitle": "Sms_Accounts"
22179 "url": "/api/sms/accounts",
22180 "title": "Creates a new Account",
22183 "title": "Example usage:",
22184 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22188 "name": "CreateAccounts",
22189 "group": "Sms_Accounts",
22251 "field": "accountSid",
22265 "field": "authToken",
22277 "field": "smsMethod",
22284 "field": "username",
22291 "field": "password",
22305 "field": "applicationId",
22312 "field": "accountId",
22319 "field": "senderString",
22326 "field": "deliveryReport",
22333 "field": "description",
22340 "field": "notificationTemplate",
22347 "field": "notificationSound",
22354 "field": "notificationShake",
22361 "field": "waitForTheAssignedAgent",
22368 "field": "queueTransfer",
22375 "field": "queueTransferTimeout",
22382 "field": "agentTransfer",
22389 "field": "agentTransferTimeout",
22396 "field": "baseUrl",
22403 "field": "mandatoryDispositionPauseId",
22404 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22410 "field": "mandatoryDisposition",
22411 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22416 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22417 "version": "0.0.0",
22418 "filename": "server/api/smsAccount/index.js",
22419 "groupTitle": "Sms_Accounts"
22423 "url": "/api/sms/accounts/{id}",
22424 "title": "Deletes a Account",
22427 "title": "Example usage:",
22428 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22432 "name": "DeleteAccounts",
22433 "group": "Sms_Accounts",
22434 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22435 "version": "0.0.0",
22436 "filename": "server/api/smsAccount/index.js",
22437 "groupTitle": "Sms_Accounts"
22441 "url": "/api/sms/accounts/describe",
22442 "title": "Gets table info about Accounts",
22445 "title": "Example usage:",
22446 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22450 "name": "DescribeAccounts",
22451 "group": "Sms_Accounts",
22452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22453 "version": "0.0.0",
22454 "filename": "server/api/smsAccount/index.js",
22455 "groupTitle": "Sms_Accounts"
22459 "url": "/api/sms/accounts",
22460 "title": "Gets a list of Accounts",
22463 "title": "Example usage:",
22464 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22468 "name": "GetAccounts",
22469 "group": "Sms_Accounts",
22470 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22471 "version": "0.0.0",
22472 "filename": "server/api/smsAccount/index.js",
22473 "groupTitle": "Sms_Accounts"
22477 "url": "/api/sms/accounts/{id}/users",
22478 "title": "Gets agents from sms account",
22481 "title": "Example usage:",
22482 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22486 "name": "GetAgents",
22487 "group": "Sms_Accounts",
22488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22489 "version": "0.0.0",
22490 "filename": "server/api/smsAccount/index.js",
22491 "groupTitle": "Sms_Accounts"
22495 "url": "/api/sms/accounts/{id}/users",
22496 "title": "Removes agents from a sms account",
22499 "title": "Example usage:",
22500 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22504 "name": "RemoveAgents",
22505 "group": "Sms_Accounts",
22506 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22507 "version": "0.0.0",
22508 "filename": "server/api/smsAccount/index.js",
22509 "groupTitle": "Sms_Accounts"
22513 "url": "/api/sms/accounts/{id}/canned_answers",
22514 "title": "Removes canned answers from account",
22517 "title": "Example usage:",
22518 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22522 "name": "RemoveAnswers",
22523 "group": "Sms_Accounts",
22524 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22525 "version": "0.0.0",
22526 "filename": "server/api/smsAccount/index.js",
22527 "groupTitle": "Sms_Accounts"
22531 "url": "/api/sms/accounts/{id}/dispositions",
22532 "title": "Removes dispositions from account",
22535 "title": "Example usage:",
22536 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22540 "name": "RemoveDispositions",
22541 "group": "Sms_Accounts",
22542 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22543 "version": "0.0.0",
22544 "filename": "server/api/smsAccount/index.js",
22545 "groupTitle": "Sms_Accounts"
22549 "url": "/api/sms/accounts/{id}",
22550 "title": "Gets a single Account",
22553 "title": "Example usage:",
22554 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22558 "name": "ShowAccounts",
22559 "group": "Sms_Accounts",
22560 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22561 "version": "0.0.0",
22562 "filename": "server/api/smsAccount/index.js",
22563 "groupTitle": "Sms_Accounts"
22567 "url": "/api/sms/messages/{id}/accept",
22568 "title": "Accepts message",
22571 "title": "Example usage:",
22572 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22576 "name": "acceptMessage",
22577 "group": "Sms_Accounts",
22578 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22579 "version": "0.0.0",
22580 "filename": "server/api/smsMessage/index.js",
22581 "groupTitle": "Sms_Accounts"
22585 "url": "/api/sms/accounts/{id}/canned_answers",
22586 "title": "Creates new canned answer",
22589 "title": "Example usage:",
22590 "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",
22594 "name": "addAnswer",
22595 "group": "Sms_Accounts",
22617 "field": "description",
22630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22631 "version": "0.0.0",
22632 "filename": "server/api/smsAccount/index.js",
22633 "groupTitle": "Sms_Accounts"
22637 "url": "/api/sms/accounts/{id}/applications",
22638 "title": "Creates new applications",
22641 "title": "Example usage:",
22642 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22646 "name": "addApplications",
22647 "group": "Sms_Accounts",
22655 "field": "priority",
22669 "field": "appdata",
22676 "field": "description",
22683 "field": "interval",
22689 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22690 "version": "0.0.0",
22691 "filename": "server/api/smsAccount/index.js",
22692 "groupTitle": "Sms_Accounts"
22696 "url": "/api/sms/accounts/{id}/dispositions",
22697 "title": "Creates new disposition",
22700 "title": "Example usage:",
22701 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22705 "name": "addDisposition",
22706 "group": "Sms_Accounts",
22733 "field": "description",
22739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22740 "version": "0.0.0",
22741 "filename": "server/api/smsAccount/index.js",
22742 "groupTitle": "Sms_Accounts"
22746 "url": "/api/sms/accounts/{id}/canned_answers",
22747 "title": "Gets account canned answers",
22750 "title": "Example usage:",
22751 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22755 "name": "getAnswers",
22756 "group": "Sms_Accounts",
22757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22758 "version": "0.0.0",
22759 "filename": "server/api/smsAccount/index.js",
22760 "groupTitle": "Sms_Accounts"
22764 "url": "/api/sms/accounts/{id}/applications",
22765 "title": "Gets account applications",
22768 "title": "Example usage:",
22769 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22773 "name": "getApplications",
22774 "group": "Sms_Accounts",
22775 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22776 "version": "0.0.0",
22777 "filename": "server/api/smsAccount/index.js",
22778 "groupTitle": "Sms_Accounts"
22782 "url": "/api/sms/accounts/{id}/dispositions",
22783 "title": "Gets account dispositions",
22786 "title": "Example usage:",
22787 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22791 "name": "getDispositions",
22792 "group": "Sms_Accounts",
22793 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22794 "version": "0.0.0",
22795 "filename": "server/api/smsAccount/index.js",
22796 "groupTitle": "Sms_Accounts"
22800 "url": "/api/sms/accounts/{id}/interactions",
22801 "title": "Gets Sms Account interactions",
22804 "title": "Example usage:",
22805 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22809 "name": "getInteractions",
22810 "group": "Sms_Accounts",
22811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22812 "version": "0.0.0",
22813 "filename": "server/api/smsAccount/index.js",
22814 "groupTitle": "Sms_Accounts"
22818 "url": "/api/sms/accounts/{id}/notify",
22819 "title": "Notify new message",
22822 "title": "Example usage:",
22823 "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",
22828 "group": "Sms_Accounts",
22829 "description": "<p>Motion 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>",
22830 "version": "0.0.0",
22831 "filename": "server/api/smsAccount/index.js",
22832 "groupTitle": "Sms_Accounts"
22836 "url": "/api/sms/messages/{id}/reject",
22837 "title": "Rejects message",
22840 "title": "Example usage:",
22841 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22845 "name": "rejectMessage",
22846 "group": "Sms_Accounts",
22847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22848 "version": "0.0.0",
22849 "filename": "server/api/smsMessage/index.js",
22850 "groupTitle": "Sms_Accounts"
22854 "url": "/api/sms/accounts/{id}/send",
22855 "title": "Send new sms message",
22858 "title": "Example usage:",
22859 "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",
22864 "group": "Sms_Accounts",
22865 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22866 "version": "0.0.0",
22867 "filename": "server/api/smsAccount/index.js",
22868 "groupTitle": "Sms_Accounts"
22872 "url": "/api/sms/messages/{id}/status",
22873 "title": "Receive message status",
22876 "title": "Example usage:",
22877 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22881 "name": "statusMessage",
22882 "group": "Sms_Accounts",
22883 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22884 "version": "0.0.0",
22885 "filename": "server/api/smsMessage/index.js",
22886 "groupTitle": "Sms_Accounts"
22890 "url": "/api/sms/accounts/{id}/status",
22891 "title": "Receive message status as get request",
22894 "title": "Example usage:",
22895 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22899 "name": "statusMessage",
22900 "group": "Sms_Accounts",
22901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22902 "version": "0.0.0",
22903 "filename": "server/api/smsAccount/index.js",
22904 "groupTitle": "Sms_Accounts"
22908 "url": "/api/sms/accounts/{id}/status",
22909 "title": "Receive message status",
22912 "title": "Example usage:",
22913 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22917 "name": "statusMessage",
22918 "group": "Sms_Accounts",
22919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22920 "version": "0.0.0",
22921 "filename": "server/api/smsAccount/index.js",
22922 "groupTitle": "Sms_Accounts"
22926 "url": "/api/sms/accounts/{id}",
22927 "title": "Update an existing Account",
22930 "title": "Example usage:",
22931 "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",
22935 "name": "updateAccounts",
22936 "group": "Sms_Accounts",
22937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22938 "version": "0.0.0",
22939 "filename": "server/api/smsAccount/index.js",
22940 "groupTitle": "Sms_Accounts"
22944 "url": "/api/sms/applications",
22945 "title": "Creates a new Application",
22948 "title": "Example usage:",
22949 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22953 "name": "CreateApplications",
22954 "group": "Sms_Applications",
22962 "field": "priority",
22976 "field": "appdata",
22983 "field": "description",
22990 "field": "interval",
22996 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22997 "version": "0.0.0",
22998 "filename": "server/api/smsApplication/index.js",
22999 "groupTitle": "Sms_Applications"
23003 "url": "/api/sms/applications/{id}",
23004 "title": "Deletes a Application",
23007 "title": "Example usage:",
23008 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23012 "name": "DeleteApplications",
23013 "group": "Sms_Applications",
23014 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23015 "version": "0.0.0",
23016 "filename": "server/api/smsApplication/index.js",
23017 "groupTitle": "Sms_Applications"
23021 "url": "/api/sms/applications",
23022 "title": "Gets a list of Applications",
23025 "title": "Example usage:",
23026 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23030 "name": "GetApplications",
23031 "group": "Sms_Applications",
23032 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23033 "version": "0.0.0",
23034 "filename": "server/api/smsApplication/index.js",
23035 "groupTitle": "Sms_Applications"
23039 "url": "/api/sms/applications/{id}",
23040 "title": "Gets a single Application",
23043 "title": "Example usage:",
23044 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23048 "name": "ShowApplications",
23049 "group": "Sms_Applications",
23050 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23051 "version": "0.0.0",
23052 "filename": "server/api/smsApplication/index.js",
23053 "groupTitle": "Sms_Applications"
23057 "url": "/api/sms/applications/{id}",
23058 "title": "Update an existing Application",
23061 "title": "Example usage:",
23062 "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",
23066 "name": "updateApplications",
23067 "group": "Sms_Applications",
23068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23069 "version": "0.0.0",
23070 "filename": "server/api/smsApplication/index.js",
23071 "groupTitle": "Sms_Applications"
23075 "url": "/api/sms/interactions/{id}/tags",
23076 "title": "Add tags to the interaction",
23079 "title": "Example usage:",
23080 "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",
23085 "group": "Sms_Interactions",
23086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23087 "version": "0.0.0",
23088 "filename": "server/api/smsInteraction/index.js",
23089 "groupTitle": "Sms_Interactions"
23093 "url": "/api/sms/interactions",
23094 "title": "Creates a new Interaction",
23097 "title": "Example usage:",
23098 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23102 "name": "CreateInteractions",
23103 "group": "Sms_Interactions",
23118 "field": "closedAt",
23125 "field": "disposition",
23132 "field": "secondDisposition",
23139 "field": "thirdDisposition",
23160 "field": "read1stAt",
23171 "field": "firstMsgDirection",
23178 "field": "lastMsgAt",
23189 "field": "lastMsgDirection",
23196 "field": "autoreplyExecuted",
23202 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23203 "version": "0.0.0",
23204 "filename": "server/api/smsInteraction/index.js",
23205 "groupTitle": "Sms_Interactions"
23209 "url": "/api/sms/interactions/{id}",
23210 "title": "Deletes a Interaction",
23213 "title": "Example usage:",
23214 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23218 "name": "DeleteInteractions",
23219 "group": "Sms_Interactions",
23220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23221 "version": "0.0.0",
23222 "filename": "server/api/smsInteraction/index.js",
23223 "groupTitle": "Sms_Interactions"
23227 "url": "/api/sms/interactions/describe",
23228 "title": "Gets table info about Interactions",
23231 "title": "Example usage:",
23232 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23236 "name": "DescribeInteractions",
23237 "group": "Sms_Interactions",
23238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23239 "version": "0.0.0",
23240 "filename": "server/api/smsInteraction/index.js",
23241 "groupTitle": "Sms_Interactions"
23245 "url": "/api/sms/interactions",
23246 "title": "Gets a list of Interactions",
23249 "title": "Example usage:",
23250 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23254 "name": "GetInteractions",
23255 "group": "Sms_Interactions",
23256 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23257 "version": "0.0.0",
23258 "filename": "server/api/smsInteraction/index.js",
23259 "groupTitle": "Sms_Interactions"
23263 "url": "/api/sms/interactions/{id}/tags",
23264 "title": "Removes tags from interaction",
23267 "title": "Example usage:",
23268 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23272 "name": "RemoveTags",
23273 "group": "Sms_Interactions",
23274 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23275 "version": "0.0.0",
23276 "filename": "server/api/smsInteraction/index.js",
23277 "groupTitle": "Sms_Interactions"
23281 "url": "/api/sms/interactions/{id}",
23282 "title": "Gets a single Interaction",
23285 "title": "Example usage:",
23286 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23290 "name": "ShowInteractions",
23291 "group": "Sms_Interactions",
23292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23293 "version": "0.0.0",
23294 "filename": "server/api/smsInteraction/index.js",
23295 "groupTitle": "Sms_Interactions"
23299 "url": "/api/sms/interactions/{id}/messages",
23300 "title": "Creates new messages",
23303 "title": "Example usage:",
23304 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23308 "name": "addMessage",
23309 "group": "Sms_Interactions",
23335 "field": "direction",
23342 "field": "messageId",
23370 "field": "providerName",
23377 "field": "providerResponse",
23383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23384 "version": "0.0.0",
23385 "filename": "server/api/smsInteraction/index.js",
23386 "groupTitle": "Sms_Interactions"
23390 "url": "/api/sms/interactions/{id}/download",
23391 "title": "Gets interaction",
23394 "title": "Example usage:",
23395 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23399 "name": "download",
23400 "group": "Sms_Interactions",
23401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23402 "version": "0.0.0",
23403 "filename": "server/api/smsInteraction/index.js",
23404 "groupTitle": "Sms_Interactions"
23408 "url": "/api/sms/interactions/{id}/messages",
23409 "title": "Gets interaction messages",
23412 "title": "Example usage:",
23413 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23417 "name": "getMessages",
23418 "group": "Sms_Interactions",
23419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23420 "version": "0.0.0",
23421 "filename": "server/api/smsInteraction/index.js",
23422 "groupTitle": "Sms_Interactions"
23426 "url": "/api/sms/interactions/{id}",
23427 "title": "Update an existing Interaction",
23430 "title": "Example usage:",
23431 "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",
23435 "name": "updateInteractions",
23436 "group": "Sms_Interactions",
23437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23438 "version": "0.0.0",
23439 "filename": "server/api/smsInteraction/index.js",
23440 "groupTitle": "Sms_Interactions"
23444 "url": "/api/sms/messages",
23445 "title": "Creates a new Message",
23448 "title": "Example usage:",
23449 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23453 "name": "CreateMessages",
23454 "group": "Sms_Messages",
23480 "field": "direction",
23487 "field": "messageId",
23515 "field": "providerName",
23522 "field": "providerResponse",
23528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23529 "version": "0.0.0",
23530 "filename": "server/api/smsMessage/index.js",
23531 "groupTitle": "Sms_Messages"
23535 "url": "/api/sms/messages/{id}",
23536 "title": "Deletes a Message",
23539 "title": "Example usage:",
23540 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23544 "name": "DeleteMessages",
23545 "group": "Sms_Messages",
23546 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23547 "version": "0.0.0",
23548 "filename": "server/api/smsMessage/index.js",
23549 "groupTitle": "Sms_Messages"
23553 "url": "/api/sms/messages/describe",
23554 "title": "Gets table info about Messages",
23557 "title": "Example usage:",
23558 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23562 "name": "DescribeMessages",
23563 "group": "Sms_Messages",
23564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23565 "version": "0.0.0",
23566 "filename": "server/api/smsMessage/index.js",
23567 "groupTitle": "Sms_Messages"
23571 "url": "/api/sms/messages",
23572 "title": "Gets a list of Messages",
23575 "title": "Example usage:",
23576 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23580 "name": "GetMessages",
23581 "group": "Sms_Messages",
23582 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23583 "version": "0.0.0",
23584 "filename": "server/api/smsMessage/index.js",
23585 "groupTitle": "Sms_Messages"
23589 "url": "/api/sms/messages/{id}",
23590 "title": "Gets a single Message",
23593 "title": "Example usage:",
23594 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23598 "name": "ShowMessages",
23599 "group": "Sms_Messages",
23600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23601 "version": "0.0.0",
23602 "filename": "server/api/smsMessage/index.js",
23603 "groupTitle": "Sms_Messages"
23607 "url": "/api/sms/messages/{id}",
23608 "title": "Update an existing Message",
23611 "title": "Example usage:",
23612 "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",
23616 "name": "updateMessages",
23617 "group": "Sms_Messages",
23618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23619 "version": "0.0.0",
23620 "filename": "server/api/smsMessage/index.js",
23621 "groupTitle": "Sms_Messages"
23625 "url": "/api/sms/reports/queue",
23626 "title": "Creates a new Sms Queue Report",
23629 "title": "Example usage:",
23630 "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",
23634 "name": "CreateSms_Queue_Reports",
23635 "group": "Sms_Queue_Reports",
23643 "field": "uniqueid",
23664 "field": "leaveAt",
23671 "field": "acceptAt",
23691 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23692 "version": "0.0.0",
23693 "filename": "server/api/smsQueueReport/index.js",
23694 "groupTitle": "Sms_Queue_Reports"
23698 "url": "/api/sms/reports/queue/{id}",
23699 "title": "Deletes a Sms Queue Report",
23702 "title": "Example usage:",
23703 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23707 "name": "DeleteSms_Queue_Reports",
23708 "group": "Sms_Queue_Reports",
23709 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23710 "version": "0.0.0",
23711 "filename": "server/api/smsQueueReport/index.js",
23712 "groupTitle": "Sms_Queue_Reports"
23716 "url": "/api/sms/reports/queue/describe",
23717 "title": "Gets table info about Sms Queue Reports",
23720 "title": "Example usage:",
23721 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23725 "name": "DescribeSms_Queue_Reports",
23726 "group": "Sms_Queue_Reports",
23727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23728 "version": "0.0.0",
23729 "filename": "server/api/smsQueueReport/index.js",
23730 "groupTitle": "Sms_Queue_Reports"
23734 "url": "/api/sms/reports/queue",
23735 "title": "Gets a list of Sms Queue Reports",
23738 "title": "Example usage:",
23739 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23743 "name": "GetSms_Queue_Reports",
23744 "group": "Sms_Queue_Reports",
23745 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23746 "version": "0.0.0",
23747 "filename": "server/api/smsQueueReport/index.js",
23748 "groupTitle": "Sms_Queue_Reports"
23752 "url": "/api/sms/reports/queue/{id}",
23753 "title": "Gets a single Sms Queue Report",
23756 "title": "Example usage:",
23757 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23761 "name": "ShowSms_Queue_Reports",
23762 "group": "Sms_Queue_Reports",
23763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23764 "version": "0.0.0",
23765 "filename": "server/api/smsQueueReport/index.js",
23766 "groupTitle": "Sms_Queue_Reports"
23770 "url": "/api/sms/reports/queue/{id}",
23771 "title": "Update an existing Sms Queue Report",
23774 "title": "Example usage:",
23775 "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",
23779 "name": "updateSms_Queue_Reports",
23780 "group": "Sms_Queue_Reports",
23781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23782 "version": "0.0.0",
23783 "filename": "server/api/smsQueueReport/index.js",
23784 "groupTitle": "Sms_Queue_Reports"
23788 "url": "/api/sms/queues/{id}/users",
23789 "title": "Add agents to a queue",
23792 "title": "Example usage:",
23793 "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",
23797 "name": "AddAgents",
23798 "group": "Sms_Queues",
23799 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23800 "version": "0.0.0",
23801 "filename": "server/api/smsQueue/index.js",
23802 "groupTitle": "Sms_Queues"
23806 "url": "/api/sms/queues/{id}/teams",
23807 "title": "Add teams to a queue",
23810 "title": "Example usage:",
23811 "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",
23815 "name": "AddTeams",
23816 "group": "Sms_Queues",
23817 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23818 "version": "0.0.0",
23819 "filename": "server/api/smsQueue/index.js",
23820 "groupTitle": "Sms_Queues"
23824 "url": "/api/sms/queues",
23825 "title": "Creates a new Queue",
23828 "title": "Example usage:",
23829 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23833 "name": "CreateQueues",
23834 "group": "Sms_Queues",
23849 "field": "description",
23856 "field": "timeout",
23868 "field": "strategy",
23874 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23875 "version": "0.0.0",
23876 "filename": "server/api/smsQueue/index.js",
23877 "groupTitle": "Sms_Queues"
23881 "url": "/api/sms/queues/{id}",
23882 "title": "Deletes a Queue",
23885 "title": "Example usage:",
23886 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23890 "name": "DeleteQueues",
23891 "group": "Sms_Queues",
23892 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23893 "version": "0.0.0",
23894 "filename": "server/api/smsQueue/index.js",
23895 "groupTitle": "Sms_Queues"
23899 "url": "/api/sms/queues/describe",
23900 "title": "Gets table info about Queues",
23903 "title": "Example usage:",
23904 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23908 "name": "DescribeQueues",
23909 "group": "Sms_Queues",
23910 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23911 "version": "0.0.0",
23912 "filename": "server/api/smsQueue/index.js",
23913 "groupTitle": "Sms_Queues"
23917 "url": "/api/sms/queues/{id}/users",
23918 "title": "Gets queue agents",
23921 "title": "Example usage:",
23922 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23926 "name": "GetAgents",
23927 "group": "Sms_Queues",
23928 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23929 "version": "0.0.0",
23930 "filename": "server/api/smsQueue/index.js",
23931 "groupTitle": "Sms_Queues"
23935 "url": "/api/sms/queues/{id}/members",
23936 "title": "GetMembers",
23939 "title": "Example usage:",
23940 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23944 "name": "GetMembers",
23945 "group": "Sms_Queues",
23946 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23947 "version": "0.0.0",
23948 "filename": "server/api/smsQueue/index.js",
23949 "groupTitle": "Sms_Queues"
23953 "url": "/api/sms/queues",
23954 "title": "Gets a list of Queues",
23957 "title": "Example usage:",
23958 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23962 "name": "GetQueues",
23963 "group": "Sms_Queues",
23964 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23965 "version": "0.0.0",
23966 "filename": "server/api/smsQueue/index.js",
23967 "groupTitle": "Sms_Queues"
23971 "url": "/api/sms/queues/{id}/teams",
23972 "title": "Gets queues list",
23975 "title": "Example usage:",
23976 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23980 "name": "GetTeams",
23981 "group": "Sms_Queues",
23982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23983 "version": "0.0.0",
23984 "filename": "server/api/smsQueue/index.js",
23985 "groupTitle": "Sms_Queues"
23989 "url": "/api/sms/queues/{id}/users",
23990 "title": "Removes agents from a queue",
23993 "title": "Example usage:",
23994 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23998 "name": "RemoveAgents",
23999 "group": "Sms_Queues",
24000 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24001 "version": "0.0.0",
24002 "filename": "server/api/smsQueue/index.js",
24003 "groupTitle": "Sms_Queues"
24007 "url": "/api/sms/queues/{id}",
24008 "title": "Gets a single Queue",
24011 "title": "Example usage:",
24012 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24016 "name": "ShowQueues",
24017 "group": "Sms_Queues",
24018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24019 "version": "0.0.0",
24020 "filename": "server/api/smsQueue/index.js",
24021 "groupTitle": "Sms_Queues"
24025 "url": "/api/sms/queues/{id}",
24026 "title": "Update an existing Queue",
24029 "title": "Example usage:",
24030 "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",
24034 "name": "updateQueues",
24035 "group": "Sms_Queues",
24036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24037 "version": "0.0.0",
24038 "filename": "server/api/smsQueue/index.js",
24039 "groupTitle": "Sms_Queues"
24043 "url": "/api/sms/reports/transfer",
24044 "title": "Creates a new Sms Transfer Report",
24047 "title": "Example usage:",
24048 "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",
24052 "name": "CreateSms_Transfer_Reports",
24053 "group": "Sms_Transfer_Reports",
24061 "field": "uniqueid",
24080 "field": "transferredAt",
24086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24087 "version": "0.0.0",
24088 "filename": "server/api/smsTransferReport/index.js",
24089 "groupTitle": "Sms_Transfer_Reports"
24093 "url": "/api/sms/reports/transfer/{id}",
24094 "title": "Deletes a Sms Transfer Report",
24097 "title": "Example usage:",
24098 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24102 "name": "DeleteSms_Transfer_Reports",
24103 "group": "Sms_Transfer_Reports",
24104 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24105 "version": "0.0.0",
24106 "filename": "server/api/smsTransferReport/index.js",
24107 "groupTitle": "Sms_Transfer_Reports"
24111 "url": "/api/sms/reports/transfer/describe",
24112 "title": "Gets table info about Sms Transfer Reports",
24115 "title": "Example usage:",
24116 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24120 "name": "DescribeSms_Transfer_Reports",
24121 "group": "Sms_Transfer_Reports",
24122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24123 "version": "0.0.0",
24124 "filename": "server/api/smsTransferReport/index.js",
24125 "groupTitle": "Sms_Transfer_Reports"
24129 "url": "/api/sms/reports/transfer",
24130 "title": "Gets a list of Sms Transfer Reports",
24133 "title": "Example usage:",
24134 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24138 "name": "GetSms_Transfer_Reports",
24139 "group": "Sms_Transfer_Reports",
24140 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24141 "version": "0.0.0",
24142 "filename": "server/api/smsTransferReport/index.js",
24143 "groupTitle": "Sms_Transfer_Reports"
24147 "url": "/api/sms/reports/transfer/{id}",
24148 "title": "Gets a single Sms Transfer Report",
24151 "title": "Example usage:",
24152 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24156 "name": "ShowSms_Transfer_Reports",
24157 "group": "Sms_Transfer_Reports",
24158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24159 "version": "0.0.0",
24160 "filename": "server/api/smsTransferReport/index.js",
24161 "groupTitle": "Sms_Transfer_Reports"
24165 "url": "/api/sms/reports/transfer/{id}",
24166 "title": "Update an existing Sms Transfer Report",
24169 "title": "Example usage:",
24170 "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",
24174 "name": "updateSms_Transfer_Reports",
24175 "group": "Sms_Transfer_Reports",
24176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24177 "version": "0.0.0",
24178 "filename": "server/api/smsTransferReport/index.js",
24179 "groupTitle": "Sms_Transfer_Reports"
24183 "url": "/api/sounds",
24184 "title": "Gets a list of Sounds",
24187 "title": "Example usage:",
24188 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24192 "name": "GetSounds",
24194 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24195 "version": "0.0.0",
24196 "filename": "server/api/sound/index.js",
24197 "groupTitle": "Sounds"
24201 "url": "/api/sounds/{id}",
24202 "title": "Gets a single Sound",
24205 "title": "Example usage:",
24206 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24210 "name": "ShowSounds",
24212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24213 "version": "0.0.0",
24214 "filename": "server/api/sound/index.js",
24215 "groupTitle": "Sounds"
24219 "url": "/api/sounds",
24220 "title": "Create a new sound",
24223 "title": "Example usage:",
24224 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24228 "name": "addSound",
24230 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24231 "version": "0.0.0",
24232 "filename": "server/api/sound/index.js",
24233 "groupTitle": "Sounds"
24237 "url": "/api/sounds/{id}",
24238 "title": "Deletes a sound",
24241 "title": "Example usage:",
24242 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24246 "name": "destroySound",
24248 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24249 "version": "0.0.0",
24250 "filename": "server/api/sound/index.js",
24251 "groupTitle": "Sounds"
24255 "url": "/api/sounds/{id}/download",
24256 "title": "Download Sound",
24259 "title": "Example usage:",
24260 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24264 "name": "download",
24266 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24267 "version": "0.0.0",
24268 "filename": "server/api/sound/index.js",
24269 "groupTitle": "Sounds"
24273 "url": "/api/sounds",
24274 "title": "Update an existing new sound",
24277 "title": "Example usage:",
24278 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24282 "name": "updateSound",
24284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24285 "version": "0.0.0",
24286 "filename": "server/api/sound/index.js",
24287 "groupTitle": "Sounds"
24291 "url": "/api/square/details/reports",
24292 "title": "Creates a new Square Detail Report",
24295 "title": "Example usage:",
24296 "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",
24300 "name": "CreateSquare_Detail_Reports",
24301 "group": "Square_Details_Reports",
24309 "field": "uniqueid",
24323 "field": "application",
24337 "field": "project_name",
24344 "field": "callerid",
24350 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24351 "version": "0.0.0",
24352 "filename": "server/api/squareReportDetail/index.js",
24353 "groupTitle": "Square_Details_Reports"
24357 "url": "/api/square/details/reports/{id}",
24358 "title": "Deletes a Square Detail Report",
24361 "title": "Example usage:",
24362 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24366 "name": "DeleteSquare_Detail_Reports",
24367 "group": "Square_Details_Reports",
24368 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24369 "version": "0.0.0",
24370 "filename": "server/api/squareReportDetail/index.js",
24371 "groupTitle": "Square_Details_Reports"
24375 "url": "/api/square/details/reports/describe",
24376 "title": "Gets table info about Square Detail Reports",
24379 "title": "Example usage:",
24380 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24384 "name": "DescribeSquare_Detail_Reports",
24385 "group": "Square_Details_Reports",
24386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24387 "version": "0.0.0",
24388 "filename": "server/api/squareReportDetail/index.js",
24389 "groupTitle": "Square_Details_Reports"
24393 "url": "/api/square/details/reports",
24394 "title": "Gets a list of Square Detail Reports",
24397 "title": "Example usage:",
24398 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24402 "name": "GetSquare_Detail_Reports",
24403 "group": "Square_Details_Reports",
24404 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24405 "version": "0.0.0",
24406 "filename": "server/api/squareReportDetail/index.js",
24407 "groupTitle": "Square_Details_Reports"
24411 "url": "/api/square/details/reports/{id}",
24412 "title": "Gets a single Square Detail Report",
24415 "title": "Example usage:",
24416 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24420 "name": "ShowSquare_Detail_Reports",
24421 "group": "Square_Details_Reports",
24422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24423 "version": "0.0.0",
24424 "filename": "server/api/squareReportDetail/index.js",
24425 "groupTitle": "Square_Details_Reports"
24429 "url": "/api/square/details/reports/{id}",
24430 "title": "Update an existing Square Detail Report",
24433 "title": "Example usage:",
24434 "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",
24438 "name": "updateSquare_Detail_Reports",
24439 "group": "Square_Details_Reports",
24440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24441 "version": "0.0.0",
24442 "filename": "server/api/squareReportDetail/index.js",
24443 "groupTitle": "Square_Details_Reports"
24447 "url": "/api/square/messages",
24448 "title": "Creates a new Message",
24451 "title": "Example usage:",
24452 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24456 "name": "CreateMessages",
24457 "group": "Square_Messages",
24465 "field": "uniqueid",
24483 "field": "direction",
24490 "field": "providerName",
24497 "field": "providerResponse",
24503 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24504 "version": "0.0.0",
24505 "filename": "server/api/squareMessage/index.js",
24506 "groupTitle": "Square_Messages"
24510 "url": "/api/square/messages/{id}",
24511 "title": "Deletes a Message",
24514 "title": "Example usage:",
24515 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24519 "name": "DeleteMessages",
24520 "group": "Square_Messages",
24521 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24522 "version": "0.0.0",
24523 "filename": "server/api/squareMessage/index.js",
24524 "groupTitle": "Square_Messages"
24528 "url": "/api/square/messages",
24529 "title": "Gets a list of Messages",
24532 "title": "Example usage:",
24533 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24537 "name": "GetMessages",
24538 "group": "Square_Messages",
24539 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24540 "version": "0.0.0",
24541 "filename": "server/api/squareMessage/index.js",
24542 "groupTitle": "Square_Messages"
24546 "url": "/api/square/messages/{id}",
24547 "title": "Gets a single Message",
24550 "title": "Example usage:",
24551 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24555 "name": "ShowMessages",
24556 "group": "Square_Messages",
24557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24558 "version": "0.0.0",
24559 "filename": "server/api/squareMessage/index.js",
24560 "groupTitle": "Square_Messages"
24564 "url": "/api/square/messages/{id}",
24565 "title": "Update an existing Message",
24568 "title": "Example usage:",
24569 "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",
24573 "name": "updateMessages",
24574 "group": "Square_Messages",
24575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24576 "version": "0.0.0",
24577 "filename": "server/api/squareMessage/index.js",
24578 "groupTitle": "Square_Messages"
24582 "url": "/api/square/odbc",
24583 "title": "Creates a new ODBC",
24586 "title": "Example usage:",
24587 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24591 "name": "CreateODBCs",
24592 "group": "Square_ODBC",
24614 "field": "description",
24620 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24621 "version": "0.0.0",
24622 "filename": "server/api/squareOdbc/index.js",
24623 "groupTitle": "Square_ODBC"
24627 "url": "/api/square/odbc/{id}",
24628 "title": "Deletes a ODBC",
24631 "title": "Example usage:",
24632 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24636 "name": "DeleteODBCs",
24637 "group": "Square_ODBC",
24638 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24639 "version": "0.0.0",
24640 "filename": "server/api/squareOdbc/index.js",
24641 "groupTitle": "Square_ODBC"
24645 "url": "/api/square/odbc",
24646 "title": "Gets a list of ODBCs",
24649 "title": "Example usage:",
24650 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24654 "name": "GetODBCs",
24655 "group": "Square_ODBC",
24656 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24657 "version": "0.0.0",
24658 "filename": "server/api/squareOdbc/index.js",
24659 "groupTitle": "Square_ODBC"
24663 "url": "/api/square/odbc/{id}",
24664 "title": "Gets a single ODBC",
24667 "title": "Example usage:",
24668 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24672 "name": "ShowODBCs",
24673 "group": "Square_ODBC",
24674 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24675 "version": "0.0.0",
24676 "filename": "server/api/squareOdbc/index.js",
24677 "groupTitle": "Square_ODBC"
24681 "url": "/api/square/odbc/{id}/test",
24682 "title": "Test Odbc",
24685 "title": "Example usage:",
24686 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24691 "group": "Square_ODBC",
24692 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24693 "version": "0.0.0",
24694 "filename": "server/api/squareOdbc/index.js",
24695 "groupTitle": "Square_ODBC"
24699 "url": "/api/square/odbc/{id}",
24700 "title": "Update an existing ODBC",
24703 "title": "Example usage:",
24704 "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",
24708 "name": "updateODBCs",
24709 "group": "Square_ODBC",
24710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24711 "version": "0.0.0",
24712 "filename": "server/api/squareOdbc/index.js",
24713 "groupTitle": "Square_ODBC"
24717 "url": "/api/square/projects",
24718 "title": "Creates a new Project",
24721 "title": "Example usage:",
24722 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24726 "name": "CreateProjects",
24727 "group": "Square_Projects",
24742 "field": "description",
24756 "field": "preproduction",
24763 "field": "production",
24770 "field": "savedAt",
24777 "field": "publishedAt",
24783 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24784 "version": "0.0.0",
24785 "filename": "server/api/squareProject/index.js",
24786 "groupTitle": "Square_Projects"
24790 "url": "/api/square/projects/{id}",
24791 "title": "Deletes a Project",
24794 "title": "Example usage:",
24795 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24799 "name": "DeleteProjects",
24800 "group": "Square_Projects",
24801 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24802 "version": "0.0.0",
24803 "filename": "server/api/squareProject/index.js",
24804 "groupTitle": "Square_Projects"
24808 "url": "/api/square/projects",
24809 "title": "Gets a list of Projects",
24812 "title": "Example usage:",
24813 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24817 "name": "GetProjects",
24818 "group": "Square_Projects",
24819 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24820 "version": "0.0.0",
24821 "filename": "server/api/squareProject/index.js",
24822 "groupTitle": "Square_Projects"
24826 "url": "/api/square/projects/{id}",
24827 "title": "Gets a single Project",
24830 "title": "Example usage:",
24831 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24835 "name": "ShowProjects",
24836 "group": "Square_Projects",
24837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24838 "version": "0.0.0",
24839 "filename": "server/api/squareProject/index.js",
24840 "groupTitle": "Square_Projects"
24844 "url": "/api/square/projects/{id}/users",
24845 "title": "Adds user permissions to a Project",
24848 "title": "Example usage:",
24849 "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",
24853 "name": "addUsers",
24854 "group": "Square_Projects",
24855 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24856 "version": "0.0.0",
24857 "filename": "server/api/squareProject/index.js",
24858 "groupTitle": "Square_Projects"
24862 "url": "/api/square/projects/{id}/users",
24863 "title": "Gets users permissions from Project",
24866 "title": "Example usage:",
24867 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24871 "name": "getUsers",
24872 "group": "Square_Projects",
24873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24874 "version": "0.0.0",
24875 "filename": "server/api/squareProject/index.js",
24876 "groupTitle": "Square_Projects"
24880 "url": "/api/square/projects/{id}/users",
24881 "title": "Removes user permissions from a Project",
24884 "title": "Example usage:",
24885 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24889 "name": "removeUsers",
24890 "group": "Square_Projects",
24891 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24892 "version": "0.0.0",
24893 "filename": "server/api/squareProject/index.js",
24894 "groupTitle": "Square_Projects"
24898 "url": "/api/square/projects/{id}",
24899 "title": "Update an existing Project",
24902 "title": "Example usage:",
24903 "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",
24907 "name": "updateProjects",
24908 "group": "Square_Projects",
24909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24910 "version": "0.0.0",
24911 "filename": "server/api/squareProject/index.js",
24912 "groupTitle": "Square_Projects"
24916 "url": "/api/square/recordings",
24917 "title": "Creates a new Recording",
24920 "title": "Example usage:",
24921 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24925 "name": "CreateRecordings",
24926 "group": "Square_Recordings",
24934 "field": "uniqueid",
24941 "field": "callerid",
24948 "field": "calleridname",
24955 "field": "context",
24962 "field": "extension",
24969 "field": "priority",
24976 "field": "accountcode",
24990 "field": "projectName",
24997 "field": "saveName",
25004 "field": "filename",
25011 "field": "savePath",
25024 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25025 "version": "0.0.0",
25026 "filename": "server/api/squareRecording/index.js",
25027 "groupTitle": "Square_Recordings"
25031 "url": "/api/square/recordings",
25032 "title": "Gets a list of Recordings",
25035 "title": "Example usage:",
25036 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25040 "name": "GetRecordings",
25041 "group": "Square_Recordings",
25042 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25043 "version": "0.0.0",
25044 "filename": "server/api/squareRecording/index.js",
25045 "groupTitle": "Square_Recordings"
25049 "url": "/api/square/recordings/{id}",
25050 "title": "Gets a single Recording",
25053 "title": "Example usage:",
25054 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25058 "name": "ShowRecordings",
25059 "group": "Square_Recordings",
25060 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25061 "version": "0.0.0",
25062 "filename": "server/api/squareRecording/index.js",
25063 "groupTitle": "Square_Recordings"
25067 "url": "/api/square/recordings/{id}",
25068 "title": "Delete recording",
25071 "title": "Example usage:",
25072 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25077 "group": "Square_Recordings",
25078 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25079 "version": "0.0.0",
25080 "filename": "server/api/squareRecording/index.js",
25081 "groupTitle": "Square_Recordings"
25085 "url": "/api/square/recordings/{id}/download",
25086 "title": "Download Recording",
25089 "title": "Example usage:",
25090 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25094 "name": "download",
25095 "group": "Square_Recordings",
25096 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25097 "version": "0.0.0",
25098 "filename": "server/api/squareRecording/index.js",
25099 "groupTitle": "Square_Recordings"
25103 "url": "/api/square/recordings/{id}",
25104 "title": "Update an existing Recording",
25107 "title": "Example usage:",
25108 "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",
25112 "name": "updateRecordings",
25113 "group": "Square_Recordings",
25114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25115 "version": "0.0.0",
25116 "filename": "server/api/squareRecording/index.js",
25117 "groupTitle": "Square_Recordings"
25121 "url": "/api/square/reports",
25122 "title": "Creates a new Square Report",
25125 "title": "Example usage:",
25126 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25130 "name": "CreateSquare_Reports",
25131 "group": "Square_Reports",
25139 "field": "network",
25146 "field": "network_script",
25153 "field": "request",
25160 "field": "channel",
25167 "field": "language",
25181 "field": "uniqueid",
25188 "field": "version",
25195 "field": "callerid",
25202 "field": "calleridname",
25209 "field": "callingpres",
25216 "field": "callingani2",
25223 "field": "callington",
25230 "field": "callingtns",
25251 "field": "context",
25258 "field": "extension",
25265 "field": "priority",
25272 "field": "enhanced",
25279 "field": "accountcode",
25286 "field": "threadid",
25293 "field": "project_name",
25307 "field": "leaveAt",
25320 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25321 "version": "0.0.0",
25322 "filename": "server/api/squareReport/index.js",
25323 "groupTitle": "Square_Reports"
25327 "url": "/api/square/reports/{id}",
25328 "title": "Deletes a Square Report",
25331 "title": "Example usage:",
25332 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25336 "name": "DeleteSquare_Reports",
25337 "group": "Square_Reports",
25338 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25339 "version": "0.0.0",
25340 "filename": "server/api/squareReport/index.js",
25341 "groupTitle": "Square_Reports"
25345 "url": "/api/square/reports/describe",
25346 "title": "Gets table info about Square Reports",
25349 "title": "Example usage:",
25350 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25354 "name": "DescribeSquare_Reports",
25355 "group": "Square_Reports",
25356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25357 "version": "0.0.0",
25358 "filename": "server/api/squareReport/index.js",
25359 "groupTitle": "Square_Reports"
25363 "url": "/api/square/reports",
25364 "title": "Gets a list of Square Reports",
25367 "title": "Example usage:",
25368 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25372 "name": "GetSquare_Reports",
25373 "group": "Square_Reports",
25374 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25375 "version": "0.0.0",
25376 "filename": "server/api/squareReport/index.js",
25377 "groupTitle": "Square_Reports"
25381 "url": "/api/square/reports/{id}",
25382 "title": "Gets a single Square Report",
25385 "title": "Example usage:",
25386 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25390 "name": "ShowSquare_Reports",
25391 "group": "Square_Reports",
25392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25393 "version": "0.0.0",
25394 "filename": "server/api/squareReport/index.js",
25395 "groupTitle": "Square_Reports"
25399 "url": "/api/square/reports/{id}",
25400 "title": "Update an existing Square Report",
25403 "title": "Example usage:",
25404 "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",
25408 "name": "updateSquare_Reports",
25409 "group": "Square_Reports",
25410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25411 "version": "0.0.0",
25412 "filename": "server/api/squareReport/index.js",
25413 "groupTitle": "Square_Reports"
25417 "url": "/api/integrations/sugarcrm/configurations",
25418 "title": "Creates a new SugarCRM Configuration",
25421 "title": "Example usage:",
25422 "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",
25426 "name": "CreateSugarCRM_Configurations",
25427 "group": "SugarCRM_Configurations",
25442 "field": "description",
25448 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25449 "version": "0.0.0",
25450 "filename": "server/api/intSugarcrmConfiguration/index.js",
25451 "groupTitle": "SugarCRM_Configurations"
25455 "url": "/api/integrations/sugarcrm/configurations/{id}",
25456 "title": "Deletes a SugarCRM Configuration",
25459 "title": "Example usage:",
25460 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25464 "name": "DeleteSugarCRM_Configurations",
25465 "group": "SugarCRM_Configurations",
25466 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25467 "version": "0.0.0",
25468 "filename": "server/api/intSugarcrmConfiguration/index.js",
25469 "groupTitle": "SugarCRM_Configurations"
25473 "url": "/api/integrations/sugarcrm/configurations",
25474 "title": "Gets a list of SugarCRM Configurations",
25477 "title": "Example usage:",
25478 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25482 "name": "GetSugarCRM_Configurations",
25483 "group": "SugarCRM_Configurations",
25484 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25485 "version": "0.0.0",
25486 "filename": "server/api/intSugarcrmConfiguration/index.js",
25487 "groupTitle": "SugarCRM_Configurations"
25491 "url": "/api/integrations/sugarcrm/configurations/{id}",
25492 "title": "Gets a single SugarCRM Configuration",
25495 "title": "Example usage:",
25496 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25500 "name": "ShowSugarCRM_Configurations",
25501 "group": "SugarCRM_Configurations",
25502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25503 "version": "0.0.0",
25504 "filename": "server/api/intSugarcrmConfiguration/index.js",
25505 "groupTitle": "SugarCRM_Configurations"
25509 "url": "/api/integrations/sugarcrm/configurations/{id}",
25510 "title": "Update an existing SugarCRM Configuration",
25513 "title": "Example usage:",
25514 "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",
25518 "name": "updateSugarCRM_Configurations",
25519 "group": "SugarCRM_Configurations",
25520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25521 "version": "0.0.0",
25522 "filename": "server/api/intSugarcrmConfiguration/index.js",
25523 "groupTitle": "SugarCRM_Configurations"
25527 "url": "/api/integrations/sugarcrm/accounts",
25528 "title": "Creates a new Sugarcrm Account",
25531 "title": "Example usage:",
25532 "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",
25536 "name": "CreateSugarcrm_Accounts",
25537 "group": "Sugarcrm_Accounts",
25552 "field": "description",
25559 "field": "username",
25566 "field": "password",
25573 "field": "remoteUri",
25580 "field": "serverUrl",
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/intSugarcrmAccount/index.js",
25589 "groupTitle": "Sugarcrm_Accounts"
25593 "url": "/api/integrations/sugarcrm/accounts/{id}",
25594 "title": "Deletes a Sugarcrm Account",
25597 "title": "Example usage:",
25598 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25602 "name": "DeleteSugarcrm_Accounts",
25603 "group": "Sugarcrm_Accounts",
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/intSugarcrmAccount/index.js",
25607 "groupTitle": "Sugarcrm_Accounts"
25611 "url": "/api/integrations/sugarcrm/accounts",
25612 "title": "Gets a list of Sugarcrm Accounts",
25615 "title": "Example usage:",
25616 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25620 "name": "GetSugarcrm_Accounts",
25621 "group": "Sugarcrm_Accounts",
25622 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25623 "version": "0.0.0",
25624 "filename": "server/api/intSugarcrmAccount/index.js",
25625 "groupTitle": "Sugarcrm_Accounts"
25629 "url": "/api/integrations/sugarcrm/accounts/{id}",
25630 "title": "Gets a single Sugarcrm Account",
25633 "title": "Example usage:",
25634 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25638 "name": "ShowSugarcrm_Accounts",
25639 "group": "Sugarcrm_Accounts",
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/intSugarcrmAccount/index.js",
25643 "groupTitle": "Sugarcrm_Accounts"
25647 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25648 "title": "Creates new configuration",
25651 "title": "Example usage:",
25652 "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",
25656 "name": "addConfiguration",
25657 "group": "Sugarcrm_Accounts",
25658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25659 "version": "0.0.0",
25660 "filename": "server/api/intSugarcrmAccount/index.js",
25661 "groupTitle": "Sugarcrm_Accounts"
25665 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25666 "title": "Gets account configurations",
25669 "title": "Example usage:",
25670 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25674 "name": "getConfigurations",
25675 "group": "Sugarcrm_Accounts",
25676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
25679 "groupTitle": "Sugarcrm_Accounts"
25683 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25684 "title": "Gets account fields",
25687 "title": "Example usage:",
25688 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25692 "name": "getFields",
25693 "group": "Sugarcrm_Accounts",
25694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
25697 "groupTitle": "Sugarcrm_Accounts"
25701 "url": "/api/integrations/sugarcrm/accounts/{id}",
25702 "title": "Update an existing Sugarcrm Account",
25705 "title": "Example usage:",
25706 "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",
25710 "name": "updateSugarcrm_Accounts",
25711 "group": "Sugarcrm_Accounts",
25712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
25715 "groupTitle": "Sugarcrm_Accounts"
25719 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25720 "title": "Gets configurations descriptions",
25723 "title": "Example usage:",
25724 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25728 "name": "getDescriptions",
25729 "group": "Sugarcrm_Configurations",
25730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmConfiguration/index.js",
25733 "groupTitle": "Sugarcrm_Configurations"
25737 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25738 "title": "Gets configurations fields",
25741 "title": "Example usage:",
25742 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25746 "name": "getFields",
25747 "group": "Sugarcrm_Configurations",
25748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmConfiguration/index.js",
25751 "groupTitle": "Sugarcrm_Configurations"
25755 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25756 "title": "Gets configurations subjects",
25759 "title": "Example usage:",
25760 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25764 "name": "getSubjects",
25765 "group": "Sugarcrm_Configurations",
25766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmConfiguration/index.js",
25769 "groupTitle": "Sugarcrm_Configurations"
25773 "url": "/api/integrations/sugarcrm/fields",
25774 "title": "Creates a new Sugarcrm Field",
25777 "title": "Example usage:",
25778 "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",
25782 "name": "CreateSugarcrm_Fields",
25783 "group": "Sugarcrm_Fields",
25793 "\"customVariable\"",
25805 "field": "content",
25821 "\"customVariable\""
25824 "field": "keyType",
25831 "field": "keyContent",
25838 "field": "idField",
25845 "field": "nameField",
25852 "field": "customField",
25859 "field": "variableName",
25865 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25866 "version": "0.0.0",
25867 "filename": "server/api/intSugarcrmField/index.js",
25868 "groupTitle": "Sugarcrm_Fields"
25872 "url": "/api/integrations/sugarcrm/fields/{id}",
25873 "title": "Deletes a Sugarcrm Field",
25876 "title": "Example usage:",
25877 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25881 "name": "DeleteSugarcrm_Fields",
25882 "group": "Sugarcrm_Fields",
25883 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25884 "version": "0.0.0",
25885 "filename": "server/api/intSugarcrmField/index.js",
25886 "groupTitle": "Sugarcrm_Fields"
25890 "url": "/api/integrations/sugarcrm/fields",
25891 "title": "Gets a list of Sugarcrm Fields",
25894 "title": "Example usage:",
25895 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25899 "name": "GetSugarcrm_Fields",
25900 "group": "Sugarcrm_Fields",
25901 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25902 "version": "0.0.0",
25903 "filename": "server/api/intSugarcrmField/index.js",
25904 "groupTitle": "Sugarcrm_Fields"
25908 "url": "/api/integrations/sugarcrm/fields/{id}",
25909 "title": "Gets a single Sugarcrm Field",
25912 "title": "Example usage:",
25913 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25917 "name": "ShowSugarcrm_Fields",
25918 "group": "Sugarcrm_Fields",
25919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25920 "version": "0.0.0",
25921 "filename": "server/api/intSugarcrmField/index.js",
25922 "groupTitle": "Sugarcrm_Fields"
25926 "url": "/api/integrations/sugarcrm/fields/{id}",
25927 "title": "Update an existing Sugarcrm Field",
25930 "title": "Example usage:",
25931 "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",
25935 "name": "updateSugarcrm_Fields",
25936 "group": "Sugarcrm_Fields",
25937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSugarcrmField/index.js",
25940 "groupTitle": "Sugarcrm_Fields"
25944 "url": "/api/system",
25945 "title": "Gets system information",
25948 "title": "Example usage:",
25949 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25953 "name": "GetSystemInformation",
25954 "group": "System_Information",
25955 "description": "<p>Motion returns the system information.</p>",
25956 "version": "0.0.0",
25957 "filename": "server/api/system/index.js",
25958 "groupTitle": "System_Information"
25962 "url": "/api/system/process",
25963 "title": "Gets system information",
25966 "title": "Example usage:",
25967 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25971 "name": "GetSystemInformation",
25972 "group": "System_Information",
25973 "description": "<p>Motion returns the system information.</p>",
25974 "version": "0.0.0",
25975 "filename": "server/api/system/index.js",
25976 "groupTitle": "System_Information"
25980 "url": "/api/tags",
25981 "title": "Creates a new Tag",
25984 "title": "Example usage:",
25985 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25989 "name": "CreateTags",
26012 "field": "description",
26018 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26019 "version": "0.0.0",
26020 "filename": "server/api/tag/index.js",
26021 "groupTitle": "Tags"
26025 "url": "/api/tags/{id}",
26026 "title": "Deletes a Tag",
26029 "title": "Example usage:",
26030 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26034 "name": "DeleteTags",
26036 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26037 "version": "0.0.0",
26038 "filename": "server/api/tag/index.js",
26039 "groupTitle": "Tags"
26043 "url": "/api/tags",
26044 "title": "Gets a list of Tags",
26047 "title": "Example usage:",
26048 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26054 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26055 "version": "0.0.0",
26056 "filename": "server/api/tag/index.js",
26057 "groupTitle": "Tags"
26061 "url": "/api/tags/{id}",
26062 "title": "Gets a single Tag",
26065 "title": "Example usage:",
26066 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26070 "name": "ShowTags",
26072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26073 "version": "0.0.0",
26074 "filename": "server/api/tag/index.js",
26075 "groupTitle": "Tags"
26079 "url": "/api/tags/{id}",
26080 "title": "Update an existing Tag",
26083 "title": "Example usage:",
26084 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26088 "name": "updateTags",
26090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26091 "version": "0.0.0",
26092 "filename": "server/api/tag/index.js",
26093 "groupTitle": "Tags"
26097 "url": "/api/teams/{id}/queues",
26098 "title": "Add queues to a team",
26101 "title": "Example usage:",
26102 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26106 "name": "AddQueues",
26108 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26109 "version": "0.0.0",
26110 "filename": "server/api/team/index.js",
26111 "groupTitle": "Teams"
26115 "url": "/api/teams",
26116 "title": "Creates a new Team",
26119 "title": "Example usage:",
26120 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26124 "name": "CreateTeams",
26140 "field": "description",
26146 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26147 "version": "0.0.0",
26148 "filename": "server/api/team/index.js",
26149 "groupTitle": "Teams"
26153 "url": "/api/teams/{id}",
26154 "title": "Deletes a Team",
26157 "title": "Example usage:",
26158 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26162 "name": "DeleteTeams",
26164 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26165 "version": "0.0.0",
26166 "filename": "server/api/team/index.js",
26167 "groupTitle": "Teams"
26171 "url": "/api/teams/{id}/users",
26172 "title": "Gets agents from team",
26175 "title": "Example usage:",
26176 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26180 "name": "GetAgents",
26182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183 "version": "0.0.0",
26184 "filename": "server/api/team/index.js",
26185 "groupTitle": "Teams"
26189 "url": "/api/teams/{id}/queues?channel={channel}",
26190 "title": "Gets Queues list",
26193 "title": "Example usage:",
26194 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26198 "name": "GetQueues",
26200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26201 "version": "0.0.0",
26202 "filename": "server/api/team/index.js",
26203 "groupTitle": "Teams"
26207 "url": "/api/teams",
26208 "title": "Gets a list of Teams",
26211 "title": "Example usage:",
26212 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26216 "name": "GetTeams",
26218 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
26219 "version": "0.0.0",
26220 "filename": "server/api/team/index.js",
26221 "groupTitle": "Teams"
26225 "url": "/api/teams/{id}/users",
26226 "title": "Removes agents from a team",
26229 "title": "Example usage:",
26230 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26234 "name": "RemoveAgents",
26236 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26237 "version": "0.0.0",
26238 "filename": "server/api/team/index.js",
26239 "groupTitle": "Teams"
26243 "url": "/api/teams/{id}/queues",
26244 "title": "Remove queues to a team",
26247 "title": "Example usage:",
26248 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26252 "name": "RemoveQueues",
26254 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26255 "version": "0.0.0",
26256 "filename": "server/api/team/index.js",
26257 "groupTitle": "Teams"
26261 "url": "/api/voice/Prefixes/{id}/teams",
26262 "title": "Remove teams from a voice prefix",
26265 "title": "Example usage:",
26266 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26270 "name": "RemoveTeams",
26272 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26273 "version": "0.0.0",
26274 "filename": "server/api/voicePrefix/index.js",
26275 "groupTitle": "Teams"
26279 "url": "/api/openchannel/queues/{id}/teams",
26280 "title": "Remove teams from a queue",
26283 "title": "Example usage:",
26284 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26288 "name": "RemoveTeams",
26290 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26291 "version": "0.0.0",
26292 "filename": "server/api/openchannelQueue/index.js",
26293 "groupTitle": "Teams"
26297 "url": "/api/chat/queues/{id}/teams",
26298 "title": "Remove teams from a queue",
26301 "title": "Example usage:",
26302 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26306 "name": "RemoveTeams",
26308 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26309 "version": "0.0.0",
26310 "filename": "server/api/chatQueue/index.js",
26311 "groupTitle": "Teams"
26315 "url": "/api/sms/queues/{id}/teams",
26316 "title": "Remove teams from a queue",
26319 "title": "Example usage:",
26320 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26324 "name": "RemoveTeams",
26326 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26327 "version": "0.0.0",
26328 "filename": "server/api/smsQueue/index.js",
26329 "groupTitle": "Teams"
26333 "url": "/api/fax/queues/{id}/teams",
26334 "title": "Remove teams from a queue",
26337 "title": "Example usage:",
26338 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26342 "name": "RemoveTeams",
26344 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26345 "version": "0.0.0",
26346 "filename": "server/api/faxQueue/index.js",
26347 "groupTitle": "Teams"
26351 "url": "/api/voice/queues/{id}/teams",
26352 "title": "Remove teams from a queue",
26355 "title": "Example usage:",
26356 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26360 "name": "RemoveTeams",
26362 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26363 "version": "0.0.0",
26364 "filename": "server/api/voiceQueue/index.js",
26365 "groupTitle": "Teams"
26369 "url": "/api/mail/queues/{id}/teams",
26370 "title": "Remove teams from a queue",
26373 "title": "Example usage:",
26374 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26378 "name": "RemoveTeams",
26380 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26381 "version": "0.0.0",
26382 "filename": "server/api/mailQueue/index.js",
26383 "groupTitle": "Teams"
26387 "url": "/api/whatsapp/queues/{id}/teams",
26388 "title": "Remove teams from a queue",
26391 "title": "Example usage:",
26392 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26396 "name": "RemoveTeams",
26398 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26399 "version": "0.0.0",
26400 "filename": "server/api/whatsappQueue/index.js",
26401 "groupTitle": "Teams"
26405 "url": "/api/teams/{id}",
26406 "title": "Gets a single Team",
26409 "title": "Example usage:",
26410 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26414 "name": "ShowTeams",
26416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26417 "version": "0.0.0",
26418 "filename": "server/api/team/index.js",
26419 "groupTitle": "Teams"
26423 "url": "/api/teams/{id}/users",
26424 "title": "Adds agents to a team",
26427 "title": "Example usage:",
26428 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26432 "name": "addAgents",
26434 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26435 "version": "0.0.0",
26436 "filename": "server/api/team/index.js",
26437 "groupTitle": "Teams"
26441 "url": "/api/teams/{id}",
26442 "title": "Update an existing Team",
26445 "title": "Example usage:",
26446 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26450 "name": "updateTeams",
26452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26453 "version": "0.0.0",
26454 "filename": "server/api/team/index.js",
26455 "groupTitle": "Teams"
26459 "url": "/api/templates",
26460 "title": "Creates a new Template",
26463 "title": "Example usage:",
26464 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26468 "name": "CreateTemplates",
26469 "group": "Templates",
26484 "field": "description",
26497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26498 "version": "0.0.0",
26499 "filename": "server/api/template/index.js",
26500 "groupTitle": "Templates"
26504 "url": "/api/templates/{id}",
26505 "title": "Deletes a Template",
26508 "title": "Example usage:",
26509 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26513 "name": "DeleteTemplates",
26514 "group": "Templates",
26515 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26516 "version": "0.0.0",
26517 "filename": "server/api/template/index.js",
26518 "groupTitle": "Templates"
26522 "url": "/api/templates",
26523 "title": "Gets a list of Templates",
26526 "title": "Example usage:",
26527 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26531 "name": "GetTemplates",
26532 "group": "Templates",
26533 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26534 "version": "0.0.0",
26535 "filename": "server/api/template/index.js",
26536 "groupTitle": "Templates"
26540 "url": "/api/templates/{id}",
26541 "title": "Gets a single Template",
26544 "title": "Example usage:",
26545 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26549 "name": "ShowTemplates",
26550 "group": "Templates",
26551 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26552 "version": "0.0.0",
26553 "filename": "server/api/template/index.js",
26554 "groupTitle": "Templates"
26558 "url": "/api/templates/{id}",
26559 "title": "Update an existing Template",
26562 "title": "Example usage:",
26563 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26567 "name": "updateTemplates",
26568 "group": "Templates",
26569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26570 "version": "0.0.0",
26571 "filename": "server/api/template/index.js",
26572 "groupTitle": "Templates"
26576 "url": "/api/triggers",
26577 "title": "Creates a new Trigger",
26580 "title": "Example usage:",
26581 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26585 "name": "CreateTriggers",
26586 "group": "Triggers",
26601 "field": "channel",
26608 "field": "description",
26621 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26622 "version": "0.0.0",
26623 "filename": "server/api/trigger/index.js",
26624 "groupTitle": "Triggers"
26628 "url": "/api/triggers/{id}",
26629 "title": "Deletes a Trigger",
26632 "title": "Example usage:",
26633 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26637 "name": "DeleteTriggers",
26638 "group": "Triggers",
26639 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26640 "version": "0.0.0",
26641 "filename": "server/api/trigger/index.js",
26642 "groupTitle": "Triggers"
26646 "url": "/api/triggers",
26647 "title": "Gets a list of Triggers",
26650 "title": "Example usage:",
26651 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26655 "name": "GetTriggers",
26656 "group": "Triggers",
26657 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26658 "version": "0.0.0",
26659 "filename": "server/api/trigger/index.js",
26660 "groupTitle": "Triggers"
26664 "url": "/api/triggers/{id}",
26665 "title": "Gets a single Trigger",
26668 "title": "Example usage:",
26669 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26673 "name": "ShowTriggers",
26674 "group": "Triggers",
26675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26676 "version": "0.0.0",
26677 "filename": "server/api/trigger/index.js",
26678 "groupTitle": "Triggers"
26682 "url": "/api/triggers/{id}/actions",
26683 "title": "Creates new actions",
26686 "title": "Example usage:",
26687 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26691 "name": "addAction",
26692 "group": "Triggers",
26708 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26715 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26722 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26729 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26762 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26763 "version": "0.0.0",
26764 "filename": "server/api/trigger/index.js",
26765 "groupTitle": "Triggers"
26769 "url": "/api/triggers/{id}/all_conditions",
26770 "title": "Creates a new \"AND\"condition",
26773 "title": "Example usage:",
26774 "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",
26778 "name": "addAllCondition",
26779 "group": "Triggers",
26801 "field": "operator",
26814 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26815 "version": "0.0.0",
26816 "filename": "server/api/trigger/index.js",
26817 "groupTitle": "Triggers"
26821 "url": "/api/triggers/{id}/any_conditions",
26822 "title": "Creates a new \"OR\"condition",
26825 "title": "Example usage:",
26826 "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",
26830 "name": "addAnyCondition",
26831 "group": "Triggers",
26853 "field": "operator",
26866 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26867 "version": "0.0.0",
26868 "filename": "server/api/trigger/index.js",
26869 "groupTitle": "Triggers"
26873 "url": "/api/triggers/{id}/actions",
26874 "title": "Gets Trigger Actions",
26877 "title": "Example usage:",
26878 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26882 "name": "getActions",
26883 "group": "Triggers",
26884 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26885 "version": "0.0.0",
26886 "filename": "server/api/trigger/index.js",
26887 "groupTitle": "Triggers"
26891 "url": "/api/triggers/{id}/all_conditions",
26892 "title": "Gets \"AND\" Trigger Conditions",
26895 "title": "Example usage:",
26896 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26900 "name": "getAllConditions",
26901 "group": "Triggers",
26902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26903 "version": "0.0.0",
26904 "filename": "server/api/trigger/index.js",
26905 "groupTitle": "Triggers"
26909 "url": "/api/triggers/{id}/any_conditions",
26910 "title": "Gets \"OR\" Trigger Conditions",
26913 "title": "Example usage:",
26914 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26918 "name": "getAnyConditions",
26919 "group": "Triggers",
26920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26921 "version": "0.0.0",
26922 "filename": "server/api/trigger/index.js",
26923 "groupTitle": "Triggers"
26927 "url": "/api/triggers/{id}",
26928 "title": "Update an existing Trigger",
26931 "title": "Example usage:",
26932 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26936 "name": "updateTriggers",
26937 "group": "Triggers",
26938 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26939 "version": "0.0.0",
26940 "filename": "server/api/trigger/index.js",
26941 "groupTitle": "Triggers"
26945 "url": "/api/trunks/clone",
26946 "title": "Clone an existing Trunk",
26949 "title": "Example usage:",
26950 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26954 "name": "CloneTrunks",
26956 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26957 "version": "0.0.0",
26958 "filename": "server/api/trunk/index.js",
26959 "groupTitle": "Trunks"
26963 "url": "/api/trunks",
26964 "title": "Create a new trunk",
26967 "title": "Example usage:",
26968 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27000 "field": "context",
27007 "\"ALLOWED_NOT_SCREENED\"",
27008 "\"ALLOWED_PASSED_SCREEN\"",
27009 "\"ALLOWED_FAILED_SCREEN\"",
27011 "\"PROHIB_NOT_SCREENED\"",
27012 "\"PROHIB_PASSED_SCREEN\"",
27013 "\"PROHIB_FAILED_SCREEN\"",
27017 "field": "callingpres",
27045 "field": "md5secret",
27052 "field": "remotesecret",
27059 "field": "transport",
27060 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
27073 "field": "dtmfmode",
27087 "field": "directmedia",
27098 "field": "directrtpsetup",
27105 "field": "directmediapermit",
27112 "field": "directmediadeny",
27120 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27126 "field": "callgroup",
27133 "field": "namedcallgroup",
27140 "field": "pickupgroup",
27147 "field": "namedpickupgroup",
27154 "field": "language",
27161 "field": "tonezone",
27168 "field": "disallow",
27176 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27186 "field": "autoframing",
27193 "field": "insecure",
27194 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27204 "field": "trustrpid",
27215 "field": "trust_id_outbound",
27227 "field": "progressinband",
27238 "field": "promiscredir",
27249 "field": "useclientcode",
27256 "field": "accountcode",
27270 "field": "callerid",
27277 "field": "amaflags",
27288 "field": "callcounter",
27295 "field": "busylevel",
27306 "field": "allowoverlap",
27317 "field": "allowsubscribe",
27328 "field": "allowtransfer",
27339 "field": "ignoresdpversion",
27346 "field": "subscribecontext",
27353 "field": "template",
27365 "field": "videosupport",
27372 "field": "maxcallbitrate",
27383 "field": "rfc2833compensate",
27390 "field": "mailbox",
27402 "field": "session_timers",
27409 "field": "session_expires",
27416 "field": "session_minse",
27427 "field": "session_refresher",
27434 "field": "t38pt_usertpsource",
27441 "field": "regexten",
27448 "field": "fromdomain",
27455 "field": "fromuser",
27473 "field": "qualify",
27480 "field": "keepalive",
27487 "field": "defaultip",
27494 "field": "defaultuser",
27501 "field": "rtptimeout",
27508 "field": "rtpholdtimeout",
27515 "field": "rtpkeepalive",
27527 "field": "sendrpid",
27534 "field": "outboundproxy",
27541 "field": "callbackextension",
27548 "field": "timert1",
27562 "field": "qualifyfreq",
27569 "field": "contactpermit",
27576 "field": "contactdeny",
27583 "field": "contactacl",
27590 "field": "unsolicited_mailbox",
27597 "field": "use_q850_reason",
27604 "field": "maxforwards",
27615 "field": "encryption",
27637 "field": "force_avp",
27648 "field": "icesupport",
27659 "field": "dtlsenable",
27672 "field": "dtlsverify",
27679 "field": "dtlsrekey",
27686 "field": "dtlscertfile",
27693 "field": "dtlsprivatekey",
27700 "field": "dtlscipher",
27707 "field": "dtlscafile",
27714 "field": "dtlscapath",
27726 "field": "dtlssetup",
27733 "field": "dtlsfingerprint",
27744 "field": "usereqphone",
27751 "field": "recordonfeature",
27758 "field": "recordofffeature",
27765 "field": "call_limit",
27776 "field": "registertrying",
27787 "field": "subscribemwi",
27794 "field": "vmexten",
27801 "field": "mohinterpret",
27808 "field": "mohsuggest",
27815 "field": "parkinglot",
27822 "field": "description",
27843 "field": "canreinvite",
27850 "field": "registry",
27857 "field": "otherFields",
27871 "field": "t38pt_udptl",
27877 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27878 "version": "0.0.0",
27879 "filename": "server/api/trunk/index.js",
27880 "groupTitle": "Trunks"
27884 "url": "/api/trunks/{id}",
27885 "title": "Deletes a trunk",
27888 "title": "Example usage:",
27889 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27895 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27896 "version": "0.0.0",
27897 "filename": "server/api/trunk/index.js",
27898 "groupTitle": "Trunks"
27902 "url": "/api/trunks",
27903 "title": "Gets a list of Trunks",
27906 "title": "Example usage:",
27907 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27911 "name": "GetTrunks",
27913 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27914 "version": "0.0.0",
27915 "filename": "server/api/trunk/index.js",
27916 "groupTitle": "Trunks"
27920 "url": "/api/trunks/{id}",
27921 "title": "Gets a single Trunk",
27924 "title": "Example usage:",
27925 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27929 "name": "ShowTrunks",
27931 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27932 "version": "0.0.0",
27933 "filename": "server/api/trunk/index.js",
27934 "groupTitle": "Trunks"
27938 "url": "/api/trunks/{id}",
27939 "title": "Update an existing trunk",
27942 "title": "Example usage:",
27943 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27949 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27950 "version": "0.0.0",
27951 "filename": "server/api/trunk/index.js",
27952 "groupTitle": "Trunks"
27956 "url": "/api/userNotifications",
27957 "title": "Send notification to user",
27960 "title": "Example usage:",
27961 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27966 "group": "UserNotifications",
27967 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27968 "version": "0.0.0",
27969 "filename": "server/api/userNotification/index.js",
27970 "groupTitle": "UserNotifications"
27974 "url": "/api/userProfile/resources",
27975 "title": "Creates a new User Profile Resource",
27978 "title": "Example usage:",
27979 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27983 "name": "CreateUser_Profile_Resources",
27984 "group": "User_Profile_Resources",
27999 "field": "resourceId",
28012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28013 "version": "0.0.0",
28014 "filename": "server/api/userProfileResource/index.js",
28015 "groupTitle": "User_Profile_Resources"
28019 "url": "/api/userProfile/resources/{id}",
28020 "title": "Deletes a User Profile Resource",
28023 "title": "Example usage:",
28024 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28028 "name": "DeleteUser_Profile_Resources",
28029 "group": "User_Profile_Resources",
28030 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28031 "version": "0.0.0",
28032 "filename": "server/api/userProfileResource/index.js",
28033 "groupTitle": "User_Profile_Resources"
28037 "url": "/api/userProfile/resources/describe",
28038 "title": "Gets table info about User Profile Resources",
28041 "title": "Example usage:",
28042 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28046 "name": "DescribeUser_Profile_Resources",
28047 "group": "User_Profile_Resources",
28048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28049 "version": "0.0.0",
28050 "filename": "server/api/userProfileResource/index.js",
28051 "groupTitle": "User_Profile_Resources"
28055 "url": "/api/userProfile/resources",
28056 "title": "Gets a list of User Profile Resources",
28059 "title": "Example usage:",
28060 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28064 "name": "GetUser_Profile_Resources",
28065 "group": "User_Profile_Resources",
28066 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28067 "version": "0.0.0",
28068 "filename": "server/api/userProfileResource/index.js",
28069 "groupTitle": "User_Profile_Resources"
28073 "url": "/api/userProfile/resources/{id}",
28074 "title": "Gets a single User Profile Resource",
28077 "title": "Example usage:",
28078 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28082 "name": "ShowUser_Profile_Resources",
28083 "group": "User_Profile_Resources",
28084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28085 "version": "0.0.0",
28086 "filename": "server/api/userProfileResource/index.js",
28087 "groupTitle": "User_Profile_Resources"
28091 "url": "/api/userProfile/resources/{id}",
28092 "title": "Update an existing User Profile Resource",
28095 "title": "Example usage:",
28096 "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",
28100 "name": "updateUser_Profile_Resources",
28101 "group": "User_Profile_Resources",
28102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28103 "version": "0.0.0",
28104 "filename": "server/api/userProfileResource/index.js",
28105 "groupTitle": "User_Profile_Resources"
28109 "url": "/api/userProfile/sections",
28110 "title": "Creates a new User Profile Section",
28113 "title": "Example usage:",
28114 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28118 "name": "CreateUser_Profile_Sections",
28119 "group": "User_Profile_Sections",
28134 "field": "category",
28141 "field": "sectionId",
28148 "field": "enabled",
28155 "field": "autoAssociation",
28162 "field": "crudPermissions",
28168 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28169 "version": "0.0.0",
28170 "filename": "server/api/userProfileSection/index.js",
28171 "groupTitle": "User_Profile_Sections"
28175 "url": "/api/userProfile/sections/{id}",
28176 "title": "Deletes a User Profile Section",
28179 "title": "Example usage:",
28180 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28184 "name": "DeleteUser_Profile_Sections",
28185 "group": "User_Profile_Sections",
28186 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28187 "version": "0.0.0",
28188 "filename": "server/api/userProfileSection/index.js",
28189 "groupTitle": "User_Profile_Sections"
28193 "url": "/api/userProfile/sections/describe",
28194 "title": "Gets table info about User Profile Sections",
28197 "title": "Example usage:",
28198 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28202 "name": "DescribeUser_Profile_Sections",
28203 "group": "User_Profile_Sections",
28204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28205 "version": "0.0.0",
28206 "filename": "server/api/userProfileSection/index.js",
28207 "groupTitle": "User_Profile_Sections"
28211 "url": "/api/userProfile/sections",
28212 "title": "Gets a list of User Profile Sections",
28215 "title": "Example usage:",
28216 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28220 "name": "GetUser_Profile_Sections",
28221 "group": "User_Profile_Sections",
28222 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28223 "version": "0.0.0",
28224 "filename": "server/api/userProfileSection/index.js",
28225 "groupTitle": "User_Profile_Sections"
28229 "url": "/api/userProfile/sections/{id}",
28230 "title": "Gets a single User Profile Section",
28233 "title": "Example usage:",
28234 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28238 "name": "ShowUser_Profile_Sections",
28239 "group": "User_Profile_Sections",
28240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28241 "version": "0.0.0",
28242 "filename": "server/api/userProfileSection/index.js",
28243 "groupTitle": "User_Profile_Sections"
28247 "url": "/api/userProfile/sections/{id}",
28248 "title": "Update an existing User Profile Section",
28251 "title": "Example usage:",
28252 "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",
28256 "name": "updateUser_Profile_Sections",
28257 "group": "User_Profile_Sections",
28258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28259 "version": "0.0.0",
28260 "filename": "server/api/userProfileSection/index.js",
28261 "groupTitle": "User_Profile_Sections"
28265 "url": "/api/userProfiles/{id}/resources",
28266 "title": "Add resources' permissions to User Profile",
28269 "title": "Example usage:",
28270 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28274 "name": "AddResources",
28275 "group": "User_Profiles",
28276 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28277 "version": "0.0.0",
28278 "filename": "server/api/userProfile/index.js",
28279 "groupTitle": "User_Profiles"
28283 "url": "/api/userProfiles/{id}/sections",
28284 "title": "Add sections' permissions to User Profile",
28287 "title": "Example usage:",
28288 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28292 "name": "AddSections",
28293 "group": "User_Profiles",
28294 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28295 "version": "0.0.0",
28296 "filename": "server/api/userProfile/index.js",
28297 "groupTitle": "User_Profiles"
28301 "url": "/api/userProfiles/clone",
28302 "title": "Clone an existing User Profile",
28305 "title": "Example usage:",
28306 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28310 "name": "CloneUser_Profiles",
28311 "group": "User_Profiles",
28312 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28313 "version": "0.0.0",
28314 "filename": "server/api/userProfile/index.js",
28315 "groupTitle": "User_Profiles"
28319 "url": "/api/userProfiles",
28320 "title": "Creates a new User Profile",
28323 "title": "Example usage:",
28324 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28328 "name": "CreateUser_Profiles",
28329 "group": "User_Profiles",
28344 "field": "crudPermissions",
28351 "field": "description",
28358 "field": "privacyEnabled",
28365 "field": "downloadAttachments",
28372 "field": "downloadCallySquareRecordings",
28379 "field": "downloadContactManagerLists",
28386 "field": "downloadJscriptySessions",
28393 "field": "downloadOmnichannelInteractions",
28400 "field": "downloadScreenRecordings",
28407 "field": "downloadVoiceRecordings",
28413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28414 "version": "0.0.0",
28415 "filename": "server/api/userProfile/index.js",
28416 "groupTitle": "User_Profiles"
28420 "url": "/api/userProfiles/{id}",
28421 "title": "Deletes a User Profile",
28424 "title": "Example usage:",
28425 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28429 "name": "DeleteUser_Profiles",
28430 "group": "User_Profiles",
28431 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28432 "version": "0.0.0",
28433 "filename": "server/api/userProfile/index.js",
28434 "groupTitle": "User_Profiles"
28438 "url": "/api/userProfiles/describe",
28439 "title": "Gets table info about User Profiles",
28442 "title": "Example usage:",
28443 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28447 "name": "DescribeUser_Profiles",
28448 "group": "User_Profiles",
28449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28450 "version": "0.0.0",
28451 "filename": "server/api/userProfile/index.js",
28452 "groupTitle": "User_Profiles"
28456 "url": "/api/userProfiles/{id}/resources?section={section}",
28457 "title": "Get Resources assigned to a Section",
28460 "title": "Example usage:",
28461 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28465 "name": "GetResources",
28466 "group": "User_Profiles",
28467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28468 "version": "0.0.0",
28469 "filename": "server/api/userProfile/index.js",
28470 "groupTitle": "User_Profiles"
28474 "url": "/api/userProfiles/{id}/sections",
28475 "title": "Get sections associated to a User Profile",
28478 "title": "Example usage:",
28479 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28483 "name": "GetSections",
28484 "group": "User_Profiles",
28485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28486 "version": "0.0.0",
28487 "filename": "server/api/userProfile/index.js",
28488 "groupTitle": "User_Profiles"
28492 "url": "/api/userProfiles",
28493 "title": "Gets a list of User Profiles",
28496 "title": "Example usage:",
28497 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28501 "name": "GetUser_Profiles",
28502 "group": "User_Profiles",
28503 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28504 "version": "0.0.0",
28505 "filename": "server/api/userProfile/index.js",
28506 "groupTitle": "User_Profiles"
28510 "url": "/api/userProfiles/{id}/resources",
28511 "title": "Removes resources' permissions from User Profile",
28514 "title": "Example usage:",
28515 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28519 "name": "RemoveResources",
28520 "group": "User_Profiles",
28521 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28522 "version": "0.0.0",
28523 "filename": "server/api/userProfile/index.js",
28524 "groupTitle": "User_Profiles"
28528 "url": "/api/userProfiles/{id}/sections",
28529 "title": "Removes sections' permissions from User Profile",
28532 "title": "Example usage:",
28533 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28537 "name": "RemoveSections",
28538 "group": "User_Profiles",
28539 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28540 "version": "0.0.0",
28541 "filename": "server/api/userProfile/index.js",
28542 "groupTitle": "User_Profiles"
28546 "url": "/api/userProfiles/{id}",
28547 "title": "Gets a single User Profile",
28550 "title": "Example usage:",
28551 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28555 "name": "ShowUser_Profiles",
28556 "group": "User_Profiles",
28557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28558 "version": "0.0.0",
28559 "filename": "server/api/userProfile/index.js",
28560 "groupTitle": "User_Profiles"
28564 "url": "/api/userProfiles/{id}",
28565 "title": "Update an existing User Profile",
28568 "title": "Example usage:",
28569 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28573 "name": "updateUser_Profiles",
28574 "group": "User_Profiles",
28575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28576 "version": "0.0.0",
28577 "filename": "server/api/userProfile/index.js",
28578 "groupTitle": "User_Profiles"
28582 "url": "/api/users/{id}/chat_interactions",
28583 "title": "Add chat interaction tabs to an agent",
28586 "title": "Example usage:",
28587 "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",
28591 "name": "AddChatInteractions",
28593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28594 "version": "0.0.0",
28595 "filename": "server/api/user/index.js",
28596 "groupTitle": "Users"
28600 "url": "/api/users/{id}/chat_websites",
28601 "title": "Add a Chat Website to a user",
28604 "title": "Example usage:",
28605 "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",
28609 "name": "AddChatWebsites",
28611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28612 "version": "0.0.0",
28613 "filename": "server/api/user/index.js",
28614 "groupTitle": "Users"
28618 "url": "/api/users/{id}/contacts",
28619 "title": "Add contacts to a user",
28622 "title": "Example usage:",
28623 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28627 "name": "AddContacts",
28629 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28630 "version": "0.0.0",
28631 "filename": "server/api/user/index.js",
28632 "groupTitle": "Users"
28636 "url": "/api/users/{id}/fax_accounts",
28637 "title": "Add a Fax Account to a user",
28640 "title": "Example usage:",
28641 "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",
28645 "name": "AddFaxAccounts",
28647 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28648 "version": "0.0.0",
28649 "filename": "server/api/user/index.js",
28650 "groupTitle": "Users"
28654 "url": "/api/users/{id}/fax_interactions",
28655 "title": "Add fax interaction tabs to an agent",
28658 "title": "Example usage:",
28659 "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",
28663 "name": "AddFaxInteractions",
28665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28666 "version": "0.0.0",
28667 "filename": "server/api/user/index.js",
28668 "groupTitle": "Users"
28672 "url": "/api/users/{id}/mail_accounts",
28673 "title": "Add a Mail Account to a user",
28676 "title": "Example usage:",
28677 "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",
28681 "name": "AddMailAccounts",
28683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28684 "version": "0.0.0",
28685 "filename": "server/api/user/index.js",
28686 "groupTitle": "Users"
28690 "url": "/api/users/{id}/mail_interactions",
28691 "title": "Add mail interaction tabs to an agent",
28694 "title": "Example usage:",
28695 "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",
28699 "name": "AddMailInteractions",
28701 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28702 "version": "0.0.0",
28703 "filename": "server/api/user/index.js",
28704 "groupTitle": "Users"
28708 "url": "/api/users/{id}/openchannel_accounts",
28709 "title": "Add a Open Channel Account to a user",
28712 "title": "Example usage:",
28713 "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",
28717 "name": "AddOpenchannelAccounts",
28719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28720 "version": "0.0.0",
28721 "filename": "server/api/user/index.js",
28722 "groupTitle": "Users"
28726 "url": "/api/users/{id}/openchannel_interactions",
28727 "title": "Add openchannel interaction tabs to an agent",
28730 "title": "Example usage:",
28731 "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",
28735 "name": "AddOpenchannelInteractions",
28737 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28738 "version": "0.0.0",
28739 "filename": "server/api/user/index.js",
28740 "groupTitle": "Users"
28744 "url": "/api/users/{id}/queues",
28745 "title": "Add queues to an agent",
28748 "title": "Example usage:",
28749 "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",
28753 "name": "AddQueues",
28755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28756 "version": "0.0.0",
28757 "filename": "server/api/user/index.js",
28758 "groupTitle": "Users"
28762 "url": "/api/users/{id}/sms_accounts",
28763 "title": "Add a Sms Account to a user",
28766 "title": "Example usage:",
28767 "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",
28771 "name": "AddSmsAccounts",
28773 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28774 "version": "0.0.0",
28775 "filename": "server/api/user/index.js",
28776 "groupTitle": "Users"
28780 "url": "/api/users/{id}/sms_interactions",
28781 "title": "Add sms interaction tabs to an agent",
28784 "title": "Example usage:",
28785 "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",
28789 "name": "AddSmsInteractions",
28791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28792 "version": "0.0.0",
28793 "filename": "server/api/user/index.js",
28794 "groupTitle": "Users"
28798 "url": "/api/users/{id}/square_projects",
28799 "title": "Add a Square Project to a user",
28802 "title": "Example usage:",
28803 "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",
28807 "name": "AddSquareProjects",
28809 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28810 "version": "0.0.0",
28811 "filename": "server/api/user/index.js",
28812 "groupTitle": "Users"
28816 "url": "/api/users/{id}/teams",
28817 "title": "Add teams to an agent",
28820 "title": "Example usage:",
28821 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28825 "name": "AddTeams",
28827 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28828 "version": "0.0.0",
28829 "filename": "server/api/user/index.js",
28830 "groupTitle": "Users"
28834 "url": "/api/users/{id}/whatsapp_accounts",
28835 "title": "Add a Whatsapp Account to a user",
28838 "title": "Example usage:",
28839 "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",
28843 "name": "AddWhatsappAccounts",
28845 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28846 "version": "0.0.0",
28847 "filename": "server/api/user/index.js",
28848 "groupTitle": "Users"
28852 "url": "/api/users/{id}/whatsapp_interactions",
28853 "title": "Add Whatsapp interaction tabs to an agent",
28856 "title": "Example usage:",
28857 "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",
28861 "name": "AddWhatsappInteractions",
28863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28864 "version": "0.0.0",
28865 "filename": "server/api/user/index.js",
28866 "groupTitle": "Users"
28870 "url": "/api/users/{id}/password",
28871 "title": "Change user password",
28874 "title": "Example usage:",
28875 "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",
28879 "name": "ChangePwd",
28881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28882 "version": "0.0.0",
28883 "filename": "server/api/user/index.js",
28884 "groupTitle": "Users"
28888 "url": "/api/users",
28889 "title": "Create a new user",
28892 "title": "Example usage:",
28893 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28899 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28900 "version": "0.0.0",
28901 "filename": "server/api/user/index.js",
28902 "groupTitle": "Users"
28906 "url": "/api/users/{id}/api_key",
28907 "title": "Create a new API access key for the user",
28910 "title": "Example usage:",
28911 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28915 "name": "CreateApiKey",
28917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28918 "version": "0.0.0",
28919 "filename": "server/api/user/index.js",
28920 "groupTitle": "Users"
28924 "url": "/api/users/{id}",
28925 "title": "Deletes a user",
28928 "title": "Example usage:",
28929 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28935 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28936 "version": "0.0.0",
28937 "filename": "server/api/user/index.js",
28938 "groupTitle": "Users"
28942 "url": "/api/users/describe",
28943 "title": "Gets table info about Users",
28946 "title": "Example usage:",
28947 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28951 "name": "DescribeUsers",
28953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28954 "version": "0.0.0",
28955 "filename": "server/api/user/index.js",
28956 "groupTitle": "Users"
28960 "url": "/api/users/{id}/agents",
28961 "title": "GetAgents",
28964 "title": "Example usage:",
28965 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28969 "name": "GetAgents",
28971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28972 "version": "0.0.0",
28973 "filename": "server/api/user/index.js",
28974 "groupTitle": "Users"
28978 "url": "/api/users/{id}/api_key",
28979 "title": "Get the API access key for the user",
28982 "title": "Example usage:",
28983 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28987 "name": "GetApiKey",
28989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28990 "version": "0.0.0",
28991 "filename": "server/api/user/index.js",
28992 "groupTitle": "Users"
28996 "url": "/api/users/{id}/groups",
28997 "title": "GetChatGroups",
29000 "title": "Example usage:",
29001 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29005 "name": "GetChatGroups",
29007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29008 "version": "0.0.0",
29009 "filename": "server/api/user/index.js",
29010 "groupTitle": "Users"
29014 "url": "/api/users/{id}/chat/interactions",
29015 "title": "GetChatInteractions",
29018 "title": "Example usage:",
29019 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29023 "name": "GetChatInteractions",
29025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29026 "version": "0.0.0",
29027 "filename": "server/api/user/index.js",
29028 "groupTitle": "Users"
29032 "url": "/api/users/{id}/chat_websites",
29033 "title": "GetChatWebsites",
29036 "title": "Example usage:",
29037 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29041 "name": "GetChatWebsites",
29043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29044 "version": "0.0.0",
29045 "filename": "server/api/user/index.js",
29046 "groupTitle": "Users"
29050 "url": "/api/users/{id}/contacts",
29051 "title": "GetContacts",
29054 "title": "Example usage:",
29055 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29059 "name": "GetContacts",
29061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29062 "version": "0.0.0",
29063 "filename": "server/api/user/index.js",
29064 "groupTitle": "Users"
29068 "url": "/api/users/{id}/fax_accounts",
29069 "title": "GetFaxAccounts",
29072 "title": "Example usage:",
29073 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29077 "name": "GetFaxAccounts",
29079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29080 "version": "0.0.0",
29081 "filename": "server/api/user/index.js",
29082 "groupTitle": "Users"
29086 "url": "/api/users/{id}/fax/interactions",
29087 "title": "GetFaxInteractions",
29090 "title": "Example usage:",
29091 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29095 "name": "GetFaxInteractions",
29097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29098 "version": "0.0.0",
29099 "filename": "server/api/user/index.js",
29100 "groupTitle": "Users"
29104 "url": "/api/users/{id}/lists",
29105 "title": "GetLists",
29108 "title": "Example usage:",
29109 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29113 "name": "GetLists",
29115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29116 "version": "0.0.0",
29117 "filename": "server/api/user/index.js",
29118 "groupTitle": "Users"
29122 "url": "/api/users/{id}/mail_accounts",
29123 "title": "GetMailAccounts",
29126 "title": "Example usage:",
29127 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29131 "name": "GetMailAccounts",
29133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29134 "version": "0.0.0",
29135 "filename": "server/api/user/index.js",
29136 "groupTitle": "Users"
29140 "url": "/api/users/{id}/mail/interactions",
29141 "title": "GetMailInteractions",
29144 "title": "Example usage:",
29145 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29149 "name": "GetMailInteractions",
29151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29152 "version": "0.0.0",
29153 "filename": "server/api/user/index.js",
29154 "groupTitle": "Users"
29158 "url": "/api/users/{id}/openchannel_accounts",
29159 "title": "GetOpenchannelAccounts",
29162 "title": "Example usage:",
29163 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29167 "name": "GetOpenchannelAccounts",
29169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29170 "version": "0.0.0",
29171 "filename": "server/api/user/index.js",
29172 "groupTitle": "Users"
29176 "url": "/api/users/{id}/openchannel/interactions",
29177 "title": "GetOpenchannelInteractions",
29180 "title": "Example usage:",
29181 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29185 "name": "GetOpenchannelInteractions",
29187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29188 "version": "0.0.0",
29189 "filename": "server/api/user/index.js",
29190 "groupTitle": "Users"
29194 "url": "/api/users/{id}/prefixes",
29195 "title": "GetPrefixes",
29198 "title": "Example usage:",
29199 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29203 "name": "GetPrefixes",
29205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29206 "version": "0.0.0",
29207 "filename": "server/api/user/index.js",
29208 "groupTitle": "Users"
29212 "url": "/api/users/{id}/queues?channel={channel}",
29213 "title": "Gets Queues list",
29216 "title": "Example usage:",
29217 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29221 "name": "GetQueues",
29223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29224 "version": "0.0.0",
29225 "filename": "server/api/user/index.js",
29226 "groupTitle": "Users"
29230 "url": "/api/users/{id}/recordings",
29231 "title": "GetRecordings",
29234 "title": "Example usage:",
29235 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29239 "name": "GetRecordings",
29241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29242 "version": "0.0.0",
29243 "filename": "server/api/user/index.js",
29244 "groupTitle": "Users"
29248 "url": "/api/users/{id}/scheduled_calls",
29249 "title": "GetScheduledCalls",
29252 "title": "Example usage:",
29253 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29257 "name": "GetScheduledCalls",
29259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29260 "version": "0.0.0",
29261 "filename": "server/api/user/index.js",
29262 "groupTitle": "Users"
29266 "url": "/api/users/{id}/screen_recordings",
29267 "title": "GetScreenRecordings",
29270 "title": "Example usage:",
29271 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29275 "name": "GetScreenRecordings",
29277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29278 "version": "0.0.0",
29279 "filename": "server/api/user/index.js",
29280 "groupTitle": "Users"
29284 "url": "/api/users/{id}/sms_accounts",
29285 "title": "GetSmsAccounts",
29288 "title": "Example usage:",
29289 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29293 "name": "GetSmsAccounts",
29295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29296 "version": "0.0.0",
29297 "filename": "server/api/user/index.js",
29298 "groupTitle": "Users"
29302 "url": "/api/users/{id}/sms/interactions",
29303 "title": "GetSmsInteractions",
29306 "title": "Example usage:",
29307 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29311 "name": "GetSmsInteractions",
29313 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29314 "version": "0.0.0",
29315 "filename": "server/api/user/index.js",
29316 "groupTitle": "Users"
29320 "url": "/api/users/{id}/square_projects",
29321 "title": "GetSquareProjects",
29324 "title": "Example usage:",
29325 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29329 "name": "GetSquareProjects",
29331 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29332 "version": "0.0.0",
29333 "filename": "server/api/user/index.js",
29334 "groupTitle": "Users"
29338 "url": "/api/users/{id}/teams",
29339 "title": "GetTeams",
29342 "title": "Example usage:",
29343 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29347 "name": "GetTeams",
29349 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29350 "version": "0.0.0",
29351 "filename": "server/api/user/index.js",
29352 "groupTitle": "Users"
29356 "url": "/api/users",
29357 "title": "Gets a list of Users",
29360 "title": "Example usage:",
29361 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29365 "name": "GetUsers",
29367 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29368 "version": "0.0.0",
29369 "filename": "server/api/user/index.js",
29370 "groupTitle": "Users"
29374 "url": "/api/users/{id}/queues_rt",
29375 "title": "GetVoiceQueuesRt",
29378 "title": "Example usage:",
29379 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29383 "name": "GetVoiceQueuesRt",
29385 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29386 "version": "0.0.0",
29387 "filename": "server/api/user/index.js",
29388 "groupTitle": "Users"
29392 "url": "/api/users/{id}/whatsapp_accounts",
29393 "title": "GetWhatsappAccounts",
29396 "title": "Example usage:",
29397 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29401 "name": "GetWhatsappAccounts",
29403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29404 "version": "0.0.0",
29405 "filename": "server/api/user/index.js",
29406 "groupTitle": "Users"
29410 "url": "/api/users/{id}/whatsapp/interactions",
29411 "title": "GetWhatsappInteractions",
29414 "title": "Example usage:",
29415 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29419 "name": "GetWhatsappInteractions",
29421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29422 "version": "0.0.0",
29423 "filename": "server/api/user/index.js",
29424 "groupTitle": "Users"
29428 "url": "/api/users/{id}/login",
29432 "title": "Example usage:",
29433 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29440 "version": "0.0.0",
29441 "filename": "server/api/user/index.js",
29442 "groupTitle": "Users"
29446 "url": "/api/users/{id}/logout",
29450 "title": "Example usage:",
29451 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29457 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29458 "version": "0.0.0",
29459 "filename": "server/api/user/index.js",
29460 "groupTitle": "Users"
29464 "url": "/api/users/{id}/pause",
29468 "title": "Example usage:",
29469 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29476 "version": "0.0.0",
29477 "filename": "server/api/user/index.js",
29478 "groupTitle": "Users"
29482 "url": "/api/users/{id}/api_key",
29483 "title": "Remove API access key for the user",
29486 "title": "Example usage:",
29487 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29491 "name": "RemoveApiKey",
29493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29494 "version": "0.0.0",
29495 "filename": "server/api/user/index.js",
29496 "groupTitle": "Users"
29500 "url": "/api/users/{id}/chat_interactions",
29501 "title": "Removes interactions from an agent",
29504 "title": "Example usage:",
29505 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29509 "name": "RemoveChatInteractions",
29511 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29512 "version": "0.0.0",
29513 "filename": "server/api/user/index.js",
29514 "groupTitle": "Users"
29518 "url": "/api/users/{id}/chat_websites",
29519 "title": "Removes a Chat Website from a user",
29522 "title": "Example usage:",
29523 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29527 "name": "RemoveChatWebsites",
29529 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29530 "version": "0.0.0",
29531 "filename": "server/api/user/index.js",
29532 "groupTitle": "Users"
29536 "url": "/api/users/{id}/fax_accounts",
29537 "title": "Removes a Fax Account from a user",
29540 "title": "Example usage:",
29541 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29545 "name": "RemoveFaxAccounts",
29547 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29548 "version": "0.0.0",
29549 "filename": "server/api/user/index.js",
29550 "groupTitle": "Users"
29554 "url": "/api/users/{id}/fax_interactions",
29555 "title": "Removes interactions from an agent",
29558 "title": "Example usage:",
29559 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29563 "name": "RemoveFaxInteractions",
29565 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29566 "version": "0.0.0",
29567 "filename": "server/api/user/index.js",
29568 "groupTitle": "Users"
29572 "url": "/api/users/{id}/mail_accounts",
29573 "title": "Removes a Mail Account from a user",
29576 "title": "Example usage:",
29577 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29581 "name": "RemoveMailAccounts",
29583 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29584 "version": "0.0.0",
29585 "filename": "server/api/user/index.js",
29586 "groupTitle": "Users"
29590 "url": "/api/users/{id}/mail_interactions",
29591 "title": "Removes interactions from an agent",
29594 "title": "Example usage:",
29595 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29599 "name": "RemoveMailInteractions",
29601 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29602 "version": "0.0.0",
29603 "filename": "server/api/user/index.js",
29604 "groupTitle": "Users"
29608 "url": "/api/users/{id}/openchannel_accounts",
29609 "title": "Removes a Open Channel Account from a user",
29612 "title": "Example usage:",
29613 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29617 "name": "RemoveOpenchannelAccounts",
29619 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29620 "version": "0.0.0",
29621 "filename": "server/api/user/index.js",
29622 "groupTitle": "Users"
29626 "url": "/api/users/{id}/openchannel_interactions",
29627 "title": "Removes openchannel interactions from an agent",
29630 "title": "Example usage:",
29631 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29635 "name": "RemoveOpenchannelInteractions",
29637 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29638 "version": "0.0.0",
29639 "filename": "server/api/user/index.js",
29640 "groupTitle": "Users"
29644 "url": "/api/users/{id}/queues",
29645 "title": "Remove queues to an agent",
29648 "title": "Example usage:",
29649 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29653 "name": "RemoveQueues",
29655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29656 "version": "0.0.0",
29657 "filename": "server/api/user/index.js",
29658 "groupTitle": "Users"
29662 "url": "/api/users/{id}/sms_accounts",
29663 "title": "Removes a Sms Account from a user",
29666 "title": "Example usage:",
29667 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29671 "name": "RemoveSmsAccounts",
29673 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29674 "version": "0.0.0",
29675 "filename": "server/api/user/index.js",
29676 "groupTitle": "Users"
29680 "url": "/api/users/{id}/sms_interactions",
29681 "title": "Removes interactions from an agent",
29684 "title": "Example usage:",
29685 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29689 "name": "RemoveSmsInteractions",
29691 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29692 "version": "0.0.0",
29693 "filename": "server/api/user/index.js",
29694 "groupTitle": "Users"
29698 "url": "/api/users/{id}/square_projects",
29699 "title": "Removes a Square Project from a user",
29702 "title": "Example usage:",
29703 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29707 "name": "RemoveSquareProjects",
29709 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29710 "version": "0.0.0",
29711 "filename": "server/api/user/index.js",
29712 "groupTitle": "Users"
29716 "url": "/api/users/{id}/teams",
29717 "title": "Removes teams from an agent",
29720 "title": "Example usage:",
29721 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29725 "name": "RemoveTeams",
29727 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29728 "version": "0.0.0",
29729 "filename": "server/api/user/index.js",
29730 "groupTitle": "Users"
29734 "url": "/api/users/{id}/whatsapp_accounts",
29735 "title": "Removes a Whatsapp Account from a user",
29738 "title": "Example usage:",
29739 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29743 "name": "RemoveWhatsappAccounts",
29745 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29746 "version": "0.0.0",
29747 "filename": "server/api/user/index.js",
29748 "groupTitle": "Users"
29752 "url": "/api/users/{id}/whatsapp_interactions",
29753 "title": "Removes Whatsapp interactions from an agent",
29756 "title": "Example usage:",
29757 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29761 "name": "RemoveWhatsappInteractions",
29763 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29764 "version": "0.0.0",
29765 "filename": "server/api/user/index.js",
29766 "groupTitle": "Users"
29770 "url": "/api/users/{id}",
29771 "title": "Gets a single User",
29774 "title": "Example usage:",
29775 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29779 "name": "ShowUsers",
29781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29782 "version": "0.0.0",
29783 "filename": "server/api/user/index.js",
29784 "groupTitle": "Users"
29788 "url": "/api/users/{id}/unpause",
29789 "title": "Unpause",
29792 "title": "Example usage:",
29793 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29799 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29800 "version": "0.0.0",
29801 "filename": "server/api/user/index.js",
29802 "groupTitle": "Users"
29806 "url": "/api/users/whoami",
29810 "title": "Example usage:",
29811 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29818 "version": "0.0.0",
29819 "filename": "server/api/user/index.js",
29820 "groupTitle": "Users"
29824 "url": "/api/users/{id}/avatar",
29825 "title": "Add avatar",
29828 "title": "Example usage:",
29829 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29833 "name": "addAvatar",
29835 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29836 "version": "0.0.0",
29837 "filename": "server/api/user/index.js",
29838 "groupTitle": "Users"
29842 "url": "/api/users/create_many",
29843 "title": "Create Users",
29846 "title": "Example usage:",
29847 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29851 "name": "bulkCreate",
29853 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29854 "version": "0.0.0",
29855 "filename": "server/api/user/index.js",
29856 "groupTitle": "Users"
29860 "url": "/api/users/{id}/avatar",
29861 "title": "Get avatar",
29864 "title": "Example usage:",
29865 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29869 "name": "getAvatar",
29871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29872 "version": "0.0.0",
29873 "filename": "server/api/user/index.js",
29874 "groupTitle": "Users"
29878 "url": "/api/users/{id}/open_tabs",
29879 "title": "Get interactions opened tabs",
29882 "title": "Example usage:",
29883 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29887 "name": "getOpenTabs",
29889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29890 "version": "0.0.0",
29891 "filename": "server/api/user/index.js",
29892 "groupTitle": "Users"
29896 "url": "/api/users/presence",
29897 "title": "Gets agent presence",
29900 "title": "Example usage:",
29901 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
29905 "name": "getPresence",
29907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29908 "version": "0.0.0",
29909 "filename": "server/api/user/index.js",
29910 "groupTitle": "Users"
29914 "url": "/api/users/{id}",
29915 "title": "Update an existing User",
29918 "title": "Example usage:",
29919 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29923 "name": "updateUsers",
29925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29926 "version": "0.0.0",
29927 "filename": "server/api/user/index.js",
29928 "groupTitle": "Users"
29932 "url": "/api/variables",
29933 "title": "Creates a new Variable",
29936 "title": "Example usage:",
29937 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29941 "name": "CreateVariables",
29942 "group": "Variables",
29957 "field": "description",
29963 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29964 "version": "0.0.0",
29965 "filename": "server/api/variable/index.js",
29966 "groupTitle": "Variables"
29970 "url": "/api/variables/{id}",
29971 "title": "Deletes a Variable",
29974 "title": "Example usage:",
29975 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29979 "name": "DeleteVariables",
29980 "group": "Variables",
29981 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29982 "version": "0.0.0",
29983 "filename": "server/api/variable/index.js",
29984 "groupTitle": "Variables"
29988 "url": "/api/variables",
29989 "title": "Gets a list of Variables",
29992 "title": "Example usage:",
29993 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29997 "name": "GetVariables",
29998 "group": "Variables",
29999 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30000 "version": "0.0.0",
30001 "filename": "server/api/variable/index.js",
30002 "groupTitle": "Variables"
30006 "url": "/api/variables/{id}",
30007 "title": "Gets a single Variable",
30010 "title": "Example usage:",
30011 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30015 "name": "ShowVariables",
30016 "group": "Variables",
30017 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30018 "version": "0.0.0",
30019 "filename": "server/api/variable/index.js",
30020 "groupTitle": "Variables"
30024 "url": "/api/variables/{id}",
30025 "title": "Update an existing Variable",
30028 "title": "Example usage:",
30029 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30033 "name": "updateVariables",
30034 "group": "Variables",
30035 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30036 "version": "0.0.0",
30037 "filename": "server/api/variable/index.js",
30038 "groupTitle": "Variables"
30042 "url": "/api/version/fetch",
30043 "title": "Fetch git version",
30046 "title": "Example usage:",
30047 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30051 "name": "FetchVersion",
30052 "group": "Version",
30053 "description": "<p>Motion run the following command: git fetch origin master</p>",
30054 "version": "0.0.0",
30055 "filename": "server/api/version/index.js",
30056 "groupTitle": "Version"
30060 "url": "/api/version",
30061 "title": "Gets version",
30064 "title": "Example usage:",
30065 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30069 "name": "GetVersion",
30070 "group": "Version",
30071 "description": "<p>Motion returns the current and latest motion version.</p>",
30072 "version": "0.0.0",
30073 "filename": "server/api/version/index.js",
30074 "groupTitle": "Version"
30078 "url": "/api/version/migrations",
30079 "title": "Launch database migrations",
30082 "title": "Example usage:",
30083 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30087 "name": "MigrateVersion",
30088 "group": "Version",
30089 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30090 "version": "0.0.0",
30091 "filename": "server/api/version/index.js",
30092 "groupTitle": "Version"
30096 "url": "/api/version/pull",
30097 "title": "Pull git version",
30100 "title": "Example usage:",
30101 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30105 "name": "PullVersion",
30106 "group": "Version",
30107 "description": "<p>Motion run the following command: git pull</p>",
30108 "version": "0.0.0",
30109 "filename": "server/api/version/index.js",
30110 "groupTitle": "Version"
30114 "url": "/api/version/reset",
30115 "title": "Reset git version",
30118 "title": "Example usage:",
30119 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30123 "name": "ResetVersion",
30124 "group": "Version",
30125 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30126 "version": "0.0.0",
30127 "filename": "server/api/version/index.js",
30128 "groupTitle": "Version"
30132 "url": "/api/version/restart",
30133 "title": "Restart motion2 after update",
30136 "title": "Example usage:",
30137 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30141 "name": "RestartVersion",
30142 "group": "Version",
30143 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30144 "version": "0.0.0",
30145 "filename": "server/api/version/index.js",
30146 "groupTitle": "Version"
30150 "url": "/api/voice/agents/reports/describe",
30151 "title": "Gets table info about Agent Reports",
30154 "title": "Example usage:",
30155 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30159 "name": "DescribeAgent_Reports",
30160 "group": "Voice_Agent_Reports",
30161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30162 "version": "0.0.0",
30163 "filename": "server/api/voiceAgentReport/index.js",
30164 "groupTitle": "Voice_Agent_Reports"
30168 "url": "/api/voice/agents/reports",
30169 "title": "Gets a list of Agent Reports",
30172 "title": "Example usage:",
30173 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30177 "name": "GetAgent_Reports",
30178 "group": "Voice_Agent_Reports",
30179 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30180 "version": "0.0.0",
30181 "filename": "server/api/voiceAgentReport/index.js",
30182 "groupTitle": "Voice_Agent_Reports"
30186 "url": "/api/voice/agents/reports/{id}",
30187 "title": "Gets a single Agent Report",
30190 "title": "Example usage:",
30191 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30195 "name": "ShowAgent_Reports",
30196 "group": "Voice_Agent_Reports",
30197 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30198 "version": "0.0.0",
30199 "filename": "server/api/voiceAgentReport/index.js",
30200 "groupTitle": "Voice_Agent_Reports"
30204 "url": "/api/voice/calls/reports/describe",
30205 "title": "Gets table info about Call Reports",
30208 "title": "Example usage:",
30209 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30213 "name": "DescribeCall_Reports",
30214 "group": "Voice_Call_Reports",
30215 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30216 "version": "0.0.0",
30217 "filename": "server/api/voiceCallReport/index.js",
30218 "groupTitle": "Voice_Call_Reports"
30222 "url": "/api/voice/calls/reports",
30223 "title": "Gets a list of Call Reports",
30226 "title": "Example usage:",
30227 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30231 "name": "GetCall_Reports",
30232 "group": "Voice_Call_Reports",
30233 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30234 "version": "0.0.0",
30235 "filename": "server/api/voiceCallReport/index.js",
30236 "groupTitle": "Voice_Call_Reports"
30240 "url": "/api/voice/calls/reports/{id}",
30241 "title": "Gets a single Call Report",
30244 "title": "Example usage:",
30245 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30249 "name": "ShowCall_Reports",
30250 "group": "Voice_Call_Reports",
30251 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30252 "version": "0.0.0",
30253 "filename": "server/api/voiceCallReport/index.js",
30254 "groupTitle": "Voice_Call_Reports"
30258 "url": "/api/voice/calls/reports/{id}",
30259 "title": "Update a single cdr",
30262 "title": "Example usage:",
30263 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30268 "group": "Voice_Call_Reports",
30269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30270 "version": "0.0.0",
30271 "filename": "server/api/voiceCallReport/index.js",
30272 "groupTitle": "Voice_Call_Reports"
30276 "url": "/api/voice/chanspy",
30277 "title": "Creates a new ChanSpy",
30280 "title": "Example usage:",
30281 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30285 "name": "CreateChanSpy",
30286 "group": "Voice_ChanSpy",
30308 "field": "options",
30322 "field": "password",
30336 "field": "recordingFormat",
30343 "field": "description",
30349 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30350 "version": "0.0.0",
30351 "filename": "server/api/voiceChanSpy/index.js",
30352 "groupTitle": "Voice_ChanSpy"
30356 "url": "/api/voice/chanspy/{id}",
30357 "title": "Deletes a ChanSpy",
30360 "title": "Example usage:",
30361 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30365 "name": "DeleteChanSpy",
30366 "group": "Voice_ChanSpy",
30367 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30368 "version": "0.0.0",
30369 "filename": "server/api/voiceChanSpy/index.js",
30370 "groupTitle": "Voice_ChanSpy"
30374 "url": "/api/voice/chanspy",
30375 "title": "Gets a list of ChanSpy",
30378 "title": "Example usage:",
30379 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30383 "name": "GetChanSpy",
30384 "group": "Voice_ChanSpy",
30385 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30386 "version": "0.0.0",
30387 "filename": "server/api/voiceChanSpy/index.js",
30388 "groupTitle": "Voice_ChanSpy"
30392 "url": "/api/voice/chanspy/{id}",
30393 "title": "Gets a single ChanSpy",
30396 "title": "Example usage:",
30397 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30401 "name": "ShowChanSpy",
30402 "group": "Voice_ChanSpy",
30403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30404 "version": "0.0.0",
30405 "filename": "server/api/voiceChanSpy/index.js",
30406 "groupTitle": "Voice_ChanSpy"
30410 "url": "/api/voice/chanspy/{id}",
30411 "title": "Update an existing ChanSpy",
30414 "title": "Example usage:",
30415 "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",
30419 "name": "updateChanSpy",
30420 "group": "Voice_ChanSpy",
30421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30422 "version": "0.0.0",
30423 "filename": "server/api/voiceChanSpy/index.js",
30424 "groupTitle": "Voice_ChanSpy"
30428 "url": "/api/voice/contexts",
30429 "title": "Create a new context",
30432 "title": "Example usage:",
30433 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30438 "group": "Voice_Contexts",
30453 "field": "description",
30460 "field": "defaultEntry",
30466 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30467 "version": "0.0.0",
30468 "filename": "server/api/voiceContext/index.js",
30469 "groupTitle": "Voice_Contexts"
30473 "url": "/api/voice/contexts/{id}",
30474 "title": "Deletes a context",
30477 "title": "Example usage:",
30478 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30483 "group": "Voice_Contexts",
30484 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30485 "version": "0.0.0",
30486 "filename": "server/api/voiceContext/index.js",
30487 "groupTitle": "Voice_Contexts"
30491 "url": "/api/voice/contexts",
30492 "title": "Gets a list of Contexts",
30495 "title": "Example usage:",
30496 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30500 "name": "GetContexts",
30501 "group": "Voice_Contexts",
30502 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30503 "version": "0.0.0",
30504 "filename": "server/api/voiceContext/index.js",
30505 "groupTitle": "Voice_Contexts"
30509 "url": "/api/voice/contexts/{id}",
30510 "title": "Gets a single Context",
30513 "title": "Example usage:",
30514 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30518 "name": "ShowContexts",
30519 "group": "Voice_Contexts",
30520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30521 "version": "0.0.0",
30522 "filename": "server/api/voiceContext/index.js",
30523 "groupTitle": "Voice_Contexts"
30527 "url": "/api/voice/contexts/{id}",
30528 "title": "Update an existing context",
30531 "title": "Example usage:",
30532 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30537 "group": "Voice_Contexts",
30538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30539 "version": "0.0.0",
30540 "filename": "server/api/voiceContext/index.js",
30541 "groupTitle": "Voice_Contexts"
30545 "url": "/api/voice/dials/reports/describe",
30546 "title": "Gets table info about Dial Reports",
30549 "title": "Example usage:",
30550 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30554 "name": "DescribeDial_Reports",
30555 "group": "Voice_Dial_Reports",
30556 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30557 "version": "0.0.0",
30558 "filename": "server/api/voiceDialReport/index.js",
30559 "groupTitle": "Voice_Dial_Reports"
30563 "url": "/api/voice/dials/reports",
30564 "title": "Gets a list of Dial Reports",
30567 "title": "Example usage:",
30568 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30572 "name": "GetDial_Reports",
30573 "group": "Voice_Dial_Reports",
30574 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30575 "version": "0.0.0",
30576 "filename": "server/api/voiceDialReport/index.js",
30577 "groupTitle": "Voice_Dial_Reports"
30581 "url": "/api/voice/dials/reports/{id}",
30582 "title": "Gets a single Dial Report",
30585 "title": "Example usage:",
30586 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30590 "name": "ShowDial_Reports",
30591 "group": "Voice_Dial_Reports",
30592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30593 "version": "0.0.0",
30594 "filename": "server/api/voiceDialReport/index.js",
30595 "groupTitle": "Voice_Dial_Reports"
30599 "url": "/api/voice/extensions/{id}",
30600 "title": "Deletes a Extension",
30603 "title": "Example usage:",
30604 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30608 "name": "DeleteExtensions",
30609 "group": "Voice_Extensions",
30610 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30611 "version": "0.0.0",
30612 "filename": "server/api/voiceExtension/index.js",
30613 "groupTitle": "Voice_Extensions"
30617 "url": "/api/voice/extensions",
30618 "title": "Gets a list of Extensions",
30621 "title": "Example usage:",
30622 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30626 "name": "GetExtensions",
30627 "group": "Voice_Extensions",
30628 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30629 "version": "0.0.0",
30630 "filename": "server/api/voiceExtension/index.js",
30631 "groupTitle": "Voice_Extensions"
30635 "url": "/api/voice/extensions/{id}",
30636 "title": "Gets a single Extension",
30639 "title": "Example usage:",
30640 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30644 "name": "ShowExtensions",
30645 "group": "Voice_Extensions",
30646 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30647 "version": "0.0.0",
30648 "filename": "server/api/voiceExtension/index.js",
30649 "groupTitle": "Voice_Extensions"
30653 "url": "/api/voice/extensions",
30654 "title": "Create new applications",
30657 "title": "Example usage:",
30658 "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",
30662 "name": "addApplications",
30663 "group": "Voice_Extensions",
30664 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30665 "version": "0.0.0",
30666 "filename": "server/api/voiceExtension/index.js",
30667 "groupTitle": "Voice_Extensions"
30671 "url": "/api/voice/extensions",
30672 "title": "Create an extension",
30675 "title": "Example usage:",
30676 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30681 "group": "Voice_Extensions",
30682 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30683 "version": "0.0.0",
30684 "filename": "server/api/voiceExtension/index.js",
30685 "groupTitle": "Voice_Extensions"
30689 "url": "/api/voice/extensions/{id}",
30690 "title": "Update an extension",
30693 "title": "Example usage:",
30694 "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",
30699 "group": "Voice_Extensions",
30700 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30701 "version": "0.0.0",
30702 "filename": "server/api/voiceExtension/index.js",
30703 "groupTitle": "Voice_Extensions"
30707 "url": "/api/voice/mohs",
30708 "title": "Create a new a new MOH",
30711 "title": "Example usage:",
30712 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30717 "group": "Voice_MOHs",
30718 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30719 "version": "0.0.0",
30720 "filename": "server/api/voiceMusicOnHold/index.js",
30721 "groupTitle": "Voice_MOHs"
30725 "url": "/api/voice/mohs/{id}/sounds",
30726 "title": "Add sound to MOH",
30729 "title": "Example usage:",
30730 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30734 "name": "AddSound",
30735 "group": "Voice_MOHs",
30736 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30737 "version": "0.0.0",
30738 "filename": "server/api/voiceMusicOnHold/index.js",
30739 "groupTitle": "Voice_MOHs"
30743 "url": "/api/voice/mohs/{id}",
30744 "title": "Deletes an MOH",
30747 "title": "Example usage:",
30748 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30752 "name": "DestroyMoh",
30753 "group": "Voice_MOHs",
30754 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30755 "version": "0.0.0",
30756 "filename": "server/api/voiceMusicOnHold/index.js",
30757 "groupTitle": "Voice_MOHs"
30761 "url": "/api/voice/mohs",
30762 "title": "Gets a list of Music On Holds",
30765 "title": "Example usage:",
30766 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30770 "name": "GetMusic_On_Holds",
30771 "group": "Voice_MOHs",
30772 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30773 "version": "0.0.0",
30774 "filename": "server/api/voiceMusicOnHold/index.js",
30775 "groupTitle": "Voice_MOHs"
30779 "url": "/api/voice/mohs/{id}/sounds",
30780 "title": "Gets sounds from MOH",
30783 "title": "Example usage:",
30784 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30788 "name": "GetSounds",
30789 "group": "Voice_MOHs",
30790 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30791 "version": "0.0.0",
30792 "filename": "server/api/voiceMusicOnHold/index.js",
30793 "groupTitle": "Voice_MOHs"
30797 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30798 "title": "Remove sound from MOH",
30801 "title": "Example usage:",
30802 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30806 "name": "RemoveSound",
30807 "group": "Voice_MOHs",
30808 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30809 "version": "0.0.0",
30810 "filename": "server/api/voiceMusicOnHold/index.js",
30811 "groupTitle": "Voice_MOHs"
30815 "url": "/api/voice/mohs/{id}",
30816 "title": "Gets a single Music On Hold",
30819 "title": "Example usage:",
30820 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30824 "name": "ShowMusic_On_Holds",
30825 "group": "Voice_MOHs",
30826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30827 "version": "0.0.0",
30828 "filename": "server/api/voiceMusicOnHold/index.js",
30829 "groupTitle": "Voice_MOHs"
30833 "url": "/api/voice/mohs/{id}",
30834 "title": "Update an existing Music On Hold",
30837 "title": "Example usage:",
30838 "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",
30842 "name": "updateMusic_On_Holds",
30843 "group": "Voice_MOHs",
30844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30845 "version": "0.0.0",
30846 "filename": "server/api/voiceMusicOnHold/index.js",
30847 "groupTitle": "Voice_MOHs"
30851 "url": "/api/voice/mails",
30852 "title": "Creates a new Mail",
30855 "title": "Example usage:",
30856 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30860 "name": "CreateMails",
30861 "group": "Voice_Mails",
30869 "field": "customer_id",
30876 "field": "context",
30883 "field": "mailbox",
30890 "field": "password",
30897 "field": "fullname",
30947 "field": "dialout",
30954 "field": "callback",
30976 "field": "operator",
30987 "field": "envelope",
30998 "field": "sayduration",
31005 "field": "saydurationm",
31016 "field": "sendvoicemail",
31038 "field": "nextaftercmd",
31049 "field": "forcename",
31060 "field": "forcegreetings",
31071 "field": "hidefromdir",
31085 "field": "emailsubject",
31092 "field": "emailbody",
31099 "field": "maxsecs",
31119 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31120 "version": "0.0.0",
31121 "filename": "server/api/voiceMail/index.js",
31122 "groupTitle": "Voice_Mails"
31126 "url": "/api/voice/mails/{id}",
31127 "title": "Deletes a Mail",
31130 "title": "Example usage:",
31131 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31135 "name": "DeleteMails",
31136 "group": "Voice_Mails",
31137 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31138 "version": "0.0.0",
31139 "filename": "server/api/voiceMail/index.js",
31140 "groupTitle": "Voice_Mails"
31144 "url": "/api/voice/mails",
31145 "title": "Gets a list of Mails",
31148 "title": "Example usage:",
31149 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31153 "name": "GetMails",
31154 "group": "Voice_Mails",
31155 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31156 "version": "0.0.0",
31157 "filename": "server/api/voiceMail/index.js",
31158 "groupTitle": "Voice_Mails"
31162 "url": "/api/voice/mails/{id}",
31163 "title": "Gets a single Mail",
31166 "title": "Example usage:",
31167 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31171 "name": "ShowMails",
31172 "group": "Voice_Mails",
31173 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31174 "version": "0.0.0",
31175 "filename": "server/api/voiceMail/index.js",
31176 "groupTitle": "Voice_Mails"
31180 "url": "/api/voice/mails/{id}/messages",
31181 "title": "Gets voice mail messages",
31184 "title": "Example usage:",
31185 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31189 "name": "getMessages",
31190 "group": "Voice_Mails",
31191 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31192 "version": "0.0.0",
31193 "filename": "server/api/voiceMail/index.js",
31194 "groupTitle": "Voice_Mails"
31198 "url": "/api/voice/mails/{id}",
31199 "title": "Update an existing Mail",
31202 "title": "Example usage:",
31203 "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",
31207 "name": "updateMails",
31208 "group": "Voice_Mails",
31209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31210 "version": "0.0.0",
31211 "filename": "server/api/voiceMail/index.js",
31212 "groupTitle": "Voice_Mails"
31216 "url": "/api/voice/mails/messages",
31217 "title": "Creates a new Message",
31220 "title": "Example usage:",
31221 "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",
31225 "name": "CreateMessages",
31226 "group": "Voice_Messages",
31255 "field": "context",
31262 "field": "macrocontext",
31269 "field": "callerid",
31276 "field": "origtime",
31283 "field": "duration",
31290 "field": "mailboxuser",
31297 "field": "mailboxcontext",
31304 "field": "recording",
31331 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31332 "version": "0.0.0",
31333 "filename": "server/api/voiceMailMessage/index.js",
31334 "groupTitle": "Voice_Messages"
31338 "url": "/api/voice/mails/messages/{id}",
31339 "title": "Deletes a Message",
31342 "title": "Example usage:",
31343 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31347 "name": "DeleteMessages",
31348 "group": "Voice_Messages",
31349 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31350 "version": "0.0.0",
31351 "filename": "server/api/voiceMailMessage/index.js",
31352 "groupTitle": "Voice_Messages"
31356 "url": "/api/voice/mails/messages",
31357 "title": "Gets a list of Messages",
31360 "title": "Example usage:",
31361 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31365 "name": "GetMessages",
31366 "group": "Voice_Messages",
31367 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31368 "version": "0.0.0",
31369 "filename": "server/api/voiceMailMessage/index.js",
31370 "groupTitle": "Voice_Messages"
31374 "url": "/api/voice/mails/messages/{id}",
31375 "title": "Gets a single Message",
31378 "title": "Example usage:",
31379 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31383 "name": "ShowMessages",
31384 "group": "Voice_Messages",
31385 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31386 "version": "0.0.0",
31387 "filename": "server/api/voiceMailMessage/index.js",
31388 "groupTitle": "Voice_Messages"
31392 "url": "voice/mails/messages/{id}/download",
31393 "title": "Download Voice Message",
31396 "title": "Example usage:",
31397 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31401 "name": "download",
31402 "group": "Voice_Messages",
31403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31404 "version": "0.0.0",
31405 "filename": "server/api/voiceMailMessage/index.js",
31406 "groupTitle": "Voice_Messages"
31410 "url": "/api/voice/mails/messages/{id}",
31411 "title": "Update an existing Message",
31414 "title": "Example usage:",
31415 "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",
31419 "name": "updateMessages",
31420 "group": "Voice_Messages",
31421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31422 "version": "0.0.0",
31423 "filename": "server/api/voiceMailMessage/index.js",
31424 "groupTitle": "Voice_Messages"
31428 "url": "/api/voice/prefixes/{id}/teams",
31429 "title": "Add teams to voice prefix",
31432 "title": "Example usage:",
31433 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31437 "name": "AddTeams",
31438 "group": "Voice_Prefix",
31439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31440 "version": "0.0.0",
31441 "filename": "server/api/voicePrefix/index.js",
31442 "groupTitle": "Voice_Prefix"
31446 "url": "/api/voice/prefixes/{id}/teams",
31447 "title": "Gets voice prefix team",
31450 "title": "Example usage:",
31451 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
31455 "name": "GetTeams",
31456 "group": "Voice_Prefix",
31457 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31458 "version": "0.0.0",
31459 "filename": "server/api/voicePrefix/index.js",
31460 "groupTitle": "Voice_Prefix"
31464 "url": "/api/voice/prefixes/{id}/users",
31465 "title": "Add agents to a prefix",
31468 "title": "Example usage:",
31469 "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",
31473 "name": "AddAgents",
31474 "group": "Voice_Prefixes",
31475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31476 "version": "0.0.0",
31477 "filename": "server/api/voicePrefix/index.js",
31478 "groupTitle": "Voice_Prefixes"
31482 "url": "/api/voice/prefixes/{id}",
31483 "title": "Deletes a Prefix",
31486 "title": "Example usage:",
31487 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31491 "name": "DeletePrefixes",
31492 "group": "Voice_Prefixes",
31493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31494 "version": "0.0.0",
31495 "filename": "server/api/voicePrefix/index.js",
31496 "groupTitle": "Voice_Prefixes"
31500 "url": "/api/voice/prefixes/describe",
31501 "title": "Gets table info about Prefixes",
31504 "title": "Example usage:",
31505 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31509 "name": "DescribePrefixes",
31510 "group": "Voice_Prefixes",
31511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31512 "version": "0.0.0",
31513 "filename": "server/api/voicePrefix/index.js",
31514 "groupTitle": "Voice_Prefixes"
31518 "url": "/api/voice/prefixes/{id}/users",
31519 "title": "Gets agents from prefix",
31522 "title": "Example usage:",
31523 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31527 "name": "GetAgents",
31528 "group": "Voice_Prefixes",
31529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31530 "version": "0.0.0",
31531 "filename": "server/api/voicePrefix/index.js",
31532 "groupTitle": "Voice_Prefixes"
31536 "url": "/api/voice/prefixes",
31537 "title": "Gets a list of Prefixes",
31540 "title": "Example usage:",
31541 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31545 "name": "GetPrefixes",
31546 "group": "Voice_Prefixes",
31547 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31548 "version": "0.0.0",
31549 "filename": "server/api/voicePrefix/index.js",
31550 "groupTitle": "Voice_Prefixes"
31554 "url": "/api/voice/prefixes/{id}/users",
31555 "title": "Removes agents from a prefix",
31558 "title": "Example usage:",
31559 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31563 "name": "RemoveAgents",
31564 "group": "Voice_Prefixes",
31565 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31566 "version": "0.0.0",
31567 "filename": "server/api/voicePrefix/index.js",
31568 "groupTitle": "Voice_Prefixes"
31572 "url": "/api/voice/prefixes/{id}",
31573 "title": "Gets a single Prefix",
31576 "title": "Example usage:",
31577 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31581 "name": "ShowPrefixes",
31582 "group": "Voice_Prefixes",
31583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31584 "version": "0.0.0",
31585 "filename": "server/api/voicePrefix/index.js",
31586 "groupTitle": "Voice_Prefixes"
31590 "url": "/api/voice/prefixes/{id}",
31591 "title": "Update an existing prefix",
31594 "title": "Example usage:",
31595 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31600 "group": "Voice_Prefixes",
31601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31602 "version": "0.0.0",
31603 "filename": "server/api/voicePrefix/index.js",
31604 "groupTitle": "Voice_Prefixes"
31608 "url": "/api/voice/prefixes",
31609 "title": "Create a prefix",
31612 "title": "Example usage:",
31613 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31618 "group": "Voice_Prefixes",
31619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31620 "version": "0.0.0",
31621 "filename": "server/api/voicePrefix/index.js",
31622 "groupTitle": "Voice_Prefixes"
31626 "url": "/api/voice/queues/reports/describe",
31627 "title": "Gets table info about Queue Reports",
31630 "title": "Example usage:",
31631 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31635 "name": "DescribeQueue_Reports",
31636 "group": "Voice_Queue_Reports",
31637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31638 "version": "0.0.0",
31639 "filename": "server/api/voiceQueueReport/index.js",
31640 "groupTitle": "Voice_Queue_Reports"
31644 "url": "/api/voice/queues/reports",
31645 "title": "Gets a list of Queue Reports",
31648 "title": "Example usage:",
31649 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31653 "name": "GetQueue_Reports",
31654 "group": "Voice_Queue_Reports",
31655 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31656 "version": "0.0.0",
31657 "filename": "server/api/voiceQueueReport/index.js",
31658 "groupTitle": "Voice_Queue_Reports"
31662 "url": "/api/voice/queues/reports/{id}",
31663 "title": "Gets a single Queue Report",
31666 "title": "Example usage:",
31667 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31671 "name": "ShowQueue_Reports",
31672 "group": "Voice_Queue_Reports",
31673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31674 "version": "0.0.0",
31675 "filename": "server/api/voiceQueueReport/index.js",
31676 "groupTitle": "Voice_Queue_Reports"
31680 "url": "/api/voice/queues/reports/index",
31681 "title": "Get Voice Queues Report",
31684 "title": "Example usage:",
31685 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31689 "name": "getVoiceQueuesReport",
31690 "group": "Voice_Queue_Reports",
31691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31692 "version": "0.0.0",
31693 "filename": "server/api/voiceQueueReport/index.js",
31694 "groupTitle": "Voice_Queue_Reports"
31698 "url": "/api/voice/queues/{id}/users",
31699 "title": "Add agents to queue",
31702 "title": "Example usage:",
31703 "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",
31707 "name": "AddAgents",
31708 "group": "Voice_Queues",
31709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31710 "version": "0.0.0",
31711 "filename": "server/api/voiceQueue/index.js",
31712 "groupTitle": "Voice_Queues"
31716 "url": "/api/voice/queues/{id}/blacklists",
31717 "title": "Add blacklists to a queue",
31720 "title": "Example usage:",
31721 "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",
31725 "name": "AddBlackLists",
31726 "group": "Voice_Queues",
31727 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31728 "version": "0.0.0",
31729 "filename": "server/api/voiceQueue/index.js",
31730 "groupTitle": "Voice_Queues"
31734 "url": "/api/voice/queues/{id}/lists",
31735 "title": "Add lists to a queue",
31738 "title": "Example usage:",
31739 "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",
31743 "name": "AddLists",
31744 "group": "Voice_Queues",
31745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31746 "version": "0.0.0",
31747 "filename": "server/api/voiceQueue/index.js",
31748 "groupTitle": "Voice_Queues"
31752 "url": "/api/voice/queues/{id}/teams",
31753 "title": "Add teams to queue",
31756 "title": "Example usage:",
31757 "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",
31761 "name": "AddTeams",
31762 "group": "Voice_Queues",
31763 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31764 "version": "0.0.0",
31765 "filename": "server/api/voiceQueue/index.js",
31766 "groupTitle": "Voice_Queues"
31770 "url": "/api/voice/queues/clone",
31771 "title": "Clone an existing Queue",
31774 "title": "Example usage:",
31775 "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",
31779 "name": "CloneQueues",
31780 "group": "Voice_Queues",
31781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31782 "version": "0.0.0",
31783 "filename": "server/api/voiceQueue/index.js",
31784 "groupTitle": "Voice_Queues"
31788 "url": "/api/voice/queues",
31789 "title": "Creates a new Queue",
31792 "title": "Example usage:",
31793 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31797 "name": "CreateQueues",
31798 "group": "Voice_Queues",
31824 "field": "musiconhold",
31831 "field": "announce",
31849 "field": "strategy",
31856 "field": "servicelevel",
31863 "field": "context",
31870 "field": "penaltymemberslimit",
31877 "field": "timeout",
31891 "field": "timeoutpriority",
31905 "field": "wrapuptime",
31916 "field": "autofill",
31928 "field": "autopause",
31935 "field": "autopausedelay",
31946 "field": "autopausebusy",
31957 "field": "autopauseunavail",
31975 "field": "setinterfacevar",
31986 "field": "setqueueentryvar",
31997 "field": "setqueuevar",
32008 "field": "eventmemberstatus",
32015 "field": "membermacro",
32022 "field": "membergosub",
32029 "field": "announce_frequency",
32036 "field": "min_announce_frequency",
32043 "field": "periodic_announce_frequency",
32054 "field": "random_periodic_announce",
32065 "field": "relative_periodic_announce",
32077 "field": "announce_holdtime",
32084 "field": "announce_position",
32095 "field": "announce_to_first_user",
32102 "field": "announce_position_limit",
32117 "field": "announce_round_seconds",
32124 "field": "monitor_format",
32131 "field": "monitor_type",
32138 "field": "queue_youarenext",
32145 "field": "queue_thereare",
32152 "field": "queue_callswaiting",
32159 "field": "queue_holdtime",
32166 "field": "queue_minute",
32173 "field": "queue_minutes",
32180 "field": "queue_seconds",
32187 "field": "queue_thankyou",
32194 "field": "queue_reporthold",
32201 "field": "queue_quantity1",
32208 "field": "queue_quantity2",
32215 "field": "queue_periodic_announce",
32222 "field": "queue_less_than",
32229 "field": "periodic_announce",
32236 "field": "joinempty",
32243 "field": "leavewhenempty",
32254 "field": "reportholdtime",
32265 "field": "ringinuse",
32272 "field": "memberdelay",
32283 "field": "timeoutrestart",
32290 "field": "defaultrule",
32297 "field": "description",
32311 "field": "acwTimeout",
32318 "field": "dialActive",
32319 "description": "<p>Active/Disactive Campaign</p>"
32332 "field": "dialMethod",
32333 "description": "<p>Dial Method.</p>"
32339 "field": "dialLimitChannel",
32340 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32346 "field": "dialLimitQueue",
32347 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32353 "field": "dialPowerLevel",
32354 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32360 "\"agentBusyFactor\"",
32364 "field": "dialPredictiveOptimization",
32365 "description": "<p>Only for predictive method.</p>"
32371 "field": "dialPredictiveOptimizationPercentage",
32372 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32378 "field": "dialPredictiveInterval",
32379 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32385 "field": "dialOriginateCallerIdName",
32392 "field": "dialOriginateCallerIdNumber",
32399 "field": "dialOriginateTimeout",
32400 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32406 "field": "dialQueueOptions",
32407 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32413 "field": "dialQueueTimeout",
32414 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32420 "field": "dialQueueProject",
32421 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32427 "field": "dialCongestionMaxRetry",
32428 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32434 "field": "dialCongestionRetryFrequency",
32435 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32441 "field": "dialBusyMaxRetry",
32442 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32448 "field": "dialBusyRetryFrequency",
32449 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32455 "field": "dialNoAnswerMaxRetry",
32456 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32462 "field": "dialNoAnswerRetryFrequency",
32463 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32469 "field": "dialGlobalMaxRetry",
32470 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32476 "field": "dialTimezone",
32483 "field": "dialGlobalInterval",
32490 "field": "dialPrefix",
32502 "field": "dialCheckDuplicateType",
32509 "field": "dialAMDActive",
32510 "description": "<p>Active/Disactive AMD</p>"
32516 "field": "dialAMDInitialSilence",
32517 "description": "<p>#AMD Initial Silence</p>"
32523 "field": "dialAMDGreeting",
32524 "description": "<p>#AMD Greeting</p>"
32530 "field": "dialAMDAfterGreetingSilence",
32531 "description": "<p>#AMD After Greeting Silence</p>"
32537 "field": "dialAMDTotalAnalysisTime",
32538 "description": "<p>#AMD Total Analysis Time</p>"
32544 "field": "dialAMDMinWordLength",
32545 "description": "<p>#AMD Min Word Length</p>"
32551 "field": "dialAMDBetweenWordsSilence",
32552 "description": "<p>#AMD Between Words Silence</p>"
32558 "field": "dialAMDMaximumNumberOfWords",
32559 "description": "<p>#AMD Maximum Number Of Words</p>"
32565 "field": "dialAMDSilenceThreshold",
32566 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32572 "field": "dialAMDMaximumWordLength",
32573 "description": "<p>#AMD Maximum Word Length</p>"
32579 "field": "dialRecallMeTimeout",
32580 "description": "<p>#RecallMe Timeout (min:1)</p>"
32586 "field": "dialRecallInQueue",
32587 "description": "<p>Active/Disactive Recall In Queue</p>"
32597 "field": "dialOrderByScheduledAt",
32604 "field": "dialQueueProject2",
32605 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32611 "field": "dialAgiAfterHangupClient",
32618 "field": "dialAgiAfterHangupAgent",
32625 "field": "dialRandomLastDigitCallerIdNumber",
32626 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32632 "field": "dialCutDigit",
32633 "description": "<p>Cut Digit (min:1, max:15)</p>"
32639 "field": "dialNoSuchNumberMaxRetry",
32640 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32646 "field": "dialNoSuchNumberRetryFrequency",
32647 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32653 "field": "dialDropMaxRetry",
32654 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32660 "field": "dialDropRetryFrequency",
32661 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32667 "field": "dialAbandonedMaxRetry",
32668 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32674 "field": "dialAbandonedRetryFrequency",
32675 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32681 "field": "dialMachineMaxRetry",
32682 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32688 "field": "dialMachineRetryFrequency",
32689 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32695 "field": "dialAgentRejectMaxRetry",
32696 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32702 "field": "dialAgentRejectRetryFrequency",
32703 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32709 "field": "mandatoryDispositionPauseId",
32710 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32716 "field": "mandatoryDisposition",
32717 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32723 "field": "dialPredictiveIntervalMaxThreshold",
32730 "field": "dialPredictiveIntervalMinThreshold",
32737 "field": "dialPreviewAutoRecallMe",
32743 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32744 "version": "0.0.0",
32745 "filename": "server/api/voiceQueue/index.js",
32746 "groupTitle": "Voice_Queues"
32750 "url": "/api/voice/queues/{id}",
32751 "title": "Deletes a Queue",
32754 "title": "Example usage:",
32755 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32759 "name": "DeleteQueues",
32760 "group": "Voice_Queues",
32761 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32762 "version": "0.0.0",
32763 "filename": "server/api/voiceQueue/index.js",
32764 "groupTitle": "Voice_Queues"
32768 "url": "/api/voice/queues/{id}/users",
32769 "title": "Gets queue agents",
32772 "title": "Example usage:",
32773 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32777 "name": "GetAgents",
32778 "group": "Voice_Queues",
32779 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32780 "version": "0.0.0",
32781 "filename": "server/api/voiceQueue/index.js",
32782 "groupTitle": "Voice_Queues"
32786 "url": "/api/voice/queues/{id}/blacklists",
32787 "title": "Get queue blacklists",
32790 "title": "Example usage:",
32791 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32795 "name": "GetBlackLists",
32796 "group": "Voice_Queues",
32797 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32798 "version": "0.0.0",
32799 "filename": "server/api/voiceQueue/index.js",
32800 "groupTitle": "Voice_Queues"
32804 "url": "/api/voice/queues/{id}/finals",
32805 "title": "Gets queue hopper finals",
32808 "title": "Example usage:",
32809 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32813 "name": "GetHopperFinals",
32814 "group": "Voice_Queues",
32815 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32816 "version": "0.0.0",
32817 "filename": "server/api/voiceQueue/index.js",
32818 "groupTitle": "Voice_Queues"
32822 "url": "/api/voice/queues/{id}/hopper_histories",
32823 "title": "Gets queue hopper histories",
32826 "title": "Example usage:",
32827 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32831 "name": "GetHopperHistories",
32832 "group": "Voice_Queues",
32833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32834 "version": "0.0.0",
32835 "filename": "server/api/voiceQueue/index.js",
32836 "groupTitle": "Voice_Queues"
32840 "url": "/api/voice/queues/{id}/hoppers",
32841 "title": "Gets queue hoppers",
32844 "title": "Example usage:",
32845 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32849 "name": "GetHoppers",
32850 "group": "Voice_Queues",
32851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32852 "version": "0.0.0",
32853 "filename": "server/api/voiceQueue/index.js",
32854 "groupTitle": "Voice_Queues"
32858 "url": "/api/voice/queues/{id}/lists",
32859 "title": "Get queue lists",
32862 "title": "Example usage:",
32863 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32867 "name": "GetLists",
32868 "group": "Voice_Queues",
32869 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32870 "version": "0.0.0",
32871 "filename": "server/api/voiceQueue/index.js",
32872 "groupTitle": "Voice_Queues"
32876 "url": "/api/voice/queues/{id}/members",
32877 "title": "Gets queue members",
32880 "title": "Example usage:",
32881 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32885 "name": "GetMembers",
32886 "group": "Voice_Queues",
32887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32888 "version": "0.0.0",
32889 "filename": "server/api/voiceQueue/index.js",
32890 "groupTitle": "Voice_Queues"
32894 "url": "/api/voice/queues",
32895 "title": "Gets a list of Queues",
32898 "title": "Example usage:",
32899 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32903 "name": "GetQueues",
32904 "group": "Voice_Queues",
32905 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32906 "version": "0.0.0",
32907 "filename": "server/api/voiceQueue/index.js",
32908 "groupTitle": "Voice_Queues"
32912 "url": "/api/voice/queues/{id}/teams",
32913 "title": "Gets queue team",
32916 "title": "Example usage:",
32917 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32921 "name": "GetTeams",
32922 "group": "Voice_Queues",
32923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32924 "version": "0.0.0",
32925 "filename": "server/api/voiceQueue/index.js",
32926 "groupTitle": "Voice_Queues"
32930 "url": "/api/voice/queues/{id}/users",
32931 "title": "Removes agents from a queue",
32934 "title": "Example usage:",
32935 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32939 "name": "RemoveAgents",
32940 "group": "Voice_Queues",
32941 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32942 "version": "0.0.0",
32943 "filename": "server/api/voiceQueue/index.js",
32944 "groupTitle": "Voice_Queues"
32948 "url": "/api/voice/queues/{id}/blacklists",
32949 "title": "Remove blacklists from a queue",
32952 "title": "Example usage:",
32953 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32957 "name": "RemoveBlackLists",
32958 "group": "Voice_Queues",
32959 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32960 "version": "0.0.0",
32961 "filename": "server/api/voiceQueue/index.js",
32962 "groupTitle": "Voice_Queues"
32966 "url": "/api/voice/queues/{id}/lists",
32967 "title": "Remove lists from a queue",
32970 "title": "Example usage:",
32971 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32975 "name": "RemoveLists",
32976 "group": "Voice_Queues",
32977 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32978 "version": "0.0.0",
32979 "filename": "server/api/voiceQueue/index.js",
32980 "groupTitle": "Voice_Queues"
32984 "url": "/api/voice/queues/{id}",
32985 "title": "Gets a single Queue",
32988 "title": "Example usage:",
32989 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32993 "name": "ShowQueues",
32994 "group": "Voice_Queues",
32995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32996 "version": "0.0.0",
32997 "filename": "server/api/voiceQueue/index.js",
32998 "groupTitle": "Voice_Queues"
33002 "url": "/api/voice/queues/{id}/blacks",
33003 "title": "Gets queue hopper blacks",
33006 "title": "Example usage:",
33007 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33011 "name": "getHopperBlacks",
33012 "group": "Voice_Queues",
33013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33014 "version": "0.0.0",
33015 "filename": "server/api/voiceQueue/index.js",
33016 "groupTitle": "Voice_Queues"
33020 "url": "/api/voice/queues/{id}",
33021 "title": "Update an existing Queue",
33024 "title": "Example usage:",
33025 "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",
33029 "name": "updateQueues",
33030 "group": "Voice_Queues",
33031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33032 "version": "0.0.0",
33033 "filename": "server/api/voiceQueue/index.js",
33034 "groupTitle": "Voice_Queues"
33038 "url": "/api/voice/recordings",
33039 "title": "Creates a new Recording",
33042 "title": "Example usage:",
33043 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33047 "name": "CreateRecordings",
33048 "group": "Voice_Recordings",
33063 "field": "uniqueid",
33070 "field": "channel",
33077 "field": "membername",
33084 "field": "calleridnum",
33091 "field": "calleridname",
33098 "field": "connectedlinenum",
33105 "field": "connectedlinename",
33112 "field": "accountcode",
33119 "field": "context",
33161 "field": "userDisposition",
33168 "field": "userSecondDisposition",
33175 "field": "userThirdDisposition",
33182 "field": "location",
33189 "field": "transcribeName",
33196 "field": "transcribeStatus",
33203 "field": "fileUri",
33210 "field": "fileText",
33217 "field": "failureReason",
33224 "field": "sentiment",
33231 "field": "sPositive",
33238 "field": "sNegative",
33245 "field": "sNeutral",
33259 "field": "tempSentiment",
33266 "field": "createdAt",
33273 "field": "updatedAt",
33279 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33280 "version": "0.0.0",
33281 "filename": "server/api/voiceRecording/index.js",
33282 "groupTitle": "Voice_Recordings"
33286 "url": "/api/voice/recordings/describe",
33287 "title": "Gets table info about Recordings",
33290 "title": "Example usage:",
33291 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33295 "name": "DescribeRecordings",
33296 "group": "Voice_Recordings",
33297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33298 "version": "0.0.0",
33299 "filename": "server/api/voiceRecording/index.js",
33300 "groupTitle": "Voice_Recordings"
33304 "url": "/api/voice/recordings",
33305 "title": "Gets a list of Recordings",
33308 "title": "Example usage:",
33309 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33313 "name": "GetRecordings",
33314 "group": "Voice_Recordings",
33315 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33316 "version": "0.0.0",
33317 "filename": "server/api/voiceRecording/index.js",
33318 "groupTitle": "Voice_Recordings"
33322 "url": "/api/voice/recordings/{id}",
33323 "title": "Gets a single Recording",
33326 "title": "Example usage:",
33327 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33331 "name": "ShowRecordings",
33332 "group": "Voice_Recordings",
33333 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33334 "version": "0.0.0",
33335 "filename": "server/api/voiceRecording/index.js",
33336 "groupTitle": "Voice_Recordings"
33340 "url": "/api/voice/recordings/{id}",
33341 "title": "Delete voice recording",
33344 "title": "Example usage:",
33345 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33350 "group": "Voice_Recordings",
33351 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33352 "version": "0.0.0",
33353 "filename": "server/api/voiceRecording/index.js",
33354 "groupTitle": "Voice_Recordings"
33358 "url": "/api/voice/recordings/{id}/download",
33359 "title": "Download Recording",
33362 "title": "Example usage:",
33363 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33367 "name": "download",
33368 "group": "Voice_Recordings",
33369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33370 "version": "0.0.0",
33371 "filename": "server/api/voiceRecording/index.js",
33372 "groupTitle": "Voice_Recordings"
33376 "url": "/api/voice/recordings/{id}/downloads",
33377 "title": "Download Recording",
33380 "title": "Example usage:",
33381 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33385 "name": "downloads",
33386 "group": "Voice_Recordings",
33387 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33388 "version": "0.0.0",
33389 "filename": "server/api/voiceRecording/index.js",
33390 "groupTitle": "Voice_Recordings"
33394 "url": "/api/voice/recordings/{id}/transcribe",
33395 "title": "Run Transcribe Recording",
33398 "title": "Example usage:",
33399 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33403 "name": "transcribe",
33404 "group": "Voice_Recordings",
33405 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33406 "version": "0.0.0",
33407 "filename": "server/api/voiceRecording/index.js",
33408 "groupTitle": "Voice_Recordings"
33412 "url": "/api/voice/recordings/{id}/transcribe",
33413 "title": "Run Transcribe Recording",
33416 "title": "Example usage:",
33417 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33421 "name": "transcribe",
33422 "group": "Voice_Recordings",
33423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33424 "version": "0.0.0",
33425 "filename": "server/api/voiceRecording/index.js",
33426 "groupTitle": "Voice_Recordings"
33430 "url": "/api/voice/recordings/{id}",
33431 "title": "Update an existing Recording",
33434 "title": "Example usage:",
33435 "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",
33439 "name": "updateRecordings",
33440 "group": "Voice_Recordings",
33441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33442 "version": "0.0.0",
33443 "filename": "server/api/voiceRecording/index.js",
33444 "groupTitle": "Voice_Recordings"
33448 "url": "/api/voice/transfers/reports",
33449 "title": "Creates a new Transfer Report",
33452 "title": "Example usage:",
33453 "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",
33457 "name": "CreateTransfer_Reports",
33458 "group": "Voice_Transfer_Reports",
33484 "field": "transfererchannel",
33491 "field": "transferercalleridnum",
33498 "field": "transferercalleridname",
33505 "field": "transfererconnectedlinenum",
33512 "field": "transfererconnectedlinename",
33519 "field": "transfereraccountcode",
33526 "field": "transferercontext",
33533 "field": "transfererexten",
33540 "field": "transfererlinkedid",
33547 "field": "transfereechannel",
33554 "field": "transfereecalleridnum",
33561 "field": "transfereecalleridname",
33568 "field": "transfereeconnectedlinenum",
33575 "field": "transfereeconnectedlinename",
33582 "field": "transfereeaccountcode",
33589 "field": "transfereecontext",
33596 "field": "transfereeexten",
33603 "field": "transfereelinkedid",
33614 "field": "isexternal",
33621 "field": "context",
33628 "field": "extension",
33634 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33635 "version": "0.0.0",
33636 "filename": "server/api/voiceTransferReport/index.js",
33637 "groupTitle": "Voice_Transfer_Reports"
33641 "url": "/api/voice/transfers/reports/{id}",
33642 "title": "Deletes a Transfer Report",
33645 "title": "Example usage:",
33646 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33650 "name": "DeleteTransfer_Reports",
33651 "group": "Voice_Transfer_Reports",
33652 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33653 "version": "0.0.0",
33654 "filename": "server/api/voiceTransferReport/index.js",
33655 "groupTitle": "Voice_Transfer_Reports"
33659 "url": "/api/voice/transfers/reports/describe",
33660 "title": "Gets table info about Transfer Reports",
33663 "title": "Example usage:",
33664 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33668 "name": "DescribeTransfer_Reports",
33669 "group": "Voice_Transfer_Reports",
33670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33671 "version": "0.0.0",
33672 "filename": "server/api/voiceTransferReport/index.js",
33673 "groupTitle": "Voice_Transfer_Reports"
33677 "url": "/api/voice/transfers/reports",
33678 "title": "Gets a list of Transfer Reports",
33681 "title": "Example usage:",
33682 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33686 "name": "GetTransfer_Reports",
33687 "group": "Voice_Transfer_Reports",
33688 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33689 "version": "0.0.0",
33690 "filename": "server/api/voiceTransferReport/index.js",
33691 "groupTitle": "Voice_Transfer_Reports"
33695 "url": "/api/voice/transfers/reports/{id}",
33696 "title": "Gets a single Transfer Report",
33699 "title": "Example usage:",
33700 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33704 "name": "ShowTransfer_Reports",
33705 "group": "Voice_Transfer_Reports",
33706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33707 "version": "0.0.0",
33708 "filename": "server/api/voiceTransferReport/index.js",
33709 "groupTitle": "Voice_Transfer_Reports"
33713 "url": "/api/voice/transfers/reports/{id}",
33714 "title": "Update an existing Transfer Report",
33717 "title": "Example usage:",
33718 "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",
33722 "name": "updateTransfer_Reports",
33723 "group": "Voice_Transfer_Reports",
33724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33725 "version": "0.0.0",
33726 "filename": "server/api/voiceTransferReport/index.js",
33727 "groupTitle": "Voice_Transfer_Reports"
33731 "url": "/api/integrations/vtiger/accounts",
33732 "title": "Creates a new Vtiger Account",
33735 "title": "Example usage:",
33736 "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",
33740 "name": "CreateVtiger_Accounts",
33741 "group": "Vtiger_Accounts",
33756 "field": "description",
33763 "field": "username",
33770 "field": "moduleName",
33777 "field": "remoteUri",
33784 "field": "serverUrl",
33791 "field": "accessKey",
33797 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33798 "version": "0.0.0",
33799 "filename": "server/api/intVtigerAccount/index.js",
33800 "groupTitle": "Vtiger_Accounts"
33804 "url": "/api/integrations/vtiger/accounts/{id}",
33805 "title": "Deletes a Vtiger Account",
33808 "title": "Example usage:",
33809 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33813 "name": "DeleteVtiger_Accounts",
33814 "group": "Vtiger_Accounts",
33815 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33816 "version": "0.0.0",
33817 "filename": "server/api/intVtigerAccount/index.js",
33818 "groupTitle": "Vtiger_Accounts"
33822 "url": "/api/integrations/vtiger/accounts",
33823 "title": "Gets a list of Vtiger Accounts",
33826 "title": "Example usage:",
33827 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33831 "name": "GetVtiger_Accounts",
33832 "group": "Vtiger_Accounts",
33833 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33834 "version": "0.0.0",
33835 "filename": "server/api/intVtigerAccount/index.js",
33836 "groupTitle": "Vtiger_Accounts"
33840 "url": "/api/integrations/vtiger/accounts/{id}",
33841 "title": "Gets a single Vtiger Account",
33844 "title": "Example usage:",
33845 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33849 "name": "ShowVtiger_Accounts",
33850 "group": "Vtiger_Accounts",
33851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33852 "version": "0.0.0",
33853 "filename": "server/api/intVtigerAccount/index.js",
33854 "groupTitle": "Vtiger_Accounts"
33858 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33859 "title": "Creates new configuration",
33862 "title": "Example usage:",
33863 "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",
33867 "name": "addConfiguration",
33868 "group": "Vtiger_Accounts",
33869 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33870 "version": "0.0.0",
33871 "filename": "server/api/intVtigerAccount/index.js",
33872 "groupTitle": "Vtiger_Accounts"
33876 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33877 "title": "Gets account configurations",
33880 "title": "Example usage:",
33881 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33885 "name": "getConfigurations",
33886 "group": "Vtiger_Accounts",
33887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33888 "version": "0.0.0",
33889 "filename": "server/api/intVtigerAccount/index.js",
33890 "groupTitle": "Vtiger_Accounts"
33894 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33895 "title": "Gets account fields",
33898 "title": "Example usage:",
33899 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33903 "name": "getFields",
33904 "group": "Vtiger_Accounts",
33905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33906 "version": "0.0.0",
33907 "filename": "server/api/intVtigerAccount/index.js",
33908 "groupTitle": "Vtiger_Accounts"
33912 "url": "/api/integrations/vtiger/accounts/{id}",
33913 "title": "Update an existing Vtiger Account",
33916 "title": "Example usage:",
33917 "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",
33921 "name": "updateVtiger_Accounts",
33922 "group": "Vtiger_Accounts",
33923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33924 "version": "0.0.0",
33925 "filename": "server/api/intVtigerAccount/index.js",
33926 "groupTitle": "Vtiger_Accounts"
33930 "url": "/api/integrations/vtiger/configurations",
33931 "title": "Creates a new Vtiger Configuration",
33934 "title": "Example usage:",
33935 "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",
33939 "name": "CreateVtiger_Configurations",
33940 "group": "Vtiger_Configurations",
33955 "field": "description",
33961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33962 "version": "0.0.0",
33963 "filename": "server/api/intVtigerConfiguration/index.js",
33964 "groupTitle": "Vtiger_Configurations"
33968 "url": "/api/integrations/vtiger/configurations/{id}",
33969 "title": "Deletes a Vtiger Configuration",
33972 "title": "Example usage:",
33973 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33977 "name": "DeleteVtiger_Configurations",
33978 "group": "Vtiger_Configurations",
33979 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33980 "version": "0.0.0",
33981 "filename": "server/api/intVtigerConfiguration/index.js",
33982 "groupTitle": "Vtiger_Configurations"
33986 "url": "/api/integrations/vtiger/configurations",
33987 "title": "Gets a list of Vtiger Configurations",
33990 "title": "Example usage:",
33991 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33995 "name": "GetVtiger_Configurations",
33996 "group": "Vtiger_Configurations",
33997 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33998 "version": "0.0.0",
33999 "filename": "server/api/intVtigerConfiguration/index.js",
34000 "groupTitle": "Vtiger_Configurations"
34004 "url": "/api/integrations/vtiger/configurations/{id}",
34005 "title": "Gets a single Vtiger Configuration",
34008 "title": "Example usage:",
34009 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34013 "name": "ShowVtiger_Configurations",
34014 "group": "Vtiger_Configurations",
34015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34016 "version": "0.0.0",
34017 "filename": "server/api/intVtigerConfiguration/index.js",
34018 "groupTitle": "Vtiger_Configurations"
34022 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34023 "title": "Gets configurations descriptions",
34026 "title": "Example usage:",
34027 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34031 "name": "getDescriptions",
34032 "group": "Vtiger_Configurations",
34033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34034 "version": "0.0.0",
34035 "filename": "server/api/intVtigerConfiguration/index.js",
34036 "groupTitle": "Vtiger_Configurations"
34040 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34041 "title": "Gets configurations fields",
34044 "title": "Example usage:",
34045 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34049 "name": "getFields",
34050 "group": "Vtiger_Configurations",
34051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34052 "version": "0.0.0",
34053 "filename": "server/api/intVtigerConfiguration/index.js",
34054 "groupTitle": "Vtiger_Configurations"
34058 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34059 "title": "Gets configurations subjects",
34062 "title": "Example usage:",
34063 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34067 "name": "getSubjects",
34068 "group": "Vtiger_Configurations",
34069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34070 "version": "0.0.0",
34071 "filename": "server/api/intVtigerConfiguration/index.js",
34072 "groupTitle": "Vtiger_Configurations"
34076 "url": "/api/integrations/vtiger/configurations/{id}",
34077 "title": "Update an existing Vtiger Configuration",
34080 "title": "Example usage:",
34081 "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",
34085 "name": "updateVtiger_Configurations",
34086 "group": "Vtiger_Configurations",
34087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34088 "version": "0.0.0",
34089 "filename": "server/api/intVtigerConfiguration/index.js",
34090 "groupTitle": "Vtiger_Configurations"
34094 "url": "/api/integrations/vtiger/fields",
34095 "title": "Creates a new Vtiger Field",
34098 "title": "Example usage:",
34099 "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",
34103 "name": "CreateVtiger_Fields",
34104 "group": "Vtiger_Fields",
34114 "\"customVariable\"",
34126 "field": "content",
34142 "\"customVariable\""
34145 "field": "keyType",
34152 "field": "keyContent",
34159 "field": "idField",
34166 "field": "nameField",
34173 "field": "customField",
34180 "field": "variableName",
34186 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34187 "version": "0.0.0",
34188 "filename": "server/api/intVtigerField/index.js",
34189 "groupTitle": "Vtiger_Fields"
34193 "url": "/api/integrations/vtiger/fields/{id}",
34194 "title": "Deletes a Vtiger Field",
34197 "title": "Example usage:",
34198 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34202 "name": "DeleteVtiger_Fields",
34203 "group": "Vtiger_Fields",
34204 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34205 "version": "0.0.0",
34206 "filename": "server/api/intVtigerField/index.js",
34207 "groupTitle": "Vtiger_Fields"
34211 "url": "/api/integrations/vtiger/fields",
34212 "title": "Gets a list of Vtiger Fields",
34215 "title": "Example usage:",
34216 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34220 "name": "GetVtiger_Fields",
34221 "group": "Vtiger_Fields",
34222 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34223 "version": "0.0.0",
34224 "filename": "server/api/intVtigerField/index.js",
34225 "groupTitle": "Vtiger_Fields"
34229 "url": "/api/integrations/vtiger/fields/{id}",
34230 "title": "Gets a single Vtiger Field",
34233 "title": "Example usage:",
34234 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34238 "name": "ShowVtiger_Fields",
34239 "group": "Vtiger_Fields",
34240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34241 "version": "0.0.0",
34242 "filename": "server/api/intVtigerField/index.js",
34243 "groupTitle": "Vtiger_Fields"
34247 "url": "/api/integrations/vtiger/fields/{id}",
34248 "title": "Update an existing Vtiger Field",
34251 "title": "Example usage:",
34252 "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",
34256 "name": "updateVtiger_Fields",
34257 "group": "Vtiger_Fields",
34258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34259 "version": "0.0.0",
34260 "filename": "server/api/intVtigerField/index.js",
34261 "groupTitle": "Vtiger_Fields"
34265 "url": "/api/webbar/answer",
34266 "title": "answer webrtc call",
34269 "title": "Example usage:",
34270 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34274 "name": "Web_Bar_answer",
34283 "field": "sessionId",
34296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34297 "version": "0.0.0",
34298 "filename": "server/api/webbar/index.js",
34299 "groupTitle": "WebBar"
34303 "url": "/api/webbar/calls",
34304 "title": "webrtc call list",
34307 "title": "Example usage:",
34308 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34312 "name": "Web_Bar_calls",
34327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34328 "version": "0.0.0",
34329 "filename": "server/api/webbar/index.js",
34330 "groupTitle": "WebBar"
34334 "url": "/api/webbar/hangup",
34335 "title": "hangup webrtc call",
34338 "title": "Example usage:",
34339 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34343 "name": "Web_Bar_hangup",
34352 "field": "sessionId",
34365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34366 "version": "0.0.0",
34367 "filename": "server/api/webbar/index.js",
34368 "groupTitle": "WebBar"
34372 "url": "/api/webbar/unhold",
34373 "title": "unhold webrtc call",
34376 "title": "Example usage:",
34377 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34381 "name": "Web_Bar_hold",
34390 "field": "sessionId",
34403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34404 "version": "0.0.0",
34405 "filename": "server/api/webbar/index.js",
34406 "groupTitle": "WebBar"
34410 "url": "/api/webbar/hold",
34411 "title": "hold webrtc call",
34414 "title": "Example usage:",
34415 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34419 "name": "Web_Bar_hold",
34428 "field": "sessionId",
34441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34442 "version": "0.0.0",
34443 "filename": "server/api/webbar/index.js",
34444 "groupTitle": "WebBar"
34448 "url": "/api/webbar/originate",
34449 "title": "Originate new webrtc call",
34452 "title": "Example usage:",
34453 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34457 "name": "Web_Bar_originate",
34466 "field": "callNumber",
34480 "field": "callerId",
34487 "field": "callbackUrl",
34493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34494 "version": "0.0.0",
34495 "filename": "server/api/webbar/index.js",
34496 "groupTitle": "WebBar"
34500 "url": "/api/webbar/transfer",
34501 "title": "blind transfer webrtc call",
34504 "title": "Example usage:",
34505 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34509 "name": "Web_Bar_transfer",
34525 "field": "sessionId",
34532 "field": "transferNumber",
34538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34539 "version": "0.0.0",
34540 "filename": "server/api/webbar/index.js",
34541 "groupTitle": "WebBar"
34545 "url": "/api/whatsapp/accounts/{id}/users",
34546 "title": "Add agents to a whatsapp account",
34549 "title": "Example usage:",
34550 "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",
34554 "name": "AddAgents",
34555 "group": "Whatsapp_Accounts",
34556 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34557 "version": "0.0.0",
34558 "filename": "server/api/whatsappAccount/index.js",
34559 "groupTitle": "Whatsapp_Accounts"
34563 "url": "/api/whatsapp/accounts",
34564 "title": "Creates a new Account",
34567 "title": "Example usage:",
34568 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34572 "name": "CreateAccounts",
34573 "group": "Whatsapp_Accounts",
34626 "field": "accountSid",
34633 "field": "authToken",
34640 "field": "notificationTemplate",
34647 "field": "notificationSound",
34654 "field": "notificationShake",
34661 "field": "waitForTheAssignedAgent",
34668 "field": "queueTransfer",
34675 "field": "queueTransferTimeout",
34682 "field": "agentTransfer",
34689 "field": "agentTransferTimeout",
34696 "field": "mandatoryDispositionPauseId",
34697 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34703 "field": "mandatoryDisposition",
34704 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34710 "field": "description",
34716 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34717 "version": "0.0.0",
34718 "filename": "server/api/whatsappAccount/index.js",
34719 "groupTitle": "Whatsapp_Accounts"
34723 "url": "/api/whatsapp/accounts/{id}",
34724 "title": "Deletes a Account",
34727 "title": "Example usage:",
34728 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34732 "name": "DeleteAccounts",
34733 "group": "Whatsapp_Accounts",
34734 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34735 "version": "0.0.0",
34736 "filename": "server/api/whatsappAccount/index.js",
34737 "groupTitle": "Whatsapp_Accounts"
34741 "url": "/api/whatsapp/accounts/describe",
34742 "title": "Gets table info about Accounts",
34745 "title": "Example usage:",
34746 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34750 "name": "DescribeAccounts",
34751 "group": "Whatsapp_Accounts",
34752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34753 "version": "0.0.0",
34754 "filename": "server/api/whatsappAccount/index.js",
34755 "groupTitle": "Whatsapp_Accounts"
34759 "url": "/api/whatsapp/accounts",
34760 "title": "Gets a list of Accounts",
34763 "title": "Example usage:",
34764 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34768 "name": "GetAccounts",
34769 "group": "Whatsapp_Accounts",
34770 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34771 "version": "0.0.0",
34772 "filename": "server/api/whatsappAccount/index.js",
34773 "groupTitle": "Whatsapp_Accounts"
34777 "url": "/api/whatsapp/accounts/{id}/users",
34778 "title": "Gets agents from whatsapp account",
34781 "title": "Example usage:",
34782 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34786 "name": "GetAgents",
34787 "group": "Whatsapp_Accounts",
34788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34789 "version": "0.0.0",
34790 "filename": "server/api/whatsappAccount/index.js",
34791 "groupTitle": "Whatsapp_Accounts"
34795 "url": "/api/whatsapp/accounts/{id}/users",
34796 "title": "Removes agents from a whatsapp account",
34799 "title": "Example usage:",
34800 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34804 "name": "RemoveAgents",
34805 "group": "Whatsapp_Accounts",
34806 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34807 "version": "0.0.0",
34808 "filename": "server/api/whatsappAccount/index.js",
34809 "groupTitle": "Whatsapp_Accounts"
34813 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34814 "title": "Removes canned answers from account",
34817 "title": "Example usage:",
34818 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34822 "name": "RemoveAnswers",
34823 "group": "Whatsapp_Accounts",
34824 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34825 "version": "0.0.0",
34826 "filename": "server/api/whatsappAccount/index.js",
34827 "groupTitle": "Whatsapp_Accounts"
34831 "url": "/api/whatsapp/accounts/{id}/dispositions",
34832 "title": "Removes dispositions from account",
34835 "title": "Example usage:",
34836 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34840 "name": "RemoveDispositions",
34841 "group": "Whatsapp_Accounts",
34842 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34843 "version": "0.0.0",
34844 "filename": "server/api/whatsappAccount/index.js",
34845 "groupTitle": "Whatsapp_Accounts"
34849 "url": "/api/whatsapp/accounts/{id}",
34850 "title": "Gets a single Account",
34853 "title": "Example usage:",
34854 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34858 "name": "ShowAccounts",
34859 "group": "Whatsapp_Accounts",
34860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34861 "version": "0.0.0",
34862 "filename": "server/api/whatsappAccount/index.js",
34863 "groupTitle": "Whatsapp_Accounts"
34867 "url": "/api/whatsapp/messages/{id}/accept",
34868 "title": "Accepts message",
34871 "title": "Example usage:",
34872 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34876 "name": "acceptMessage",
34877 "group": "Whatsapp_Accounts",
34878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34879 "version": "0.0.0",
34880 "filename": "server/api/whatsappMessage/index.js",
34881 "groupTitle": "Whatsapp_Accounts"
34885 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34886 "title": "Creates new canned answer",
34889 "title": "Example usage:",
34890 "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",
34894 "name": "addAnswer",
34895 "group": "Whatsapp_Accounts",
34917 "field": "description",
34930 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34931 "version": "0.0.0",
34932 "filename": "server/api/whatsappAccount/index.js",
34933 "groupTitle": "Whatsapp_Accounts"
34937 "url": "/api/whatsapp/accounts/{id}/applications",
34938 "title": "Creates new applications",
34941 "title": "Example usage:",
34942 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34946 "name": "addApplications",
34947 "group": "Whatsapp_Accounts",
34955 "field": "priority",
34969 "field": "appdata",
34976 "field": "description",
34983 "field": "interval",
34989 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34990 "version": "0.0.0",
34991 "filename": "server/api/whatsappAccount/index.js",
34992 "groupTitle": "Whatsapp_Accounts"
34996 "url": "/api/whatsapp/accounts/{id}/dispositions",
34997 "title": "Creates new disposition",
35000 "title": "Example usage:",
35001 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35005 "name": "addDisposition",
35006 "group": "Whatsapp_Accounts",
35033 "field": "description",
35039 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35040 "version": "0.0.0",
35041 "filename": "server/api/whatsappAccount/index.js",
35042 "groupTitle": "Whatsapp_Accounts"
35046 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35047 "title": "Gets account canned answers",
35050 "title": "Example usage:",
35051 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35055 "name": "getAnswers",
35056 "group": "Whatsapp_Accounts",
35057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35058 "version": "0.0.0",
35059 "filename": "server/api/whatsappAccount/index.js",
35060 "groupTitle": "Whatsapp_Accounts"
35064 "url": "/api/whatsapp/accounts/{id}/applications",
35065 "title": "Gets account applications",
35068 "title": "Example usage:",
35069 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35073 "name": "getApplications",
35074 "group": "Whatsapp_Accounts",
35075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35076 "version": "0.0.0",
35077 "filename": "server/api/whatsappAccount/index.js",
35078 "groupTitle": "Whatsapp_Accounts"
35082 "url": "/api/whatsapp/accounts/{id}/dispositions",
35083 "title": "Gets account dispositions",
35086 "title": "Example usage:",
35087 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35091 "name": "getDispositions",
35092 "group": "Whatsapp_Accounts",
35093 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35094 "version": "0.0.0",
35095 "filename": "server/api/whatsappAccount/index.js",
35096 "groupTitle": "Whatsapp_Accounts"
35100 "url": "/api/whatsapp/accounts/{id}/notify",
35101 "title": "Notify new message",
35104 "title": "Example usage:",
35105 "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",
35110 "group": "Whatsapp_Accounts",
35111 "description": "<p>Motion 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>",
35112 "version": "0.0.0",
35113 "filename": "server/api/whatsappAccount/index.js",
35114 "groupTitle": "Whatsapp_Accounts"
35118 "url": "/api/whatsapp/messages/{id}/reject",
35119 "title": "Rejects message",
35122 "title": "Example usage:",
35123 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35127 "name": "rejectMessage",
35128 "group": "Whatsapp_Accounts",
35129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35130 "version": "0.0.0",
35131 "filename": "server/api/whatsappMessage/index.js",
35132 "groupTitle": "Whatsapp_Accounts"
35136 "url": "/api/whatsapp/accounts/{id}/send",
35137 "title": "Send new whatsapp message",
35140 "title": "Example usage:",
35141 "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",
35145 "name": "sendWhatsapp",
35146 "group": "Whatsapp_Accounts",
35147 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35148 "version": "0.0.0",
35149 "filename": "server/api/whatsappAccount/index.js",
35150 "groupTitle": "Whatsapp_Accounts"
35154 "url": "/api/whatsapp/messages/{id}/status",
35155 "title": "Receive message status",
35158 "title": "Example usage:",
35159 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35163 "name": "statusMessage",
35164 "group": "Whatsapp_Accounts",
35165 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35166 "version": "0.0.0",
35167 "filename": "server/api/whatsappMessage/index.js",
35168 "groupTitle": "Whatsapp_Accounts"
35172 "url": "/api/whatsapp/accounts/{id}",
35173 "title": "Update an existing Account",
35176 "title": "Example usage:",
35177 "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",
35181 "name": "updateAccounts",
35182 "group": "Whatsapp_Accounts",
35183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35184 "version": "0.0.0",
35185 "filename": "server/api/whatsappAccount/index.js",
35186 "groupTitle": "Whatsapp_Accounts"
35190 "url": "/api/whatsapp/applications",
35191 "title": "Creates a new Application",
35194 "title": "Example usage:",
35195 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35199 "name": "CreateApplications",
35200 "group": "Whatsapp_Applications",
35208 "field": "priority",
35222 "field": "appdata",
35229 "field": "description",
35236 "field": "interval",
35242 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35243 "version": "0.0.0",
35244 "filename": "server/api/whatsappApplication/index.js",
35245 "groupTitle": "Whatsapp_Applications"
35249 "url": "/api/whatsapp/applications/{id}",
35250 "title": "Deletes a Application",
35253 "title": "Example usage:",
35254 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35258 "name": "DeleteApplications",
35259 "group": "Whatsapp_Applications",
35260 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35261 "version": "0.0.0",
35262 "filename": "server/api/whatsappApplication/index.js",
35263 "groupTitle": "Whatsapp_Applications"
35267 "url": "/api/whatsapp/applications",
35268 "title": "Gets a list of Applications",
35271 "title": "Example usage:",
35272 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35276 "name": "GetApplications",
35277 "group": "Whatsapp_Applications",
35278 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35279 "version": "0.0.0",
35280 "filename": "server/api/whatsappApplication/index.js",
35281 "groupTitle": "Whatsapp_Applications"
35285 "url": "/api/whatsapp/applications/{id}",
35286 "title": "Gets a single Application",
35289 "title": "Example usage:",
35290 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35294 "name": "ShowApplications",
35295 "group": "Whatsapp_Applications",
35296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35297 "version": "0.0.0",
35298 "filename": "server/api/whatsappApplication/index.js",
35299 "groupTitle": "Whatsapp_Applications"
35303 "url": "/api/whatsapp/applications/{id}",
35304 "title": "Update an existing Application",
35307 "title": "Example usage:",
35308 "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",
35312 "name": "updateApplications",
35313 "group": "Whatsapp_Applications",
35314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35315 "version": "0.0.0",
35316 "filename": "server/api/whatsappApplication/index.js",
35317 "groupTitle": "Whatsapp_Applications"
35321 "url": "/api/whatsapp/interactions/{id}/tags",
35322 "title": "Add tags to the interaction",
35325 "title": "Example usage:",
35326 "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",
35331 "group": "Whatsapp_Interactions",
35332 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35333 "version": "0.0.0",
35334 "filename": "server/api/whatsappInteraction/index.js",
35335 "groupTitle": "Whatsapp_Interactions"
35339 "url": "/api/whatsapp/interactions",
35340 "title": "Creates a new Interaction",
35343 "title": "Example usage:",
35344 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35348 "name": "CreateInteractions",
35349 "group": "Whatsapp_Interactions",
35364 "field": "closedAt",
35371 "field": "disposition",
35378 "field": "secondDisposition",
35385 "field": "thirdDisposition",
35406 "field": "read1stAt",
35417 "field": "firstMsgDirection",
35424 "field": "lastMsgAt",
35435 "field": "lastMsgDirection",
35442 "field": "autoreplyExecuted",
35448 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35449 "version": "0.0.0",
35450 "filename": "server/api/whatsappInteraction/index.js",
35451 "groupTitle": "Whatsapp_Interactions"
35455 "url": "/api/whatsapp/interactions/{id}",
35456 "title": "Deletes a Interaction",
35459 "title": "Example usage:",
35460 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35464 "name": "DeleteInteractions",
35465 "group": "Whatsapp_Interactions",
35466 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35467 "version": "0.0.0",
35468 "filename": "server/api/whatsappInteraction/index.js",
35469 "groupTitle": "Whatsapp_Interactions"
35473 "url": "/api/whatsapp/interactions/describe",
35474 "title": "Gets table info about Interactions",
35477 "title": "Example usage:",
35478 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35482 "name": "DescribeInteractions",
35483 "group": "Whatsapp_Interactions",
35484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35485 "version": "0.0.0",
35486 "filename": "server/api/whatsappInteraction/index.js",
35487 "groupTitle": "Whatsapp_Interactions"
35491 "url": "/api/whatsapp/interactions",
35492 "title": "Gets a list of Interactions",
35495 "title": "Example usage:",
35496 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35500 "name": "GetInteractions",
35501 "group": "Whatsapp_Interactions",
35502 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35503 "version": "0.0.0",
35504 "filename": "server/api/whatsappInteraction/index.js",
35505 "groupTitle": "Whatsapp_Interactions"
35509 "url": "/api/whatsapp/interactions/{id}/tags",
35510 "title": "Removes tags from interaction",
35513 "title": "Example usage:",
35514 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35518 "name": "RemoveTags",
35519 "group": "Whatsapp_Interactions",
35520 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35521 "version": "0.0.0",
35522 "filename": "server/api/whatsappInteraction/index.js",
35523 "groupTitle": "Whatsapp_Interactions"
35527 "url": "/api/whatsapp/interactions/{id}",
35528 "title": "Gets a single Interaction",
35531 "title": "Example usage:",
35532 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35536 "name": "ShowInteractions",
35537 "group": "Whatsapp_Interactions",
35538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35539 "version": "0.0.0",
35540 "filename": "server/api/whatsappInteraction/index.js",
35541 "groupTitle": "Whatsapp_Interactions"
35545 "url": "/api/whatsapp/interactions/{id}/messages",
35546 "title": "Creates new messages",
35549 "title": "Example usage:",
35550 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35554 "name": "addMessage",
35555 "group": "Whatsapp_Interactions",
35581 "field": "direction",
35588 "field": "messageId",
35616 "field": "providerName",
35623 "field": "providerResponse",
35629 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35630 "version": "0.0.0",
35631 "filename": "server/api/whatsappInteraction/index.js",
35632 "groupTitle": "Whatsapp_Interactions"
35636 "url": "/api/whatsapp/interactions/{id}/download",
35637 "title": "Gets interaction",
35640 "title": "Example usage:",
35641 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35645 "name": "download",
35646 "group": "Whatsapp_Interactions",
35647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35648 "version": "0.0.0",
35649 "filename": "server/api/whatsappInteraction/index.js",
35650 "groupTitle": "Whatsapp_Interactions"
35654 "url": "/api/whatsapp/interactions/{id}/messages",
35655 "title": "Gets interaction messages",
35658 "title": "Example usage:",
35659 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35663 "name": "getMessages",
35664 "group": "Whatsapp_Interactions",
35665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35666 "version": "0.0.0",
35667 "filename": "server/api/whatsappInteraction/index.js",
35668 "groupTitle": "Whatsapp_Interactions"
35672 "url": "/api/whatsapp/interactions/{id}",
35673 "title": "Update an existing Interaction",
35676 "title": "Example usage:",
35677 "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",
35681 "name": "updateInteractions",
35682 "group": "Whatsapp_Interactions",
35683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35684 "version": "0.0.0",
35685 "filename": "server/api/whatsappInteraction/index.js",
35686 "groupTitle": "Whatsapp_Interactions"
35690 "url": "/api/whatsapp/messages",
35691 "title": "Creates a new Message",
35694 "title": "Example usage:",
35695 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35699 "name": "CreateMessages",
35700 "group": "Whatsapp_Messages",
35726 "field": "direction",
35733 "field": "messageId",
35761 "field": "providerName",
35768 "field": "providerResponse",
35774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35775 "version": "0.0.0",
35776 "filename": "server/api/whatsappMessage/index.js",
35777 "groupTitle": "Whatsapp_Messages"
35781 "url": "/api/whatsapp/messages/{id}",
35782 "title": "Deletes a Message",
35785 "title": "Example usage:",
35786 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35790 "name": "DeleteMessages",
35791 "group": "Whatsapp_Messages",
35792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35793 "version": "0.0.0",
35794 "filename": "server/api/whatsappMessage/index.js",
35795 "groupTitle": "Whatsapp_Messages"
35799 "url": "/api/whatsapp/messages/describe",
35800 "title": "Gets table info about Messages",
35803 "title": "Example usage:",
35804 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35808 "name": "DescribeMessages",
35809 "group": "Whatsapp_Messages",
35810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35811 "version": "0.0.0",
35812 "filename": "server/api/whatsappMessage/index.js",
35813 "groupTitle": "Whatsapp_Messages"
35817 "url": "/api/whatsapp/messages",
35818 "title": "Gets a list of Messages",
35821 "title": "Example usage:",
35822 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35826 "name": "GetMessages",
35827 "group": "Whatsapp_Messages",
35828 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35829 "version": "0.0.0",
35830 "filename": "server/api/whatsappMessage/index.js",
35831 "groupTitle": "Whatsapp_Messages"
35835 "url": "/api/whatsapp/messages/{id}",
35836 "title": "Gets a single Message",
35839 "title": "Example usage:",
35840 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35844 "name": "ShowMessages",
35845 "group": "Whatsapp_Messages",
35846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35847 "version": "0.0.0",
35848 "filename": "server/api/whatsappMessage/index.js",
35849 "groupTitle": "Whatsapp_Messages"
35853 "url": "/api/whatsapp/messages/{id}",
35854 "title": "Update an existing Message",
35857 "title": "Example usage:",
35858 "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",
35862 "name": "updateMessages",
35863 "group": "Whatsapp_Messages",
35864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35865 "version": "0.0.0",
35866 "filename": "server/api/whatsappMessage/index.js",
35867 "groupTitle": "Whatsapp_Messages"
35871 "url": "/api/whatsapp/reports/queue",
35872 "title": "Creates a new Whatsapp Queue Report",
35875 "title": "Example usage:",
35876 "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",
35880 "name": "CreateWhatsapp_Queue_Reports",
35881 "group": "Whatsapp_Queue_Reports",
35889 "field": "uniqueid",
35910 "field": "leaveAt",
35917 "field": "acceptAt",
35937 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35938 "version": "0.0.0",
35939 "filename": "server/api/whatsappQueueReport/index.js",
35940 "groupTitle": "Whatsapp_Queue_Reports"
35944 "url": "/api/whatsapp/reports/queue/{id}",
35945 "title": "Deletes a Whatsapp Queue Report",
35948 "title": "Example usage:",
35949 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35953 "name": "DeleteWhatsapp_Queue_Reports",
35954 "group": "Whatsapp_Queue_Reports",
35955 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35956 "version": "0.0.0",
35957 "filename": "server/api/whatsappQueueReport/index.js",
35958 "groupTitle": "Whatsapp_Queue_Reports"
35962 "url": "/api/whatsapp/reports/queue/describe",
35963 "title": "Gets table info about Whatsapp Queue Reports",
35966 "title": "Example usage:",
35967 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35971 "name": "DescribeWhatsapp_Queue_Reports",
35972 "group": "Whatsapp_Queue_Reports",
35973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35974 "version": "0.0.0",
35975 "filename": "server/api/whatsappQueueReport/index.js",
35976 "groupTitle": "Whatsapp_Queue_Reports"
35980 "url": "/api/whatsapp/reports/queue",
35981 "title": "Gets a list of Whatsapp Queue Reports",
35984 "title": "Example usage:",
35985 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35989 "name": "GetWhatsapp_Queue_Reports",
35990 "group": "Whatsapp_Queue_Reports",
35991 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35992 "version": "0.0.0",
35993 "filename": "server/api/whatsappQueueReport/index.js",
35994 "groupTitle": "Whatsapp_Queue_Reports"
35998 "url": "/api/whatsapp/reports/queue/{id}",
35999 "title": "Gets a single Whatsapp Queue Report",
36002 "title": "Example usage:",
36003 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36007 "name": "ShowWhatsapp_Queue_Reports",
36008 "group": "Whatsapp_Queue_Reports",
36009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36010 "version": "0.0.0",
36011 "filename": "server/api/whatsappQueueReport/index.js",
36012 "groupTitle": "Whatsapp_Queue_Reports"
36016 "url": "/api/whatsapp/reports/queue/{id}",
36017 "title": "Update an existing Whatsapp Queue Report",
36020 "title": "Example usage:",
36021 "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",
36025 "name": "updateWhatsapp_Queue_Reports",
36026 "group": "Whatsapp_Queue_Reports",
36027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36028 "version": "0.0.0",
36029 "filename": "server/api/whatsappQueueReport/index.js",
36030 "groupTitle": "Whatsapp_Queue_Reports"
36034 "url": "/api/whatsapp/queues/{id}/users",
36035 "title": "Add agents to a queue",
36038 "title": "Example usage:",
36039 "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",
36043 "name": "AddAgents",
36044 "group": "Whatsapp_Queues",
36045 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36046 "version": "0.0.0",
36047 "filename": "server/api/whatsappQueue/index.js",
36048 "groupTitle": "Whatsapp_Queues"
36052 "url": "/api/whatsapp/queues/{id}/teams",
36053 "title": "Add teams to a queue",
36056 "title": "Example usage:",
36057 "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",
36061 "name": "AddTeams",
36062 "group": "Whatsapp_Queues",
36063 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36064 "version": "0.0.0",
36065 "filename": "server/api/whatsappQueue/index.js",
36066 "groupTitle": "Whatsapp_Queues"
36070 "url": "/api/whatsapp/queues",
36071 "title": "Creates a new Queue",
36074 "title": "Example usage:",
36075 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36079 "name": "CreateQueues",
36080 "group": "Whatsapp_Queues",
36095 "field": "timeout",
36107 "field": "strategy",
36114 "field": "description",
36120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36121 "version": "0.0.0",
36122 "filename": "server/api/whatsappQueue/index.js",
36123 "groupTitle": "Whatsapp_Queues"
36127 "url": "/api/whatsapp/queues/{id}",
36128 "title": "Deletes a Queue",
36131 "title": "Example usage:",
36132 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36136 "name": "DeleteQueues",
36137 "group": "Whatsapp_Queues",
36138 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36139 "version": "0.0.0",
36140 "filename": "server/api/whatsappQueue/index.js",
36141 "groupTitle": "Whatsapp_Queues"
36145 "url": "/api/whatsapp/queues/describe",
36146 "title": "Gets table info about Queues",
36149 "title": "Example usage:",
36150 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36154 "name": "DescribeQueues",
36155 "group": "Whatsapp_Queues",
36156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36157 "version": "0.0.0",
36158 "filename": "server/api/whatsappQueue/index.js",
36159 "groupTitle": "Whatsapp_Queues"
36163 "url": "/api/whatsapp/queues/{id}/users",
36164 "title": "Gets queue agents",
36167 "title": "Example usage:",
36168 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36172 "name": "GetAgents",
36173 "group": "Whatsapp_Queues",
36174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36175 "version": "0.0.0",
36176 "filename": "server/api/whatsappQueue/index.js",
36177 "groupTitle": "Whatsapp_Queues"
36181 "url": "/api/whatsapp/queues/{id}/members",
36182 "title": "GetMembers",
36185 "title": "Example usage:",
36186 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36190 "name": "GetMembers",
36191 "group": "Whatsapp_Queues",
36192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36193 "version": "0.0.0",
36194 "filename": "server/api/whatsappQueue/index.js",
36195 "groupTitle": "Whatsapp_Queues"
36199 "url": "/api/whatsapp/queues",
36200 "title": "Gets a list of Queues",
36203 "title": "Example usage:",
36204 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36208 "name": "GetQueues",
36209 "group": "Whatsapp_Queues",
36210 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36211 "version": "0.0.0",
36212 "filename": "server/api/whatsappQueue/index.js",
36213 "groupTitle": "Whatsapp_Queues"
36217 "url": "/api/whatsapp/queues/{id}/teams",
36218 "title": "Gets queues list",
36221 "title": "Example usage:",
36222 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36226 "name": "GetTeams",
36227 "group": "Whatsapp_Queues",
36228 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36229 "version": "0.0.0",
36230 "filename": "server/api/whatsappQueue/index.js",
36231 "groupTitle": "Whatsapp_Queues"
36235 "url": "/api/whatsapp/queues/{id}/users",
36236 "title": "Removes agents from a queue",
36239 "title": "Example usage:",
36240 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36244 "name": "RemoveAgents",
36245 "group": "Whatsapp_Queues",
36246 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36247 "version": "0.0.0",
36248 "filename": "server/api/whatsappQueue/index.js",
36249 "groupTitle": "Whatsapp_Queues"
36253 "url": "/api/whatsapp/queues/{id}",
36254 "title": "Gets a single Queue",
36257 "title": "Example usage:",
36258 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36262 "name": "ShowQueues",
36263 "group": "Whatsapp_Queues",
36264 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36265 "version": "0.0.0",
36266 "filename": "server/api/whatsappQueue/index.js",
36267 "groupTitle": "Whatsapp_Queues"
36271 "url": "/api/whatsapp/queues/{id}",
36272 "title": "Update an existing Queue",
36275 "title": "Example usage:",
36276 "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",
36280 "name": "updateQueues",
36281 "group": "Whatsapp_Queues",
36282 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36283 "version": "0.0.0",
36284 "filename": "server/api/whatsappQueue/index.js",
36285 "groupTitle": "Whatsapp_Queues"
36289 "url": "/api/whatsapp/reports/transfer",
36290 "title": "Creates a new Whatsapp Transfer Report",
36293 "title": "Example usage:",
36294 "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",
36298 "name": "CreateWhatsapp_Transfer_Reports",
36299 "group": "Whatsapp_Transfer_Reports",
36307 "field": "uniqueid",
36326 "field": "transferredAt",
36332 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36333 "version": "0.0.0",
36334 "filename": "server/api/whatsappTransferReport/index.js",
36335 "groupTitle": "Whatsapp_Transfer_Reports"
36339 "url": "/api/whatsapp/reports/transfer/{id}",
36340 "title": "Deletes a Whatsapp Transfer Report",
36343 "title": "Example usage:",
36344 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36348 "name": "DeleteWhatsapp_Transfer_Reports",
36349 "group": "Whatsapp_Transfer_Reports",
36350 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36351 "version": "0.0.0",
36352 "filename": "server/api/whatsappTransferReport/index.js",
36353 "groupTitle": "Whatsapp_Transfer_Reports"
36357 "url": "/api/whatsapp/reports/transfer/describe",
36358 "title": "Gets table info about Whatsapp Transfer Reports",
36361 "title": "Example usage:",
36362 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36366 "name": "DescribeWhatsapp_Transfer_Reports",
36367 "group": "Whatsapp_Transfer_Reports",
36368 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36369 "version": "0.0.0",
36370 "filename": "server/api/whatsappTransferReport/index.js",
36371 "groupTitle": "Whatsapp_Transfer_Reports"
36375 "url": "/api/whatsapp/reports/transfer",
36376 "title": "Gets a list of Whatsapp Transfer Reports",
36379 "title": "Example usage:",
36380 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36384 "name": "GetWhatsapp_Transfer_Reports",
36385 "group": "Whatsapp_Transfer_Reports",
36386 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36387 "version": "0.0.0",
36388 "filename": "server/api/whatsappTransferReport/index.js",
36389 "groupTitle": "Whatsapp_Transfer_Reports"
36393 "url": "/api/whatsapp/reports/transfer/{id}",
36394 "title": "Gets a single Whatsapp Transfer Report",
36397 "title": "Example usage:",
36398 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36402 "name": "ShowWhatsapp_Transfer_Reports",
36403 "group": "Whatsapp_Transfer_Reports",
36404 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36405 "version": "0.0.0",
36406 "filename": "server/api/whatsappTransferReport/index.js",
36407 "groupTitle": "Whatsapp_Transfer_Reports"
36411 "url": "/api/whatsapp/reports/transfer/{id}",
36412 "title": "Update an existing Whatsapp Transfer Report",
36415 "title": "Example usage:",
36416 "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",
36420 "name": "updateWhatsapp_Transfer_Reports",
36421 "group": "Whatsapp_Transfer_Reports",
36422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36423 "version": "0.0.0",
36424 "filename": "server/api/whatsappTransferReport/index.js",
36425 "groupTitle": "Whatsapp_Transfer_Reports"
36429 "url": "/api/integrations/zendesk/accounts",
36430 "title": "Creates a new Zendesk Account",
36433 "title": "Example usage:",
36434 "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",
36438 "name": "CreateZendesk_Accounts",
36439 "group": "Zendesk_Accounts",
36454 "field": "description",
36461 "field": "username",
36468 "field": "password",
36482 "field": "remoteUri",
36493 "field": "authType",
36500 "field": "serverUrl",
36507 "\"integrationTab\"",
36517 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36518 "version": "0.0.0",
36519 "filename": "server/api/intZendeskAccount/index.js",
36520 "groupTitle": "Zendesk_Accounts"
36524 "url": "/api/integrations/zendesk/accounts/{id}",
36525 "title": "Deletes a Zendesk Account",
36528 "title": "Example usage:",
36529 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36533 "name": "DeleteZendesk_Accounts",
36534 "group": "Zendesk_Accounts",
36535 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36536 "version": "0.0.0",
36537 "filename": "server/api/intZendeskAccount/index.js",
36538 "groupTitle": "Zendesk_Accounts"
36542 "url": "/api/integrations/zendesk/accounts",
36543 "title": "Gets a list of Zendesk Accounts",
36546 "title": "Example usage:",
36547 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36551 "name": "GetZendesk_Accounts",
36552 "group": "Zendesk_Accounts",
36553 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36554 "version": "0.0.0",
36555 "filename": "server/api/intZendeskAccount/index.js",
36556 "groupTitle": "Zendesk_Accounts"
36560 "url": "/api/integrations/zendesk/accounts/{id}",
36561 "title": "Gets a single Zendesk Account",
36564 "title": "Example usage:",
36565 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36569 "name": "ShowZendesk_Accounts",
36570 "group": "Zendesk_Accounts",
36571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36572 "version": "0.0.0",
36573 "filename": "server/api/intZendeskAccount/index.js",
36574 "groupTitle": "Zendesk_Accounts"
36578 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36579 "title": "Creates new configuration",
36582 "title": "Example usage:",
36583 "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",
36587 "name": "addConfiguration",
36588 "group": "Zendesk_Accounts",
36589 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36590 "version": "0.0.0",
36591 "filename": "server/api/intZendeskAccount/index.js",
36592 "groupTitle": "Zendesk_Accounts"
36596 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36597 "title": "Gets account configurations",
36600 "title": "Example usage:",
36601 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36605 "name": "getConfigurations",
36606 "group": "Zendesk_Accounts",
36607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36608 "version": "0.0.0",
36609 "filename": "server/api/intZendeskAccount/index.js",
36610 "groupTitle": "Zendesk_Accounts"
36614 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36615 "title": "Gets account fields",
36618 "title": "Example usage:",
36619 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36623 "name": "getFields",
36624 "group": "Zendesk_Accounts",
36625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36626 "version": "0.0.0",
36627 "filename": "server/api/intZendeskAccount/index.js",
36628 "groupTitle": "Zendesk_Accounts"
36632 "url": "/api/integrations/zendesk/accounts/{id}",
36633 "title": "Update an existing Zendesk Account",
36636 "title": "Example usage:",
36637 "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",
36641 "name": "updateZendesk_Accounts",
36642 "group": "Zendesk_Accounts",
36643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36644 "version": "0.0.0",
36645 "filename": "server/api/intZendeskAccount/index.js",
36646 "groupTitle": "Zendesk_Accounts"
36650 "url": "/api/integrations/zendesk/configurations",
36651 "title": "Creates a new Zendesk Configuration",
36654 "title": "Example usage:",
36655 "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",
36659 "name": "CreateZendesk_Configurations",
36660 "group": "Zendesk_Configurations",
36675 "field": "description",
36681 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36682 "version": "0.0.0",
36683 "filename": "server/api/intZendeskConfiguration/index.js",
36684 "groupTitle": "Zendesk_Configurations"
36688 "url": "/api/integrations/zendesk/configurations/{id}",
36689 "title": "Deletes a Zendesk Configuration",
36692 "title": "Example usage:",
36693 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36697 "name": "DeleteZendesk_Configurations",
36698 "group": "Zendesk_Configurations",
36699 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36700 "version": "0.0.0",
36701 "filename": "server/api/intZendeskConfiguration/index.js",
36702 "groupTitle": "Zendesk_Configurations"
36706 "url": "/api/integrations/zendesk/configurations",
36707 "title": "Gets a list of Zendesk Configurations",
36710 "title": "Example usage:",
36711 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36715 "name": "GetZendesk_Configurations",
36716 "group": "Zendesk_Configurations",
36717 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36718 "version": "0.0.0",
36719 "filename": "server/api/intZendeskConfiguration/index.js",
36720 "groupTitle": "Zendesk_Configurations"
36724 "url": "/api/integrations/zendesk/configurations/{id}",
36725 "title": "Gets a single Zendesk Configuration",
36728 "title": "Example usage:",
36729 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36733 "name": "ShowZendesk_Configurations",
36734 "group": "Zendesk_Configurations",
36735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36736 "version": "0.0.0",
36737 "filename": "server/api/intZendeskConfiguration/index.js",
36738 "groupTitle": "Zendesk_Configurations"
36742 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36743 "title": "Gets configurations descriptions",
36746 "title": "Example usage:",
36747 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36751 "name": "getDescriptions",
36752 "group": "Zendesk_Configurations",
36753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36754 "version": "0.0.0",
36755 "filename": "server/api/intZendeskConfiguration/index.js",
36756 "groupTitle": "Zendesk_Configurations"
36760 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36761 "title": "Gets configurations fields",
36764 "title": "Example usage:",
36765 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36769 "name": "getFields",
36770 "group": "Zendesk_Configurations",
36771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intZendeskConfiguration/index.js",
36774 "groupTitle": "Zendesk_Configurations"
36778 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36779 "title": "Gets configurations subjects",
36782 "title": "Example usage:",
36783 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36787 "name": "getSubjects",
36788 "group": "Zendesk_Configurations",
36789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36790 "version": "0.0.0",
36791 "filename": "server/api/intZendeskConfiguration/index.js",
36792 "groupTitle": "Zendesk_Configurations"
36796 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36797 "title": "Gets configurations tags",
36800 "title": "Example usage:",
36801 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36806 "group": "Zendesk_Configurations",
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/intZendeskConfiguration/index.js",
36810 "groupTitle": "Zendesk_Configurations"
36814 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36815 "title": "Sets new tags",
36818 "title": "Example usage:",
36819 "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",
36824 "group": "Zendesk_Configurations",
36825 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36826 "version": "0.0.0",
36827 "filename": "server/api/intZendeskConfiguration/index.js",
36828 "groupTitle": "Zendesk_Configurations"
36832 "url": "/api/integrations/zendesk/configurations/{id}",
36833 "title": "Update an existing Zendesk Configuration",
36836 "title": "Example usage:",
36837 "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",
36841 "name": "updateZendesk_Configurations",
36842 "group": "Zendesk_Configurations",
36843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36844 "version": "0.0.0",
36845 "filename": "server/api/intZendeskConfiguration/index.js",
36846 "groupTitle": "Zendesk_Configurations"
36850 "url": "/api/integrations/zendesk/fields",
36851 "title": "Creates a new Zendesk Field",
36854 "title": "Example usage:",
36855 "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",
36859 "name": "CreateZendesk_Fields",
36860 "group": "Zendesk_Fields",
36870 "\"customVariable\"",
36882 "field": "content",
36898 "\"customVariable\""
36901 "field": "keyType",
36908 "field": "keyContent",
36915 "field": "idField",
36922 "field": "nameField",
36929 "field": "customField",
36936 "field": "variableName",
36942 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36943 "version": "0.0.0",
36944 "filename": "server/api/intZendeskField/index.js",
36945 "groupTitle": "Zendesk_Fields"
36949 "url": "/api/integrations/zendesk/fields/{id}",
36950 "title": "Deletes a Zendesk Field",
36953 "title": "Example usage:",
36954 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36958 "name": "DeleteZendesk_Fields",
36959 "group": "Zendesk_Fields",
36960 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36961 "version": "0.0.0",
36962 "filename": "server/api/intZendeskField/index.js",
36963 "groupTitle": "Zendesk_Fields"
36967 "url": "/api/integrations/zendesk/fields",
36968 "title": "Gets a list of Zendesk Fields",
36971 "title": "Example usage:",
36972 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36976 "name": "GetZendesk_Fields",
36977 "group": "Zendesk_Fields",
36978 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36979 "version": "0.0.0",
36980 "filename": "server/api/intZendeskField/index.js",
36981 "groupTitle": "Zendesk_Fields"
36985 "url": "/api/integrations/zendesk/fields/{id}",
36986 "title": "Gets a single Zendesk Field",
36989 "title": "Example usage:",
36990 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36994 "name": "ShowZendesk_Fields",
36995 "group": "Zendesk_Fields",
36996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36997 "version": "0.0.0",
36998 "filename": "server/api/intZendeskField/index.js",
36999 "groupTitle": "Zendesk_Fields"
37003 "url": "/api/integrations/zendesk/fields/{id}",
37004 "title": "Update an existing Zendesk Field",
37007 "title": "Example usage:",
37008 "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",
37012 "name": "updateZendesk_Fields",
37013 "group": "Zendesk_Fields",
37014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37015 "version": "0.0.0",
37016 "filename": "server/api/intZendeskField/index.js",
37017 "groupTitle": "Zendesk_Fields"
37021 "url": "/api/integrations/zoho/accounts",
37022 "title": "Creates a new Zoho Account",
37025 "title": "Example usage:",
37026 "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",
37030 "name": "CreateZoho_Accounts",
37031 "group": "Zoho_Accounts",
37046 "field": "description",
37067 "field": "clientId",
37074 "field": "clientSecret",
37081 "field": "serverUrl",
37095 "field": "refreshToken",
37101 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37102 "version": "0.0.0",
37103 "filename": "server/api/intZohoAccount/index.js",
37104 "groupTitle": "Zoho_Accounts"
37108 "url": "/api/integrations/zoho/accounts/{id}",
37109 "title": "Deletes a Zoho Account",
37112 "title": "Example usage:",
37113 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37117 "name": "DeleteZoho_Accounts",
37118 "group": "Zoho_Accounts",
37119 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37120 "version": "0.0.0",
37121 "filename": "server/api/intZohoAccount/index.js",
37122 "groupTitle": "Zoho_Accounts"
37126 "url": "/api/integrations/zoho/accounts",
37127 "title": "Gets a list of Zoho Accounts",
37130 "title": "Example usage:",
37131 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37135 "name": "GetZoho_Accounts",
37136 "group": "Zoho_Accounts",
37137 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37138 "version": "0.0.0",
37139 "filename": "server/api/intZohoAccount/index.js",
37140 "groupTitle": "Zoho_Accounts"
37144 "url": "/api/integrations/zoho/accounts/{id}",
37145 "title": "Gets a single Zoho Account",
37148 "title": "Example usage:",
37149 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37153 "name": "ShowZoho_Accounts",
37154 "group": "Zoho_Accounts",
37155 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37156 "version": "0.0.0",
37157 "filename": "server/api/intZohoAccount/index.js",
37158 "groupTitle": "Zoho_Accounts"
37162 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37163 "title": "Creates new configuration",
37166 "title": "Example usage:",
37167 "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",
37171 "name": "addConfiguration",
37172 "group": "Zoho_Accounts",
37173 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37174 "version": "0.0.0",
37175 "filename": "server/api/intZohoAccount/index.js",
37176 "groupTitle": "Zoho_Accounts"
37180 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37181 "title": "Gets account configurations",
37184 "title": "Example usage:",
37185 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37189 "name": "getConfigurations",
37190 "group": "Zoho_Accounts",
37191 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37192 "version": "0.0.0",
37193 "filename": "server/api/intZohoAccount/index.js",
37194 "groupTitle": "Zoho_Accounts"
37198 "url": "/api/integrations/zoho/accounts/{id}/fields",
37199 "title": "Gets account fields",
37202 "title": "Example usage:",
37203 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37207 "name": "getFields",
37208 "group": "Zoho_Accounts",
37209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37210 "version": "0.0.0",
37211 "filename": "server/api/intZohoAccount/index.js",
37212 "groupTitle": "Zoho_Accounts"
37216 "url": "/api/integrations/zoho/accounts/{id}",
37217 "title": "Update an existing Zoho Account",
37220 "title": "Example usage:",
37221 "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",
37225 "name": "updateZoho_Accounts",
37226 "group": "Zoho_Accounts",
37227 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37228 "version": "0.0.0",
37229 "filename": "server/api/intZohoAccount/index.js",
37230 "groupTitle": "Zoho_Accounts"
37234 "url": "/api/integrations/zoho/configurations",
37235 "title": "Creates a new Zoho Configuration",
37238 "title": "Example usage:",
37239 "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",
37243 "name": "CreateZoho_Configurations",
37244 "group": "Zoho_Configurations",
37264 "field": "moduleCreate",
37271 "\"contact_lead\"",
37276 "field": "moduleSearch",
37283 "field": "description",
37289 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37290 "version": "0.0.0",
37291 "filename": "server/api/intZohoConfiguration/index.js",
37292 "groupTitle": "Zoho_Configurations"
37296 "url": "/api/integrations/zoho/configurations/{id}",
37297 "title": "Deletes a Zoho Configuration",
37300 "title": "Example usage:",
37301 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37305 "name": "DeleteZoho_Configurations",
37306 "group": "Zoho_Configurations",
37307 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37308 "version": "0.0.0",
37309 "filename": "server/api/intZohoConfiguration/index.js",
37310 "groupTitle": "Zoho_Configurations"
37314 "url": "/api/integrations/zoho/configurations",
37315 "title": "Gets a list of Zoho Configurations",
37318 "title": "Example usage:",
37319 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37323 "name": "GetZoho_Configurations",
37324 "group": "Zoho_Configurations",
37325 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37326 "version": "0.0.0",
37327 "filename": "server/api/intZohoConfiguration/index.js",
37328 "groupTitle": "Zoho_Configurations"
37332 "url": "/api/integrations/zoho/configurations/{id}",
37333 "title": "Gets a single Zoho Configuration",
37336 "title": "Example usage:",
37337 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37341 "name": "ShowZoho_Configurations",
37342 "group": "Zoho_Configurations",
37343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37344 "version": "0.0.0",
37345 "filename": "server/api/intZohoConfiguration/index.js",
37346 "groupTitle": "Zoho_Configurations"
37350 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37351 "title": "Gets configurations descriptions",
37354 "title": "Example usage:",
37355 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37359 "name": "getDescriptions",
37360 "group": "Zoho_Configurations",
37361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37362 "version": "0.0.0",
37363 "filename": "server/api/intZohoConfiguration/index.js",
37364 "groupTitle": "Zoho_Configurations"
37368 "url": "/api/integrations/zoho/configurations/{id}/fields",
37369 "title": "Gets configurations fields",
37372 "title": "Example usage:",
37373 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37377 "name": "getFields",
37378 "group": "Zoho_Configurations",
37379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37380 "version": "0.0.0",
37381 "filename": "server/api/intZohoConfiguration/index.js",
37382 "groupTitle": "Zoho_Configurations"
37386 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37387 "title": "Gets configurations subjects",
37390 "title": "Example usage:",
37391 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37395 "name": "getSubjects",
37396 "group": "Zoho_Configurations",
37397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37398 "version": "0.0.0",
37399 "filename": "server/api/intZohoConfiguration/index.js",
37400 "groupTitle": "Zoho_Configurations"
37404 "url": "/api/integrations/zoho/configurations/{id}",
37405 "title": "Update an existing Zoho Configuration",
37408 "title": "Example usage:",
37409 "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",
37413 "name": "updateZoho_Configurations",
37414 "group": "Zoho_Configurations",
37415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37416 "version": "0.0.0",
37417 "filename": "server/api/intZohoConfiguration/index.js",
37418 "groupTitle": "Zoho_Configurations"
37422 "url": "/api/integrations/zoho/fields",
37423 "title": "Creates a new Zoho Field",
37426 "title": "Example usage:",
37427 "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",
37431 "name": "CreateZoho_Fields",
37432 "group": "Zoho_Fields",
37442 "\"customVariable\"",
37454 "field": "content",
37470 "\"customVariable\""
37473 "field": "keyType",
37480 "field": "keyContent",
37487 "field": "idField",
37494 "field": "nameField",
37501 "field": "customField",
37508 "field": "variableName",
37514 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37515 "version": "0.0.0",
37516 "filename": "server/api/intZohoField/index.js",
37517 "groupTitle": "Zoho_Fields"
37521 "url": "/api/integrations/zoho/fields/{id}",
37522 "title": "Deletes a Zoho Field",
37525 "title": "Example usage:",
37526 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37530 "name": "DeleteZoho_Fields",
37531 "group": "Zoho_Fields",
37532 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37533 "version": "0.0.0",
37534 "filename": "server/api/intZohoField/index.js",
37535 "groupTitle": "Zoho_Fields"
37539 "url": "/api/integrations/zoho/fields",
37540 "title": "Gets a list of Zoho Fields",
37543 "title": "Example usage:",
37544 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37548 "name": "GetZoho_Fields",
37549 "group": "Zoho_Fields",
37550 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37551 "version": "0.0.0",
37552 "filename": "server/api/intZohoField/index.js",
37553 "groupTitle": "Zoho_Fields"
37557 "url": "/api/integrations/zoho/fields/{id}",
37558 "title": "Gets a single Zoho Field",
37561 "title": "Example usage:",
37562 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37566 "name": "ShowZoho_Fields",
37567 "group": "Zoho_Fields",
37568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37569 "version": "0.0.0",
37570 "filename": "server/api/intZohoField/index.js",
37571 "groupTitle": "Zoho_Fields"
37575 "url": "/api/integrations/zoho/fields/{id}",
37576 "title": "Update an existing Zoho Field",
37579 "title": "Example usage:",
37580 "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",
37584 "name": "updateZoho_Fields",
37585 "group": "Zoho_Fields",
37586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37587 "version": "0.0.0",
37588 "filename": "server/api/intZohoField/index.js",
37589 "groupTitle": "Zoho_Fields"
37594 "title": "Creates a new Cdr",
37597 "title": "Example usage:",
37598 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37602 "name": "CreateCdrs",
37611 "field": "calldate",
37639 "field": "dcontext",
37646 "field": "channel",
37653 "field": "dstchannel",
37660 "field": "lastapp",
37667 "field": "lastdata",
37674 "field": "duration",
37681 "field": "billsec",
37688 "field": "disposition",
37695 "field": "amaflags",
37702 "field": "accountcode",
37709 "field": "userfield",
37716 "field": "uniqueid",
37723 "field": "linkedid",
37730 "field": "sequence",
37737 "field": "peeraccount",
37757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37758 "version": "0.0.0",
37759 "filename": "server/api/cdr/index.js",
37760 "groupTitle": "cdr"
37764 "url": "/api/cdr/{id}",
37765 "title": "Deletes a Cdr",
37768 "title": "Example usage:",
37769 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37773 "name": "DeleteCdrs",
37775 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37776 "version": "0.0.0",
37777 "filename": "server/api/cdr/index.js",
37778 "groupTitle": "cdr"
37782 "url": "/api/cdr/describe",
37783 "title": "Gets table info about Cdrs",
37786 "title": "Example usage:",
37787 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37791 "name": "DescribeCdrs",
37793 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37794 "version": "0.0.0",
37795 "filename": "server/api/cdr/index.js",
37796 "groupTitle": "cdr"
37801 "title": "Gets a list of Cdrs",
37804 "title": "Example usage:",
37805 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37811 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37812 "version": "0.0.0",
37813 "filename": "server/api/cdr/index.js",
37814 "groupTitle": "cdr"
37818 "url": "/api/cdr/{id}",
37819 "title": "Gets a single Cdr",
37822 "title": "Example usage:",
37823 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37827 "name": "ShowCdrs",
37829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37830 "version": "0.0.0",
37831 "filename": "server/api/cdr/index.js",
37832 "groupTitle": "cdr"
37836 "url": "/api/cdr/{id}",
37837 "title": "Update an existing Cdr",
37840 "title": "Example usage:",
37841 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37845 "name": "updateCdrs",
37847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37848 "version": "0.0.0",
37849 "filename": "server/api/cdr/index.js",
37850 "groupTitle": "cdr"
37854 "url": "/api/voiceQueuesLog",
37855 "title": "Creates a new VoiceQueuesLog",
37858 "title": "Example usage:",
37859 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37863 "name": "CreateVoiceQueuesLogs",
37864 "group": "voiceQueuesLog",
37886 "field": "queuename",
37955 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37956 "version": "0.0.0",
37957 "filename": "server/api/voiceQueuesLog/index.js",
37958 "groupTitle": "voiceQueuesLog"
37962 "url": "/api/voiceQueuesLog/{id}",
37963 "title": "Deletes a VoiceQueuesLog",
37966 "title": "Example usage:",
37967 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37971 "name": "DeleteVoiceQueuesLogs",
37972 "group": "voiceQueuesLog",
37973 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37974 "version": "0.0.0",
37975 "filename": "server/api/voiceQueuesLog/index.js",
37976 "groupTitle": "voiceQueuesLog"
37980 "url": "/api/voiceQueuesLog",
37981 "title": "Gets a list of VoiceQueuesLogs",
37984 "title": "Example usage:",
37985 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37989 "name": "GetVoiceQueuesLogs",
37990 "group": "voiceQueuesLog",
37991 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37992 "version": "0.0.0",
37993 "filename": "server/api/voiceQueuesLog/index.js",
37994 "groupTitle": "voiceQueuesLog"
37998 "url": "/api/voiceQueuesLog/{id}",
37999 "title": "Gets a single VoiceQueuesLog",
38002 "title": "Example usage:",
38003 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38007 "name": "ShowVoiceQueuesLogs",
38008 "group": "voiceQueuesLog",
38009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38010 "version": "0.0.0",
38011 "filename": "server/api/voiceQueuesLog/index.js",
38012 "groupTitle": "voiceQueuesLog"
38016 "url": "/api/voiceQueuesLog/{id}",
38017 "title": "Update an existing VoiceQueuesLog",
38020 "title": "Example usage:",
38021 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38025 "name": "updateVoiceQueuesLogs",
38026 "group": "voiceQueuesLog",
38027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38028 "version": "0.0.0",
38029 "filename": "server/api/voiceQueuesLog/index.js",
38030 "groupTitle": "voiceQueuesLog"