4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/local",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authLocal/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/google",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authGoogle/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/automations",
1381 "title": "Creates a new Automation",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1389 "name": "CreateAutomations",
1390 "group": "Automations",
1412 "field": "description",
1432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1434 "filename": "server/api/automation/index.js",
1435 "groupTitle": "Automations"
1439 "url": "/api/automations/{id}",
1440 "title": "Deletes a Automation",
1443 "title": "Example usage:",
1444 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1448 "name": "DeleteAutomations",
1449 "group": "Automations",
1450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1452 "filename": "server/api/automation/index.js",
1453 "groupTitle": "Automations"
1457 "url": "/api/automations",
1458 "title": "Gets a list of Automations",
1461 "title": "Example usage:",
1462 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1466 "name": "GetAutomations",
1467 "group": "Automations",
1468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1470 "filename": "server/api/automation/index.js",
1471 "groupTitle": "Automations"
1475 "url": "/api/automations/{id}",
1476 "title": "Gets a single Automation",
1479 "title": "Example usage:",
1480 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1484 "name": "ShowAutomations",
1485 "group": "Automations",
1486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488 "filename": "server/api/automation/index.js",
1489 "groupTitle": "Automations"
1493 "url": "/api/automations/{id}/actions",
1494 "title": "Creates new actions",
1497 "title": "Example usage:",
1498 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1502 "name": "addActions",
1503 "group": "Automations",
1519 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1526 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1533 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1540 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1575 "filename": "server/api/automation/index.js",
1576 "groupTitle": "Automations"
1580 "url": "/api/automations/{id}/conditions",
1581 "title": "Creates new conditions",
1584 "title": "Example usage:",
1585 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1589 "name": "addConditions",
1590 "group": "Automations",
1612 "field": "operator",
1625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1627 "filename": "server/api/automation/index.js",
1628 "groupTitle": "Automations"
1632 "url": "/api/automations/{id}/actions",
1633 "title": "Gets Automation Actions",
1636 "title": "Example usage:",
1637 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1641 "name": "getActions",
1642 "group": "Automations",
1643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1645 "filename": "server/api/automation/index.js",
1646 "groupTitle": "Automations"
1650 "url": "/api/automations/{id}/conditions",
1651 "title": "Gets Automation Conditions",
1654 "title": "Example usage:",
1655 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1659 "name": "getConditions",
1660 "group": "Automations",
1661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1663 "filename": "server/api/automation/index.js",
1664 "groupTitle": "Automations"
1668 "url": "/api/automations/{id}",
1669 "title": "Update an existing Automation",
1672 "title": "Example usage:",
1673 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1677 "name": "updateAutomations",
1678 "group": "Automations",
1679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/canned_answers",
1687 "title": "Create a new canned answer",
1690 "title": "Example usage:",
1691 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1696 "group": "Canned_Answers",
1697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699 "filename": "server/api/cannedAnswer/index.js",
1700 "groupTitle": "Canned_Answers"
1704 "url": "/api/canned_answers/{id}",
1705 "title": "Deletes a Canned Answer",
1708 "title": "Example usage:",
1709 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1713 "name": "DeleteCanned_Answers",
1714 "group": "Canned_Answers",
1715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1717 "filename": "server/api/cannedAnswer/index.js",
1718 "groupTitle": "Canned_Answers"
1722 "url": "/api/canned_answers",
1723 "title": "Gets a list of Canned Answers",
1726 "title": "Example usage:",
1727 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1731 "name": "GetCanned_Answers",
1732 "group": "Canned_Answers",
1733 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1735 "filename": "server/api/cannedAnswer/index.js",
1736 "groupTitle": "Canned_Answers"
1740 "url": "/api/canned_answers/{id}",
1741 "title": "Gets a single Canned Answer",
1744 "title": "Example usage:",
1745 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1749 "name": "ShowCanned_Answers",
1750 "group": "Canned_Answers",
1751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753 "filename": "server/api/cannedAnswer/index.js",
1754 "groupTitle": "Canned_Answers"
1758 "url": "/api/canned_answers/{id}",
1759 "title": "Update an existing Canned Answer",
1762 "title": "Example usage:",
1763 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1767 "name": "updateCanned_Answers",
1768 "group": "Canned_Answers",
1769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771 "filename": "server/api/cannedAnswer/index.js",
1772 "groupTitle": "Canned_Answers"
1776 "url": "/chat/internal/users",
1777 "title": "Gets Users Last Messages",
1780 "title": "Example usage:",
1781 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1785 "name": "getLastUsersMessages",
1786 "group": "ChatInternalMessage",
1787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1789 "filename": "server/api/chatInternalMessage/index.js",
1790 "groupTitle": "ChatInternalMessage"
1794 "url": "/api/chat/applications/{id}",
1795 "title": "Deletes a Application",
1798 "title": "Example usage:",
1799 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1803 "name": "DeleteApplications",
1804 "group": "Chat_Applications",
1805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1807 "filename": "server/api/chatApplication/index.js",
1808 "groupTitle": "Chat_Applications"
1812 "url": "/api/chat/applications/{id}",
1813 "title": "Gets a single Application",
1816 "title": "Example usage:",
1817 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1821 "name": "ShowApplications",
1822 "group": "Chat_Applications",
1823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825 "filename": "server/api/chatApplication/index.js",
1826 "groupTitle": "Chat_Applications"
1830 "url": "/api/chat/applications/{id}",
1831 "title": "Update an existing Application",
1834 "title": "Example usage:",
1835 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1839 "name": "updateApplications",
1840 "group": "Chat_Applications",
1841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843 "filename": "server/api/chatApplication/index.js",
1844 "groupTitle": "Chat_Applications"
1848 "url": "/api/chat/groups",
1849 "title": "Creates a new Group",
1852 "title": "Example usage:",
1853 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1857 "name": "CreateGroups",
1858 "group": "Chat_Groups",
1873 "field": "description",
1886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1888 "filename": "server/api/chatGroup/index.js",
1889 "groupTitle": "Chat_Groups"
1893 "url": "/api/chat/groups/{id}",
1894 "title": "Deletes a Group",
1897 "title": "Example usage:",
1898 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1902 "name": "DeleteGroups",
1903 "group": "Chat_Groups",
1904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1906 "filename": "server/api/chatGroup/index.js",
1907 "groupTitle": "Chat_Groups"
1911 "url": "/api/chat/groups/describe",
1912 "title": "Gets table info about Groups",
1915 "title": "Example usage:",
1916 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1920 "name": "DescribeGroups",
1921 "group": "Chat_Groups",
1922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1924 "filename": "server/api/chatGroup/index.js",
1925 "groupTitle": "Chat_Groups"
1929 "url": "/api/chat/groups",
1930 "title": "Gets a list of Groups",
1933 "title": "Example usage:",
1934 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1938 "name": "GetGroups",
1939 "group": "Chat_Groups",
1940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1942 "filename": "server/api/chatGroup/index.js",
1943 "groupTitle": "Chat_Groups"
1947 "url": "/api/chat/groups/{id}/members",
1948 "title": "Removes members from a group",
1951 "title": "Example usage:",
1952 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1956 "name": "RemoveMembers",
1957 "group": "Chat_Groups",
1958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1960 "filename": "server/api/chatGroup/index.js",
1961 "groupTitle": "Chat_Groups"
1965 "url": "/api/chat/groups/{id}",
1966 "title": "Gets a single Group",
1969 "title": "Example usage:",
1970 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1974 "name": "ShowGroups",
1975 "group": "Chat_Groups",
1976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978 "filename": "server/api/chatGroup/index.js",
1979 "groupTitle": "Chat_Groups"
1983 "url": "/api/chat/groups/{id}/members",
1984 "title": "Add members to chat group",
1987 "title": "Example usage:",
1988 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1992 "name": "addMembers",
1993 "group": "Chat_Groups",
1994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1996 "filename": "server/api/chatGroup/index.js",
1997 "groupTitle": "Chat_Groups"
2001 "url": "/api/chat/groups/{id}/messages",
2002 "title": "Creates a new group message",
2005 "title": "Example usage:",
2006 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2010 "name": "addMessage",
2011 "group": "Chat_Groups",
2012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014 "filename": "server/api/chatGroup/index.js",
2015 "groupTitle": "Chat_Groups"
2019 "url": "/api/chat/groups/{id}/members",
2020 "title": "Gets Members",
2023 "title": "Example usage:",
2024 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2028 "name": "getMembers",
2029 "group": "Chat_Groups",
2030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032 "filename": "server/api/chatGroup/index.js",
2033 "groupTitle": "Chat_Groups"
2037 "url": "/api/chat/groups/{id}/messages",
2038 "title": "Gets Messages",
2041 "title": "Example usage:",
2042 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2046 "name": "getMessages",
2047 "group": "Chat_Groups",
2048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050 "filename": "server/api/chatGroup/index.js",
2051 "groupTitle": "Chat_Groups"
2055 "url": "/api/chat/groups/{id}/unread",
2056 "title": "Get unread chat group messages",
2059 "title": "Example usage:",
2060 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2065 "group": "Chat_Groups",
2066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068 "filename": "server/api/chatGroup/index.js",
2069 "groupTitle": "Chat_Groups"
2073 "url": "/api/chat/groups/{id}",
2074 "title": "Update an existing Group",
2077 "title": "Example usage:",
2078 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2082 "name": "updateGroups",
2083 "group": "Chat_Groups",
2084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086 "filename": "server/api/chatGroup/index.js",
2087 "groupTitle": "Chat_Groups"
2091 "url": "/api/chat/interactions/{id}/tags",
2092 "title": "Add tags to the interaction",
2095 "title": "Example usage:",
2096 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2101 "group": "Chat_Interactions",
2102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104 "filename": "server/api/chatInteraction/index.js",
2105 "groupTitle": "Chat_Interactions"
2109 "url": "/api/chat/interactions",
2110 "title": "Creates a new Interaction",
2113 "title": "Example usage:",
2114 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2118 "name": "CreateInteractions",
2119 "group": "Chat_Interactions",
2134 "field": "ratingValue",
2145 "field": "ratingType",
2152 "field": "ratingMessage",
2159 "field": "pathTranscript",
2166 "field": "mailTranscript",
2173 "field": "closedAt",
2180 "field": "disposition",
2187 "field": "secondDisposition",
2194 "field": "thirdDisposition",
2208 "field": "browserName",
2215 "field": "browserVersion",
2229 "field": "osVersion",
2236 "field": "deviceModel",
2243 "field": "deviceVendor",
2250 "field": "deviceType",
2264 "field": "customerIp",
2271 "field": "formData",
2278 "field": "read1stAt",
2285 "field": "lastMsgAt",
2296 "field": "lastMsgDirection",
2303 "field": "closeReason",
2310 "field": "customerPort",
2317 "field": "vidaooSessionId",
2323 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2325 "filename": "server/api/chatInteraction/index.js",
2326 "groupTitle": "Chat_Interactions"
2330 "url": "/api/chat/interactions/{id}",
2331 "title": "Deletes a Interaction",
2334 "title": "Example usage:",
2335 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2339 "name": "DeleteInteractions",
2340 "group": "Chat_Interactions",
2341 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2343 "filename": "server/api/chatInteraction/index.js",
2344 "groupTitle": "Chat_Interactions"
2348 "url": "/api/chat/interactions/describe",
2349 "title": "Gets table info about Interactions",
2352 "title": "Example usage:",
2353 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2357 "name": "DescribeInteractions",
2358 "group": "Chat_Interactions",
2359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2361 "filename": "server/api/chatInteraction/index.js",
2362 "groupTitle": "Chat_Interactions"
2366 "url": "/api/chat/interactions",
2367 "title": "Gets a list of Interactions",
2370 "title": "Example usage:",
2371 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2375 "name": "GetInteractions",
2376 "group": "Chat_Interactions",
2377 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2379 "filename": "server/api/chatInteraction/index.js",
2380 "groupTitle": "Chat_Interactions"
2384 "url": "/api/chat/interactions/{id}/tags",
2385 "title": "Removes tags from interaction",
2388 "title": "Example usage:",
2389 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2393 "name": "RemoveTags",
2394 "group": "Chat_Interactions",
2395 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2397 "filename": "server/api/chatInteraction/index.js",
2398 "groupTitle": "Chat_Interactions"
2402 "url": "/api/chat/interactions/{id}",
2403 "title": "Gets a single Interaction",
2406 "title": "Example usage:",
2407 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2411 "name": "ShowInteractions",
2412 "group": "Chat_Interactions",
2413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2415 "filename": "server/api/chatInteraction/index.js",
2416 "groupTitle": "Chat_Interactions"
2420 "url": "/api/chat/interactions/{id}/abandon",
2421 "title": "Abandon interaction",
2424 "title": "Example usage:",
2425 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2430 "group": "Chat_Interactions",
2431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2433 "filename": "server/api/chatInteraction/index.js",
2434 "groupTitle": "Chat_Interactions"
2438 "url": "/api/chat/interactions/{id}/messages",
2439 "title": "Creates new messages",
2442 "title": "Example usage:",
2443 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2447 "name": "addMessage",
2448 "group": "Chat_Interactions",
2481 "field": "direction",
2495 "field": "providerName",
2502 "field": "providerResponse",
2508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2510 "filename": "server/api/chatInteraction/index.js",
2511 "groupTitle": "Chat_Interactions"
2515 "url": "/api/chat/interactions/{id}/close",
2516 "title": "Close Interaction",
2519 "title": "Example usage:",
2520 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2524 "name": "addMessage",
2525 "group": "Chat_Interactions",
2526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2528 "filename": "server/api/chatInteraction/index.js",
2529 "groupTitle": "Chat_Interactions"
2533 "url": "/api/chat/interactions/{id}/attachment_upload",
2534 "title": "Add attachment",
2537 "title": "Example usage:",
2538 "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",
2542 "name": "attachmentUpload",
2543 "group": "Chat_Interactions",
2544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2546 "filename": "server/api/chatInteraction/index.js",
2547 "groupTitle": "Chat_Interactions"
2551 "url": "/api/chat/interactions/{id}/vidaoo",
2552 "title": "Create Vidaoo Session",
2555 "title": "Example usage:",
2556 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2560 "name": "createVidaooSession",
2561 "group": "Chat_Interactions",
2562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2564 "filename": "server/api/chatInteraction/index.js",
2565 "groupTitle": "Chat_Interactions"
2569 "url": "/api/chat/interactions/{id}/custom_update",
2570 "title": "Update interaction",
2573 "title": "Example usage:",
2574 "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",
2578 "name": "customUpdate",
2579 "group": "Chat_Interactions",
2580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2582 "filename": "server/api/chatInteraction/index.js",
2583 "groupTitle": "Chat_Interactions"
2587 "url": "/api/chat/interactions/{id}/download",
2588 "title": "Gets interaction",
2591 "title": "Example usage:",
2592 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2597 "group": "Chat_Interactions",
2598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2600 "filename": "server/api/chatInteraction/index.js",
2601 "groupTitle": "Chat_Interactions"
2605 "url": "/api/chat/interactions/{id}/messages",
2606 "title": "Gets interaction messages",
2609 "title": "Example usage:",
2610 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2614 "name": "getMessages",
2615 "group": "Chat_Interactions",
2616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2618 "filename": "server/api/chatInteraction/index.js",
2619 "groupTitle": "Chat_Interactions"
2623 "url": "/api/chat/interactions/{id}/my_messages",
2624 "title": "Gets interaction messages",
2627 "title": "Example usage:",
2628 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2632 "name": "getMyMessages",
2633 "group": "Chat_Interactions",
2634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2636 "filename": "server/api/chatInteraction/index.js",
2637 "groupTitle": "Chat_Interactions"
2641 "url": "/api/chat/interactions/{id}",
2642 "title": "Update an existing Interaction",
2645 "title": "Example usage:",
2646 "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",
2650 "name": "updateInteractions",
2651 "group": "Chat_Interactions",
2652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2654 "filename": "server/api/chatInteraction/index.js",
2655 "groupTitle": "Chat_Interactions"
2659 "url": "/api/chat/internal/messages",
2660 "title": "Creates a new Message",
2663 "title": "Example usage:",
2664 "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",
2668 "name": "CreateMessages",
2669 "group": "Chat_Internal_Messages",
2691 "field": "ChatInternalMessageId",
2697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2699 "filename": "server/api/chatInternalMessage/index.js",
2700 "groupTitle": "Chat_Internal_Messages"
2704 "url": "/api/chat/internal/messages/{id}",
2705 "title": "Deletes a Message",
2708 "title": "Example usage:",
2709 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2713 "name": "DeleteMessages",
2714 "group": "Chat_Internal_Messages",
2715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2717 "filename": "server/api/chatInternalMessage/index.js",
2718 "groupTitle": "Chat_Internal_Messages"
2722 "url": "/api/chat/internal/messages/describe",
2723 "title": "Gets table info about Messages",
2726 "title": "Example usage:",
2727 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2731 "name": "DescribeMessages",
2732 "group": "Chat_Internal_Messages",
2733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2735 "filename": "server/api/chatInternalMessage/index.js",
2736 "groupTitle": "Chat_Internal_Messages"
2740 "url": "/api/chat/internal/messages",
2741 "title": "Gets a list of Messages",
2744 "title": "Example usage:",
2745 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2749 "name": "GetMessages",
2750 "group": "Chat_Internal_Messages",
2751 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2753 "filename": "server/api/chatInternalMessage/index.js",
2754 "groupTitle": "Chat_Internal_Messages"
2758 "url": "/api/chat/internal/messages/{id}",
2759 "title": "Gets a single Message",
2762 "title": "Example usage:",
2763 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2767 "name": "ShowMessages",
2768 "group": "Chat_Internal_Messages",
2769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2771 "filename": "server/api/chatInternalMessage/index.js",
2772 "groupTitle": "Chat_Internal_Messages"
2776 "url": "/api/chat/internal/messages/{id}",
2777 "title": "Update an existing Message",
2780 "title": "Example usage:",
2781 "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",
2785 "name": "updateMessages",
2786 "group": "Chat_Internal_Messages",
2787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2789 "filename": "server/api/chatInternalMessage/index.js",
2790 "groupTitle": "Chat_Internal_Messages"
2794 "url": "/api/chat/messages",
2795 "title": "Creates a new Message",
2798 "title": "Example usage:",
2799 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2803 "name": "CreateMessages",
2804 "group": "Chat_Messages",
2837 "field": "direction",
2851 "field": "providerName",
2858 "field": "providerResponse",
2864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2866 "filename": "server/api/chatMessage/index.js",
2867 "groupTitle": "Chat_Messages"
2871 "url": "/api/chat/messages/{id}",
2872 "title": "Deletes a Message",
2875 "title": "Example usage:",
2876 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2880 "name": "DeleteMessages",
2881 "group": "Chat_Messages",
2882 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2884 "filename": "server/api/chatMessage/index.js",
2885 "groupTitle": "Chat_Messages"
2889 "url": "/api/chat/messages/describe",
2890 "title": "Gets table info about Messages",
2893 "title": "Example usage:",
2894 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2898 "name": "DescribeMessages",
2899 "group": "Chat_Messages",
2900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2902 "filename": "server/api/chatMessage/index.js",
2903 "groupTitle": "Chat_Messages"
2907 "url": "/api/chat/messages",
2908 "title": "Gets a list of Messages",
2911 "title": "Example usage:",
2912 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2916 "name": "GetMessages",
2917 "group": "Chat_Messages",
2918 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2920 "filename": "server/api/chatMessage/index.js",
2921 "groupTitle": "Chat_Messages"
2925 "url": "/api/chat/messages/{id}",
2926 "title": "Gets a single Message",
2929 "title": "Example usage:",
2930 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2934 "name": "ShowMessages",
2935 "group": "Chat_Messages",
2936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2938 "filename": "server/api/chatMessage/index.js",
2939 "groupTitle": "Chat_Messages"
2943 "url": "/api/chat/messages/{id}",
2944 "title": "Update an existing Message",
2947 "title": "Example usage:",
2948 "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",
2952 "name": "updateMessages",
2953 "group": "Chat_Messages",
2954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2956 "filename": "server/api/chatMessage/index.js",
2957 "groupTitle": "Chat_Messages"
2961 "url": "/api/chat/offline_messages",
2962 "title": "Creates a new OfflineMessage",
2965 "title": "Example usage:",
2966 "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",
2970 "name": "CreateOfflineMessages",
2971 "group": "Chat_Offline_Messages",
2985 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2987 "filename": "server/api/chatOfflineMessage/index.js",
2988 "groupTitle": "Chat_Offline_Messages"
2992 "url": "/api/chat/offline_messages/{id}",
2993 "title": "Deletes a OfflineMessage",
2996 "title": "Example usage:",
2997 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3001 "name": "DeleteOfflineMessages",
3002 "group": "Chat_Offline_Messages",
3003 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3005 "filename": "server/api/chatOfflineMessage/index.js",
3006 "groupTitle": "Chat_Offline_Messages"
3010 "url": "/api/chat/offline_messages/describe",
3011 "title": "Gets table info about OfflineMessages",
3014 "title": "Example usage:",
3015 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3019 "name": "DescribeOfflineMessages",
3020 "group": "Chat_Offline_Messages",
3021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3023 "filename": "server/api/chatOfflineMessage/index.js",
3024 "groupTitle": "Chat_Offline_Messages"
3028 "url": "/api/chat/offline_messages",
3029 "title": "Gets a list of OfflineMessages",
3032 "title": "Example usage:",
3033 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3037 "name": "GetOfflineMessages",
3038 "group": "Chat_Offline_Messages",
3039 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3041 "filename": "server/api/chatOfflineMessage/index.js",
3042 "groupTitle": "Chat_Offline_Messages"
3046 "url": "/api/chat/offline_messages/{id}",
3047 "title": "Gets a single OfflineMessage",
3050 "title": "Example usage:",
3051 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3055 "name": "ShowOfflineMessages",
3056 "group": "Chat_Offline_Messages",
3057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3059 "filename": "server/api/chatOfflineMessage/index.js",
3060 "groupTitle": "Chat_Offline_Messages"
3064 "url": "/api/chat/offline_messages/{id}",
3065 "title": "Update an existing OfflineMessage",
3068 "title": "Example usage:",
3069 "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",
3073 "name": "updateOfflineMessages",
3074 "group": "Chat_Offline_Messages",
3075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3077 "filename": "server/api/chatOfflineMessage/index.js",
3078 "groupTitle": "Chat_Offline_Messages"
3082 "url": "/api/chat/proactive_actions",
3083 "title": "Creates a new Proactive Action",
3086 "title": "Example usage:",
3087 "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",
3091 "name": "CreateProactive_Actions",
3092 "group": "Chat_Proactive_Actions",
3118 "field": "selector",
3131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3133 "filename": "server/api/chatProactiveAction/index.js",
3134 "groupTitle": "Chat_Proactive_Actions"
3138 "url": "/api/chat/proactive_actions/{id}",
3139 "title": "Deletes a Proactive Action",
3142 "title": "Example usage:",
3143 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3147 "name": "DeleteProactive_Actions",
3148 "group": "Chat_Proactive_Actions",
3149 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3151 "filename": "server/api/chatProactiveAction/index.js",
3152 "groupTitle": "Chat_Proactive_Actions"
3156 "url": "/api/chat/proactive_actions/{id}",
3157 "title": "Gets a single Proactive Action",
3160 "title": "Example usage:",
3161 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3165 "name": "ShowProactive_Actions",
3166 "group": "Chat_Proactive_Actions",
3167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3169 "filename": "server/api/chatProactiveAction/index.js",
3170 "groupTitle": "Chat_Proactive_Actions"
3174 "url": "/api/chat/proactive_actions/{id}",
3175 "title": "Update an existing Proactive Action",
3178 "title": "Example usage:",
3179 "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",
3183 "name": "updateProactive_Actions",
3184 "group": "Chat_Proactive_Actions",
3185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3187 "filename": "server/api/chatProactiveAction/index.js",
3188 "groupTitle": "Chat_Proactive_Actions"
3192 "url": "/api/chat/reports/queue",
3193 "title": "Creates a new Chat Queue Report",
3196 "title": "Example usage:",
3197 "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",
3201 "name": "CreateChat_Queue_Reports",
3202 "group": "Chat_Queue_Reports",
3210 "field": "uniqueid",
3238 "field": "acceptAt",
3258 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3260 "filename": "server/api/chatQueueReport/index.js",
3261 "groupTitle": "Chat_Queue_Reports"
3265 "url": "/api/chat/reports/queue/{id}",
3266 "title": "Deletes a Chat Queue Report",
3269 "title": "Example usage:",
3270 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3274 "name": "DeleteChat_Queue_Reports",
3275 "group": "Chat_Queue_Reports",
3276 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3278 "filename": "server/api/chatQueueReport/index.js",
3279 "groupTitle": "Chat_Queue_Reports"
3283 "url": "/api/chat/reports/queue/describe",
3284 "title": "Gets table info about Chat Queue Reports",
3287 "title": "Example usage:",
3288 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3292 "name": "DescribeChat_Queue_Reports",
3293 "group": "Chat_Queue_Reports",
3294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3296 "filename": "server/api/chatQueueReport/index.js",
3297 "groupTitle": "Chat_Queue_Reports"
3301 "url": "/api/chat/reports/queue",
3302 "title": "Gets a list of Chat Queue Reports",
3305 "title": "Example usage:",
3306 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3310 "name": "GetChat_Queue_Reports",
3311 "group": "Chat_Queue_Reports",
3312 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3314 "filename": "server/api/chatQueueReport/index.js",
3315 "groupTitle": "Chat_Queue_Reports"
3319 "url": "/api/chat/reports/queue/{id}",
3320 "title": "Gets a single Chat Queue Report",
3323 "title": "Example usage:",
3324 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3328 "name": "ShowChat_Queue_Reports",
3329 "group": "Chat_Queue_Reports",
3330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3332 "filename": "server/api/chatQueueReport/index.js",
3333 "groupTitle": "Chat_Queue_Reports"
3337 "url": "/api/chat/reports/queue/{id}",
3338 "title": "Update an existing Chat Queue Report",
3341 "title": "Example usage:",
3342 "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",
3346 "name": "updateChat_Queue_Reports",
3347 "group": "Chat_Queue_Reports",
3348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3350 "filename": "server/api/chatQueueReport/index.js",
3351 "groupTitle": "Chat_Queue_Reports"
3355 "url": "/api/chat/queues/{id}/users",
3356 "title": "Add agents to a queue",
3359 "title": "Example usage:",
3360 "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",
3364 "name": "AddAgents",
3365 "group": "Chat_Queues",
3366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3368 "filename": "server/api/chatQueue/index.js",
3369 "groupTitle": "Chat_Queues"
3373 "url": "/api/chat/queues/{id}/teams",
3374 "title": "Add teams to a queue",
3377 "title": "Example usage:",
3378 "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",
3383 "group": "Chat_Queues",
3384 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3386 "filename": "server/api/chatQueue/index.js",
3387 "groupTitle": "Chat_Queues"
3391 "url": "/api/chat/queues",
3392 "title": "Creates a new Queue",
3395 "title": "Example usage:",
3396 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3400 "name": "CreateQueues",
3401 "group": "Chat_Queues",
3416 "field": "description",
3435 "field": "strategy",
3441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3443 "filename": "server/api/chatQueue/index.js",
3444 "groupTitle": "Chat_Queues"
3448 "url": "/api/chat/queues/{id}",
3449 "title": "Deletes a Queue",
3452 "title": "Example usage:",
3453 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3457 "name": "DeleteQueues",
3458 "group": "Chat_Queues",
3459 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3461 "filename": "server/api/chatQueue/index.js",
3462 "groupTitle": "Chat_Queues"
3466 "url": "/api/chat/queues/describe",
3467 "title": "Gets table info about Queues",
3470 "title": "Example usage:",
3471 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3475 "name": "DescribeQueues",
3476 "group": "Chat_Queues",
3477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3479 "filename": "server/api/chatQueue/index.js",
3480 "groupTitle": "Chat_Queues"
3484 "url": "/api/chat/queues/{id}/users",
3485 "title": "Gets queue agents",
3488 "title": "Example usage:",
3489 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3493 "name": "GetAgents",
3494 "group": "Chat_Queues",
3495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3497 "filename": "server/api/chatQueue/index.js",
3498 "groupTitle": "Chat_Queues"
3502 "url": "/api/chat/queues/{id}/members",
3503 "title": "GetMembers",
3506 "title": "Example usage:",
3507 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3511 "name": "GetMembers",
3512 "group": "Chat_Queues",
3513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3515 "filename": "server/api/chatQueue/index.js",
3516 "groupTitle": "Chat_Queues"
3520 "url": "/api/chat/queues",
3521 "title": "Gets a list of Queues",
3524 "title": "Example usage:",
3525 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3529 "name": "GetQueues",
3530 "group": "Chat_Queues",
3531 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3533 "filename": "server/api/chatQueue/index.js",
3534 "groupTitle": "Chat_Queues"
3538 "url": "/api/chat/queues/{id}/teams",
3539 "title": "Gets queues list",
3542 "title": "Example usage:",
3543 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3548 "group": "Chat_Queues",
3549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3551 "filename": "server/api/chatQueue/index.js",
3552 "groupTitle": "Chat_Queues"
3556 "url": "/api/chat/queues/{id}/users",
3557 "title": "Removes agents from a queue",
3560 "title": "Example usage:",
3561 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3565 "name": "RemoveAgents",
3566 "group": "Chat_Queues",
3567 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3569 "filename": "server/api/chatQueue/index.js",
3570 "groupTitle": "Chat_Queues"
3574 "url": "/api/chat/queues/{id}",
3575 "title": "Gets a single Queue",
3578 "title": "Example usage:",
3579 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3583 "name": "ShowQueues",
3584 "group": "Chat_Queues",
3585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3587 "filename": "server/api/chatQueue/index.js",
3588 "groupTitle": "Chat_Queues"
3592 "url": "/api/chat/queues/{id}",
3593 "title": "Update an existing Queue",
3596 "title": "Example usage:",
3597 "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",
3601 "name": "updateQueues",
3602 "group": "Chat_Queues",
3603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3605 "filename": "server/api/chatQueue/index.js",
3606 "groupTitle": "Chat_Queues"
3610 "url": "/api/chat/reports/transfer",
3611 "title": "Creates a new Chat Transfer Report",
3614 "title": "Example usage:",
3615 "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",
3619 "name": "CreateChat_Transfer_Reports",
3620 "group": "Chat_Transfer_Reports",
3628 "field": "uniqueid",
3647 "field": "transferredAt",
3653 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3655 "filename": "server/api/chatTransferReport/index.js",
3656 "groupTitle": "Chat_Transfer_Reports"
3660 "url": "/api/chat/reports/transfer/{id}",
3661 "title": "Deletes a Chat Transfer Report",
3664 "title": "Example usage:",
3665 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3669 "name": "DeleteChat_Transfer_Reports",
3670 "group": "Chat_Transfer_Reports",
3671 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3673 "filename": "server/api/chatTransferReport/index.js",
3674 "groupTitle": "Chat_Transfer_Reports"
3678 "url": "/api/chat/reports/transfer/describe",
3679 "title": "Gets table info about Chat Transfer Reports",
3682 "title": "Example usage:",
3683 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3687 "name": "DescribeChat_Transfer_Reports",
3688 "group": "Chat_Transfer_Reports",
3689 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3691 "filename": "server/api/chatTransferReport/index.js",
3692 "groupTitle": "Chat_Transfer_Reports"
3696 "url": "/api/chat/reports/transfer",
3697 "title": "Gets a list of Chat Transfer Reports",
3700 "title": "Example usage:",
3701 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3705 "name": "GetChat_Transfer_Reports",
3706 "group": "Chat_Transfer_Reports",
3707 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3709 "filename": "server/api/chatTransferReport/index.js",
3710 "groupTitle": "Chat_Transfer_Reports"
3714 "url": "/api/chat/reports/transfer/{id}",
3715 "title": "Gets a single Chat Transfer Report",
3718 "title": "Example usage:",
3719 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3723 "name": "ShowChat_Transfer_Reports",
3724 "group": "Chat_Transfer_Reports",
3725 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3727 "filename": "server/api/chatTransferReport/index.js",
3728 "groupTitle": "Chat_Transfer_Reports"
3732 "url": "/api/chat/reports/transfer/{id}",
3733 "title": "Update an existing Chat Transfer Report",
3736 "title": "Example usage:",
3737 "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",
3741 "name": "updateChat_Transfer_Reports",
3742 "group": "Chat_Transfer_Reports",
3743 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3745 "filename": "server/api/chatTransferReport/index.js",
3746 "groupTitle": "Chat_Transfer_Reports"
3750 "url": "/api/chat/websites/{id}/users",
3751 "title": "Add agents to a website",
3754 "title": "Example usage:",
3755 "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",
3759 "name": "AddAgents",
3760 "group": "Chat_Websites",
3761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3763 "filename": "server/api/chatWebsite/index.js",
3764 "groupTitle": "Chat_Websites"
3768 "url": "/api/chat/websites",
3769 "title": "Creates a new Website",
3772 "title": "Example usage:",
3773 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3777 "name": "CreateWebsites",
3778 "group": "Chat_Websites",
3800 "field": "description",
3814 "field": "mapKeyOffline",
3828 "field": "agentAlias",
3835 "field": "customerAlias",
3849 "field": "color_button",
3856 "field": "textColor",
3863 "field": "fontSize",
3877 "field": "animation",
3888 "field": "header_shape",
3895 "field": "header_online",
3902 "field": "start_chat_button",
3909 "field": "offline_chat_button",
3916 "field": "header_offline",
3923 "field": "download_transcript",
3937 "field": "whiteLabel",
3944 "field": "defaultWhiteLabel",
3958 "field": "closingQuestion",
3965 "field": "formSubmitSuccessMessage",
3972 "field": "formSubmitFailureMessage",
3979 "field": "noteTitle",
3986 "field": "placeholderMessage",
3993 "field": "closingMessage",
4000 "field": "closingMessageButton",
4007 "field": "skipMessageButton",
4014 "field": "conditionAgreement",
4021 "field": "enableRating",
4028 "field": "enableFeedback",
4035 "field": "enableSendButton",
4042 "field": "feedbackTitle",
4053 "field": "ratingType",
4060 "field": "ratingStarsNumber",
4067 "field": "onlineForm",
4074 "field": "offlineForm",
4088 "field": "autoclose",
4095 "field": "enableCustomerWriting",
4102 "field": "forwardTranscript",
4109 "field": "forwardTranscriptMessage",
4116 "field": "forwardOffline",
4123 "field": "forwardOfflineAddress",
4130 "field": "waitingTitle",
4137 "field": "waitingMessage",
4144 "field": "offlineMessageSubject",
4151 "field": "offlineMessageBody",
4158 "field": "enableUnmanagedNote",
4165 "field": "unmanagedMessage",
4172 "field": "skipUnmanaged",
4179 "field": "sendUnmanaged",
4186 "field": "enableCustomerAttachment",
4193 "field": "enableCustomerCheckmarks",
4200 "field": "agentAvatar",
4207 "field": "showAgentAvatar",
4214 "field": "timezone",
4221 "field": "notificationTemplate",
4228 "field": "notificationSound",
4235 "field": "notificationShake",
4242 "field": "hideWhenOffline",
4249 "field": "agentIdentifier",
4256 "field": "waitForTheAssignedAgent",
4263 "field": "alignment",
4270 "field": "verticalAlignment",
4277 "field": "messagesAlignment",
4284 "field": "defaultTitle",
4291 "field": "customerAvatar",
4298 "field": "showCustomerAvatar",
4305 "field": "messageFontSize",
4312 "field": "backgroundColor",
4319 "field": "queueTransfer",
4326 "field": "queueTransferTimeout",
4333 "field": "agentTransfer",
4340 "field": "agentTransferTimeout",
4347 "field": "systemAlias",
4354 "field": "systemAvatar",
4361 "field": "mandatoryDispositionPauseId",
4362 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4368 "field": "mandatoryDisposition",
4369 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4375 "field": "vidaooEscalation",
4382 "field": "vidaooApiKey",
4389 "field": "openNewInteraction",
4396 "field": "subjectOffline",
4402 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4404 "filename": "server/api/chatWebsite/index.js",
4405 "groupTitle": "Chat_Websites"
4409 "url": "/api/chat/websites/{id}",
4410 "title": "Deletes a Website",
4413 "title": "Example usage:",
4414 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4418 "name": "DeleteWebsites",
4419 "group": "Chat_Websites",
4420 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4422 "filename": "server/api/chatWebsite/index.js",
4423 "groupTitle": "Chat_Websites"
4427 "url": "/api/chat/websites/describe",
4428 "title": "Gets table info about Websites",
4431 "title": "Example usage:",
4432 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4436 "name": "DescribeWebsites",
4437 "group": "Chat_Websites",
4438 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4440 "filename": "server/api/chatWebsite/index.js",
4441 "groupTitle": "Chat_Websites"
4445 "url": "/api/chat/websites/{id}/users",
4446 "title": "Gets agents from website",
4449 "title": "Example usage:",
4450 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4454 "name": "GetAgents",
4455 "group": "Chat_Websites",
4456 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4458 "filename": "server/api/chatWebsite/index.js",
4459 "groupTitle": "Chat_Websites"
4463 "url": "/api/chat/websites",
4464 "title": "Gets a list of Websites",
4467 "title": "Example usage:",
4468 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4472 "name": "GetWebsites",
4473 "group": "Chat_Websites",
4474 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4476 "filename": "server/api/chatWebsite/index.js",
4477 "groupTitle": "Chat_Websites"
4481 "url": "/api/chat/websites/{id}/users",
4482 "title": "Removes agents from a website",
4485 "title": "Example usage:",
4486 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4490 "name": "RemoveAgents",
4491 "group": "Chat_Websites",
4492 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4494 "filename": "server/api/chatWebsite/index.js",
4495 "groupTitle": "Chat_Websites"
4499 "url": "/api/chat/websites/{id}/canned_answers",
4500 "title": "Removes canned answers from account",
4503 "title": "Example usage:",
4504 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4508 "name": "RemoveAnswers",
4509 "group": "Chat_Websites",
4510 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4512 "filename": "server/api/chatWebsite/index.js",
4513 "groupTitle": "Chat_Websites"
4517 "url": "/api/chat/websites/{id}/dispositions",
4518 "title": "Removes canned answers from account",
4521 "title": "Example usage:",
4522 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4526 "name": "RemoveDispositions",
4527 "group": "Chat_Websites",
4528 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4530 "filename": "server/api/chatWebsite/index.js",
4531 "groupTitle": "Chat_Websites"
4535 "url": "/api/chat/websites/{id}",
4536 "title": "Gets a single Website",
4539 "title": "Example usage:",
4540 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4544 "name": "ShowWebsites",
4545 "group": "Chat_Websites",
4546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4548 "filename": "server/api/chatWebsite/index.js",
4549 "groupTitle": "Chat_Websites"
4553 "url": "/api/chat/messages/{id}/accept",
4554 "title": "Accepts message",
4557 "title": "Example usage:",
4558 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4562 "name": "acceptMessage",
4563 "group": "Chat_Websites",
4564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4566 "filename": "server/api/chatMessage/index.js",
4567 "groupTitle": "Chat_Websites"
4571 "url": "/api/chat/websites/{id}/canned_answers",
4572 "title": "Creates new canned answer",
4575 "title": "Example usage:",
4576 "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",
4580 "name": "addAnswer",
4581 "group": "Chat_Websites",
4603 "field": "description",
4616 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4618 "filename": "server/api/chatWebsite/index.js",
4619 "groupTitle": "Chat_Websites"
4623 "url": "/api/chat/websites/{id}/applications",
4624 "title": "Creates new applications",
4627 "title": "Example usage:",
4628 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4632 "name": "addApplications",
4633 "group": "Chat_Websites",
4641 "field": "priority",
4662 "field": "description",
4669 "field": "interval",
4675 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4677 "filename": "server/api/chatWebsite/index.js",
4678 "groupTitle": "Chat_Websites"
4682 "url": "/api/chat/websites/{id}/avatar",
4683 "title": "Add avatar",
4686 "title": "Example usage:",
4687 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4691 "name": "addAvatar",
4692 "group": "Chat_Websites",
4693 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4695 "filename": "server/api/chatWebsite/index.js",
4696 "groupTitle": "Chat_Websites"
4700 "url": "/api/chat/websites/{id}/customer_avatar",
4701 "title": "Add customer avatar",
4704 "title": "Example usage:",
4705 "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",
4709 "name": "addCustomerAvatar",
4710 "group": "Chat_Websites",
4711 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4713 "filename": "server/api/chatWebsite/index.js",
4714 "groupTitle": "Chat_Websites"
4718 "url": "/api/chat/websites/{id}/dispositions",
4719 "title": "Creates new disposition",
4722 "title": "Example usage:",
4723 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4727 "name": "addDisposition",
4728 "group": "Chat_Websites",
4755 "field": "description",
4761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4763 "filename": "server/api/chatWebsite/index.js",
4764 "groupTitle": "Chat_Websites"
4768 "url": "/api/chat/accounts/{id}/interactions",
4769 "title": "Creates new interactions",
4772 "title": "Example usage:",
4773 "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",
4777 "name": "addInteraction",
4778 "group": "Chat_Websites",
4793 "field": "ratingValue",
4804 "field": "ratingType",
4811 "field": "ratingMessage",
4818 "field": "pathTranscript",
4825 "field": "mailTranscript",
4832 "field": "closedAt",
4839 "field": "disposition",
4846 "field": "secondDisposition",
4853 "field": "thirdDisposition",
4867 "field": "browserName",
4874 "field": "browserVersion",
4888 "field": "osVersion",
4895 "field": "deviceModel",
4902 "field": "deviceVendor",
4909 "field": "deviceType",
4923 "field": "customerIp",
4930 "field": "formData",
4937 "field": "read1stAt",
4944 "field": "lastMsgAt",
4955 "field": "lastMsgDirection",
4962 "field": "closeReason",
4969 "field": "customerPort",
4976 "field": "vidaooSessionId",
4982 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4984 "filename": "server/api/chatWebsite/index.js",
4985 "groupTitle": "Chat_Websites"
4989 "url": "/api/chat/websites/{id}/logo",
4990 "title": "Add logo",
4993 "title": "Example usage:",
4994 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4999 "group": "Chat_Websites",
5000 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5002 "filename": "server/api/chatWebsite/index.js",
5003 "groupTitle": "Chat_Websites"
5007 "url": "/api/chat/websites/{id}/proactive_actions",
5008 "title": "Creates new Proactive Actions",
5011 "title": "Example usage:",
5012 "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",
5016 "name": "addProactiveActions",
5017 "group": "Chat_Websites",
5043 "field": "selector",
5056 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5058 "filename": "server/api/chatWebsite/index.js",
5059 "groupTitle": "Chat_Websites"
5063 "url": "/api/chat/websites/{id}/system_avatar",
5064 "title": "Add system avatar",
5067 "title": "Example usage:",
5068 "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",
5072 "name": "addSystemAvatar",
5073 "group": "Chat_Websites",
5074 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5076 "filename": "server/api/chatWebsite/index.js",
5077 "groupTitle": "Chat_Websites"
5081 "url": "/api/chat/websites/{id}/canned_answers",
5082 "title": "Gets account canned answers",
5085 "title": "Example usage:",
5086 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5090 "name": "getAnswers",
5091 "group": "Chat_Websites",
5092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5094 "filename": "server/api/chatWebsite/index.js",
5095 "groupTitle": "Chat_Websites"
5099 "url": "/api/chat/websites/{id}/applications",
5100 "title": "Gets Website Applications",
5103 "title": "Example usage:",
5104 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5108 "name": "getApplications",
5109 "group": "Chat_Websites",
5110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5112 "filename": "server/api/chatWebsite/index.js",
5113 "groupTitle": "Chat_Websites"
5117 "url": "/api/chat/websites/{id}/avatar",
5118 "title": "Get avatar",
5121 "title": "Example usage:",
5122 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5126 "name": "getAvatar",
5127 "group": "Chat_Websites",
5128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5130 "filename": "server/api/chatWebsite/index.js",
5131 "groupTitle": "Chat_Websites"
5135 "url": "/api/chat/websites/{id}/customer_avatar",
5136 "title": "Get Customer Avatar",
5139 "title": "Example usage:",
5140 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5144 "name": "getCustomerAvatar",
5145 "group": "Chat_Websites",
5146 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5148 "filename": "server/api/chatWebsite/index.js",
5149 "groupTitle": "Chat_Websites"
5153 "url": "/api/chat/websites/{id}/dispositions",
5154 "title": "Gets account dispositions",
5157 "title": "Example usage:",
5158 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5162 "name": "getDispositions",
5163 "group": "Chat_Websites",
5164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5166 "filename": "server/api/chatWebsite/index.js",
5167 "groupTitle": "Chat_Websites"
5171 "url": "/api/chat/websites/{id}/fields",
5172 "title": "Gets Website Fields",
5175 "title": "Example usage:",
5176 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5180 "name": "getFields",
5181 "group": "Chat_Websites",
5182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5184 "filename": "server/api/chatWebsite/index.js",
5185 "groupTitle": "Chat_Websites"
5189 "url": "/api/chat/websites/{id}/interactions",
5190 "title": "Gets Website Interactions",
5193 "title": "Example usage:",
5194 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5198 "name": "getInteraction",
5199 "group": "Chat_Websites",
5200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5202 "filename": "server/api/chatWebsite/index.js",
5203 "groupTitle": "Chat_Websites"
5207 "url": "/api/chat/websites/{id}/logo",
5208 "title": "Get logo",
5211 "title": "Example usage:",
5212 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5217 "group": "Chat_Websites",
5218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5220 "filename": "server/api/chatWebsite/index.js",
5221 "groupTitle": "Chat_Websites"
5225 "url": "/api/chat/websites/{id}/offline_messages",
5226 "title": "Gets Website Offline Messages",
5229 "title": "Example usage:",
5230 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5234 "name": "getOfflineMessages",
5235 "group": "Chat_Websites",
5236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5238 "filename": "server/api/chatWebsite/index.js",
5239 "groupTitle": "Chat_Websites"
5243 "url": "/api/chat/websites/{id}/proactive_actions",
5244 "title": "Gets Website Proactive Actions",
5247 "title": "Example usage:",
5248 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5252 "name": "getProactiveActions",
5253 "group": "Chat_Websites",
5254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5256 "filename": "server/api/chatWebsite/index.js",
5257 "groupTitle": "Chat_Websites"
5261 "url": "/api/chat/websites/{id}/snippet",
5262 "title": "Gets Website Snippet",
5265 "title": "Example usage:",
5266 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5270 "name": "getSnippet",
5271 "group": "Chat_Websites",
5272 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5274 "filename": "server/api/chatWebsite/index.js",
5275 "groupTitle": "Chat_Websites"
5279 "url": "/api/chat/websites/{id}/system_avatar",
5280 "title": "Get System Avatar",
5283 "title": "Example usage:",
5284 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5288 "name": "getSystemAvatar",
5289 "group": "Chat_Websites",
5290 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5292 "filename": "server/api/chatWebsite/index.js",
5293 "groupTitle": "Chat_Websites"
5297 "url": "/api/chat/websites/{id}/notify",
5298 "title": "Notify new message",
5301 "title": "Example usage:",
5302 "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",
5307 "group": "Chat_Websites",
5308 "description": "<p>Motion 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>",
5310 "filename": "server/api/chatWebsite/index.js",
5311 "groupTitle": "Chat_Websites"
5315 "url": "/api/chat/websites/{id}/offline",
5316 "title": "Offline message",
5319 "title": "Example usage:",
5320 "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",
5325 "group": "Chat_Websites",
5326 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5328 "filename": "server/api/chatWebsite/index.js",
5329 "groupTitle": "Chat_Websites"
5333 "url": "/api/chat/messages/{id}/reject",
5334 "title": "Rejects message",
5337 "title": "Example usage:",
5338 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5342 "name": "rejectMessage",
5343 "group": "Chat_Websites",
5344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5346 "filename": "server/api/chatMessage/index.js",
5347 "groupTitle": "Chat_Websites"
5351 "url": "/api/chat/websites/{id}",
5352 "title": "Update an existing Website",
5355 "title": "Example usage:",
5356 "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",
5360 "name": "updateWebsites",
5361 "group": "Chat_Websites",
5362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5364 "filename": "server/api/chatWebsite/index.js",
5365 "groupTitle": "Chat_Websites"
5369 "url": "/api/cloudProviders",
5370 "title": "Creates a new CloudProvider",
5373 "title": "Example usage:",
5374 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5378 "name": "CreateCloudProviders",
5379 "group": "CloudProviders",
5418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5420 "filename": "server/api/cloudProvider/index.js",
5421 "groupTitle": "CloudProviders"
5425 "url": "/api/cloudProviders/{id}",
5426 "title": "Deletes a CloudProvider",
5429 "title": "Example usage:",
5430 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5434 "name": "DeleteCloudProviders",
5435 "group": "CloudProviders",
5436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5438 "filename": "server/api/cloudProvider/index.js",
5439 "groupTitle": "CloudProviders"
5443 "url": "/api/cloudProviders",
5444 "title": "Gets a list of CloudProviders",
5447 "title": "Example usage:",
5448 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5452 "name": "GetCloudProviders",
5453 "group": "CloudProviders",
5454 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5456 "filename": "server/api/cloudProvider/index.js",
5457 "groupTitle": "CloudProviders"
5461 "url": "/api/cloudProviders/{id}",
5462 "title": "Gets a single CloudProvider",
5465 "title": "Example usage:",
5466 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5470 "name": "ShowCloudProviders",
5471 "group": "CloudProviders",
5472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5474 "filename": "server/api/cloudProvider/index.js",
5475 "groupTitle": "CloudProviders"
5479 "url": "/api/cloudProviders/{id}",
5480 "title": "Update an existing CloudProvider",
5483 "title": "Example usage:",
5484 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5488 "name": "updateCloudProviders",
5489 "group": "CloudProviders",
5490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5492 "filename": "server/api/cloudProvider/index.js",
5493 "groupTitle": "CloudProviders"
5497 "url": "/api/cm/companies",
5498 "title": "Creates a new Company",
5501 "title": "Example usage:",
5502 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5506 "name": "CreateCompanies",
5507 "group": "Cm_Companies",
5529 "field": "companyId",
5571 "field": "postalCode",
5599 "field": "emailDomain",
5613 "field": "sPostalCode",
5627 "field": "sCountry",
5634 "field": "description",
5640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5642 "filename": "server/api/cmCompany/index.js",
5643 "groupTitle": "Cm_Companies"
5647 "url": "/api/cm/companies/{id}",
5648 "title": "Deletes a Company",
5651 "title": "Example usage:",
5652 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5656 "name": "DeleteCompanies",
5657 "group": "Cm_Companies",
5658 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5660 "filename": "server/api/cmCompany/index.js",
5661 "groupTitle": "Cm_Companies"
5665 "url": "/api/cm/companies/describe",
5666 "title": "Gets table info about Companies",
5669 "title": "Example usage:",
5670 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5674 "name": "DescribeCompanies",
5675 "group": "Cm_Companies",
5676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5678 "filename": "server/api/cmCompany/index.js",
5679 "groupTitle": "Cm_Companies"
5683 "url": "/api/cm/companies",
5684 "title": "Gets a list of Companies",
5687 "title": "Example usage:",
5688 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5692 "name": "GetCompanies",
5693 "group": "Cm_Companies",
5694 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5696 "filename": "server/api/cmCompany/index.js",
5697 "groupTitle": "Cm_Companies"
5701 "url": "/api/cm/companies/{id}",
5702 "title": "Gets a single Company",
5705 "title": "Example usage:",
5706 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5710 "name": "ShowCompanies",
5711 "group": "Cm_Companies",
5712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5714 "filename": "server/api/cmCompany/index.js",
5715 "groupTitle": "Cm_Companies"
5719 "url": "/api/cm/companies/{id}/contacts",
5720 "title": "Creates new contacts",
5723 "title": "Example usage:",
5724 "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",
5728 "name": "addContacts",
5729 "group": "Cm_Companies",
5737 "field": "firstName",
5744 "field": "lastName",
5758 "field": "postalCode",
5779 "field": "dateOfBirth",
5786 "field": "description",
5828 "field": "facebook",
5884 "field": "telegram",
5898 "field": "priority",
5905 "field": "scheduledat",
5911 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5913 "filename": "server/api/cmCompany/index.js",
5914 "groupTitle": "Cm_Companies"
5918 "url": "/api/cm/companies/{id}/contacts",
5919 "title": "Gets List Contacts",
5922 "title": "Example usage:",
5923 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5927 "name": "getContacts",
5928 "group": "Cm_Companies",
5929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5931 "filename": "server/api/cmCompany/index.js",
5932 "groupTitle": "Cm_Companies"
5936 "url": "/api/cm/companies/{id}",
5937 "title": "Update an existing Company",
5940 "title": "Example usage:",
5941 "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",
5945 "name": "updateCompanies",
5946 "group": "Cm_Companies",
5947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5949 "filename": "server/api/cmCompany/index.js",
5950 "groupTitle": "Cm_Companies"
5954 "url": "/api/cm/contacts/{id}",
5955 "title": "Deletes a Contact",
5958 "title": "Example usage:",
5959 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5963 "name": "DeleteContacts",
5964 "group": "Cm_Contacts",
5965 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5967 "filename": "server/api/cmContact/index.js",
5968 "groupTitle": "Cm_Contacts"
5972 "url": "/api/cm/contacts/describe",
5973 "title": "Gets table info about Contacts",
5976 "title": "Example usage:",
5977 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5981 "name": "DescribeContacts",
5982 "group": "Cm_Contacts",
5983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5985 "filename": "server/api/cmContact/index.js",
5986 "groupTitle": "Cm_Contacts"
5990 "url": "/api/cm/contacts",
5991 "title": "Gets a list of Contacts",
5994 "title": "Example usage:",
5995 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5999 "name": "GetContacts",
6000 "group": "Cm_Contacts",
6001 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6003 "filename": "server/api/cmContact/index.js",
6004 "groupTitle": "Cm_Contacts"
6008 "url": "/api/cm/contacts/{id}/finals",
6009 "title": "Gets contact hopper finals",
6012 "title": "Example usage:",
6013 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6017 "name": "GetHopperFinals",
6018 "group": "Cm_Contacts",
6019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6021 "filename": "server/api/cmContact/index.js",
6022 "groupTitle": "Cm_Contacts"
6026 "url": "/api/cm/contacts/{id}/hopper_histories",
6027 "title": "Gets contact hopper histories",
6030 "title": "Example usage:",
6031 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6035 "name": "GetHopperHistories",
6036 "group": "Cm_Contacts",
6037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6039 "filename": "server/api/cmContact/index.js",
6040 "groupTitle": "Cm_Contacts"
6044 "url": "/api/cm/contacts/{id}/hoppers",
6045 "title": "Gets contact hoppers",
6048 "title": "Example usage:",
6049 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6053 "name": "GetHoppers",
6054 "group": "Cm_Contacts",
6055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6057 "filename": "server/api/cmContact/index.js",
6058 "groupTitle": "Cm_Contacts"
6062 "url": "/api/cm/contacts/create_many",
6063 "title": "Create Contacts",
6066 "title": "Example usage:",
6067 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6071 "name": "bulkCreate",
6072 "group": "Cm_Contacts",
6073 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6075 "filename": "server/api/cmContact/index.js",
6076 "groupTitle": "Cm_Contacts"
6080 "url": "/api/cm/contacts",
6081 "title": "Create Contact",
6084 "title": "Example usage:",
6085 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6090 "group": "Cm_Contacts",
6091 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6093 "filename": "server/api/cmContact/index.js",
6094 "groupTitle": "Cm_Contacts"
6098 "url": "/api/cm/contacts/{id}/journey",
6099 "title": "Gets customer journey",
6102 "title": "Example usage:",
6103 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6107 "name": "getJourney",
6108 "group": "Cm_Contacts",
6109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6111 "filename": "server/api/cmContact/index.js",
6112 "groupTitle": "Cm_Contacts"
6116 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6117 "title": "Gets contact hopper blacks",
6120 "title": "Example usage:",
6121 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6125 "name": "getJscriptySessions",
6126 "group": "Cm_Contacts",
6127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6129 "filename": "server/api/cmContact/index.js",
6130 "groupTitle": "Cm_Contacts"
6134 "url": "/api/cm/contacts/{id}/tags",
6135 "title": "Gets configurations tags",
6138 "title": "Example usage:",
6139 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6144 "group": "Cm_Contacts",
6145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6147 "filename": "server/api/cmContact/index.js",
6148 "groupTitle": "Cm_Contacts"
6152 "url": "/api/cm/contacts/merge",
6153 "title": "Merge Contact",
6156 "title": "Example usage:",
6157 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6162 "group": "Cm_Contacts",
6163 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6165 "filename": "server/api/cmContact/index.js",
6166 "groupTitle": "Cm_Contacts"
6170 "url": "/api/cm/contacts/{id}/tags",
6171 "title": "Sets new tags",
6174 "title": "Example usage:",
6175 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6180 "group": "Cm_Contacts",
6181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6183 "filename": "server/api/cmContact/index.js",
6184 "groupTitle": "Cm_Contacts"
6188 "url": "/api/cm/contacts/{id}",
6189 "title": "Gets a single Contact",
6192 "title": "Example usage:",
6193 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6198 "group": "Cm_Contacts",
6199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6201 "filename": "server/api/cmContact/index.js",
6202 "groupTitle": "Cm_Contacts"
6206 "url": "/api/cm/contacts/{id}",
6207 "title": "Update a single Contact",
6210 "title": "Example usage:",
6211 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6216 "group": "Cm_Contacts",
6217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6219 "filename": "server/api/cmContact/index.js",
6220 "groupTitle": "Cm_Contacts"
6224 "url": "/api/cm/custom_fields/{id}",
6225 "title": "Deletes a Custom Field",
6228 "title": "Example usage:",
6229 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6233 "name": "DeleteCustom_Fields",
6234 "group": "Cm_Custom_Fields",
6235 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6237 "filename": "server/api/cmCustomField/index.js",
6238 "groupTitle": "Cm_Custom_Fields"
6242 "url": "/api/cm/custom_fields",
6243 "title": "Gets a list of Custom Fields",
6246 "title": "Example usage:",
6247 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6251 "name": "GetCustom_Fields",
6252 "group": "Cm_Custom_Fields",
6253 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6255 "filename": "server/api/cmCustomField/index.js",
6256 "groupTitle": "Cm_Custom_Fields"
6260 "url": "/api/cm/custom_fields/{id}",
6261 "title": "Gets a single Custom Field",
6264 "title": "Example usage:",
6265 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6269 "name": "ShowCustom_Fields",
6270 "group": "Cm_Custom_Fields",
6271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6273 "filename": "server/api/cmCustomField/index.js",
6274 "groupTitle": "Cm_Custom_Fields"
6278 "url": "/api/cm/custom_fields/{id}",
6279 "title": "Update an existing Custom Field",
6282 "title": "Example usage:",
6283 "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",
6287 "name": "updateCustom_Fields",
6288 "group": "Cm_Custom_Fields",
6289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6291 "filename": "server/api/cmCustomField/index.js",
6292 "groupTitle": "Cm_Custom_Fields"
6296 "url": "/api/cm/hopper",
6297 "title": "Creates a new Hopper",
6300 "title": "Example usage:",
6301 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6305 "name": "CreateHopper",
6306 "group": "Cm_Hopper",
6328 "field": "scheduledat",
6335 "field": "countbusyretry",
6342 "field": "countcongestionretry",
6349 "field": "countnoanswerretry",
6356 "field": "callback",
6363 "field": "callbackuniqueid",
6370 "field": "callbackat",
6377 "field": "priority",
6384 "field": "recallme",
6391 "field": "ContactId",
6412 "field": "VoiceQueueId",
6419 "field": "CampaignId",
6426 "field": "countnosuchnumberretry",
6433 "field": "countdropretry",
6440 "field": "countabandonedretry",
6447 "field": "countmachineretry",
6454 "field": "countagentrejectretry",
6460 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6462 "filename": "server/api/cmHopper/index.js",
6463 "groupTitle": "Cm_Hopper"
6467 "url": "/api/cm/hopper/describe",
6468 "title": "Gets table info about Hopper",
6471 "title": "Example usage:",
6472 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6476 "name": "DescribeHopper",
6477 "group": "Cm_Hopper",
6478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6480 "filename": "server/api/cmHopper/index.js",
6481 "groupTitle": "Cm_Hopper"
6485 "url": "/api/cm/hopper",
6486 "title": "Gets a list of Hopper",
6489 "title": "Example usage:",
6490 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6494 "name": "GetHopper",
6495 "group": "Cm_Hopper",
6496 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6498 "filename": "server/api/cmHopper/index.js",
6499 "groupTitle": "Cm_Hopper"
6503 "url": "/api/cm/hopper/{id}",
6504 "title": "Gets a single Hopper",
6507 "title": "Example usage:",
6508 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6512 "name": "ShowHopper",
6513 "group": "Cm_Hopper",
6514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6516 "filename": "server/api/cmHopper/index.js",
6517 "groupTitle": "Cm_Hopper"
6521 "url": "/api/cm/hopper_black/{id}",
6522 "title": "Deletes a Hopper Black",
6525 "title": "Example usage:",
6526 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6530 "name": "DeleteHopper_Black",
6531 "group": "Cm_Hopper_Black",
6532 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6534 "filename": "server/api/cmHopperBlack/index.js",
6535 "groupTitle": "Cm_Hopper_Black"
6539 "url": "/api/cm/hopper_black/describe",
6540 "title": "Gets table info about Hopper Black",
6543 "title": "Example usage:",
6544 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6548 "name": "DescribeHopper_Black",
6549 "group": "Cm_Hopper_Black",
6550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6552 "filename": "server/api/cmHopperBlack/index.js",
6553 "groupTitle": "Cm_Hopper_Black"
6557 "url": "/api/cm/hopper_black",
6558 "title": "Gets a list of Hopper Black",
6561 "title": "Example usage:",
6562 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6566 "name": "GetHopper_Black",
6567 "group": "Cm_Hopper_Black",
6568 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6570 "filename": "server/api/cmHopperBlack/index.js",
6571 "groupTitle": "Cm_Hopper_Black"
6575 "url": "/api/cm/hopper_black/{id}",
6576 "title": "Gets a single Hopper Black",
6579 "title": "Example usage:",
6580 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6584 "name": "ShowHopper_Black",
6585 "group": "Cm_Hopper_Black",
6586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6588 "filename": "server/api/cmHopperBlack/index.js",
6589 "groupTitle": "Cm_Hopper_Black"
6593 "url": "/api/cm/hopper_black/{id}",
6594 "title": "Update an existing Hopper Black",
6597 "title": "Example usage:",
6598 "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",
6602 "name": "updateHopper_Black",
6603 "group": "Cm_Hopper_Black",
6604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6606 "filename": "server/api/cmHopperBlack/index.js",
6607 "groupTitle": "Cm_Hopper_Black"
6611 "url": "/api/cm/hopper_final/checkContactHopper",
6612 "title": "Check if contact is in hopper",
6615 "title": "Example usage:",
6616 "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",
6620 "name": "/checkContactHopper",
6621 "group": "Cm_Hopper_Final",
6622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6624 "filename": "server/api/cmHopperFinal/index.js",
6625 "groupTitle": "Cm_Hopper_Final"
6629 "url": "/api/cm/hopper_final/describe",
6630 "title": "Gets table info about HopperFinal",
6633 "title": "Example usage:",
6634 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6638 "name": "DescribeHopperFinal",
6639 "group": "Cm_Hopper_Final",
6640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6642 "filename": "server/api/cmHopperFinal/index.js",
6643 "groupTitle": "Cm_Hopper_Final"
6647 "url": "/api/cm/hopper_final",
6648 "title": "Gets a list of HopperFinal",
6651 "title": "Example usage:",
6652 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6656 "name": "GetHopperFinal",
6657 "group": "Cm_Hopper_Final",
6658 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6660 "filename": "server/api/cmHopperFinal/index.js",
6661 "groupTitle": "Cm_Hopper_Final"
6665 "url": "/api/cm/hopper_final/{id}",
6666 "title": "Gets a single HopperFinal",
6669 "title": "Example usage:",
6670 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6674 "name": "ShowHopperFinal",
6675 "group": "Cm_Hopper_Final",
6676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6678 "filename": "server/api/cmHopperFinal/index.js",
6679 "groupTitle": "Cm_Hopper_Final"
6683 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6684 "title": "Return number contacts for attributes",
6687 "title": "Example usage:",
6688 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6692 "name": "countContactsIvrCampaignHopperFinal",
6693 "group": "Cm_Hopper_Final",
6694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6696 "filename": "server/api/cmHopperFinal/index.js",
6697 "groupTitle": "Cm_Hopper_Final"
6701 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6702 "title": "Return number contacts for attributes",
6705 "title": "Example usage:",
6706 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6710 "name": "countContactsQueueCampaignHopperFinal",
6711 "group": "Cm_Hopper_Final",
6712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6714 "filename": "server/api/cmHopperFinal/index.js",
6715 "groupTitle": "Cm_Hopper_Final"
6719 "url": "/api/cm/hopper_final/campaign/{id}",
6720 "title": "Move contacts in hopper",
6723 "title": "Example usage:",
6724 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6728 "name": "moveContactsIvrCampaignHopperFinal",
6729 "group": "Cm_Hopper_Final",
6730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6732 "filename": "server/api/cmHopperFinal/index.js",
6733 "groupTitle": "Cm_Hopper_Final"
6737 "url": "/api/cm/hopper_final/voice/queue/{id}",
6738 "title": "Move contacts in hopper",
6741 "title": "Example usage:",
6742 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6746 "name": "moveContactsQueueCampaignHopperFinal",
6747 "group": "Cm_Hopper_Final",
6748 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6750 "filename": "server/api/cmHopperFinal/index.js",
6751 "groupTitle": "Cm_Hopper_Final"
6755 "url": "/api/cm/hopper_final/{id}",
6756 "title": "Update a single hopper final",
6759 "title": "Example usage:",
6760 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6765 "group": "Cm_Hopper_Final",
6766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6768 "filename": "server/api/cmHopperFinal/index.js",
6769 "groupTitle": "Cm_Hopper_Final"
6773 "url": "/api/cm/hopper_history",
6774 "title": "Creates a new HopperHistory",
6777 "title": "Example usage:",
6778 "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",
6782 "name": "CreateHopperHistory",
6783 "group": "Cm_Hopper_History",
6798 "field": "statedesc",
6805 "field": "scheduledat",
6812 "field": "countbusyretry",
6819 "field": "countcongestionretry",
6826 "field": "countnoanswerretry",
6833 "field": "countglobal",
6840 "field": "uniqueid",
6847 "field": "originatecalleridnum",
6854 "field": "originatecalleridname",
6861 "field": "calleridnum",
6868 "field": "calleridname",
6875 "field": "starttime",
6882 "field": "responsetime",
6889 "field": "answertime",
6896 "field": "droptime",
6910 "field": "ringtime",
6917 "field": "holdtime",
6924 "field": "talktime",
6931 "field": "followuptime",
6938 "field": "dropreason",
6945 "field": "campaign",
6952 "field": "campaigntype",
6959 "field": "membername",
6987 "field": "callback",
6994 "field": "callbackuniqueid",
7001 "field": "callbackat",
7008 "field": "recallme",
7015 "field": "editedat",
7029 "field": "countnosuchnumberretry",
7036 "field": "countdropretry",
7043 "field": "countabandonedretry",
7050 "field": "countmachineretry",
7057 "field": "countagentrejectretry",
7063 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7065 "filename": "server/api/cmHopperHistory/index.js",
7066 "groupTitle": "Cm_Hopper_History"
7070 "url": "/api/cm/hopper_history/describe",
7071 "title": "Gets table info about HopperHistory",
7074 "title": "Example usage:",
7075 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7079 "name": "DescribeHopperHistory",
7080 "group": "Cm_Hopper_History",
7081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7083 "filename": "server/api/cmHopperHistory/index.js",
7084 "groupTitle": "Cm_Hopper_History"
7088 "url": "/api/cm/hopper_history",
7089 "title": "Gets a list of HopperHistory",
7092 "title": "Example usage:",
7093 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7097 "name": "GetHopperHistory",
7098 "group": "Cm_Hopper_History",
7099 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7101 "filename": "server/api/cmHopperHistory/index.js",
7102 "groupTitle": "Cm_Hopper_History"
7106 "url": "/api/cm/hopper_history/{id}",
7107 "title": "Gets a single HopperHistory",
7110 "title": "Example usage:",
7111 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7115 "name": "ShowHopperHistory",
7116 "group": "Cm_Hopper_History",
7117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7119 "filename": "server/api/cmHopperHistory/index.js",
7120 "groupTitle": "Cm_Hopper_History"
7124 "url": "/api/cm/hopper_history/{id}",
7125 "title": "Update a single hopper history",
7128 "title": "Example usage:",
7129 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7134 "group": "Cm_Hopper_History",
7135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7137 "filename": "server/api/cmHopperHistory/index.js",
7138 "groupTitle": "Cm_Hopper_History"
7142 "url": "/api/cm/hopper/{id}",
7143 "title": "Delete Hopper",
7146 "title": "Example usage:",
7147 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7152 "group": "Cm_Hopper",
7153 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7155 "filename": "server/api/cmHopper/index.js",
7156 "groupTitle": "Cm_Hopper"
7160 "url": "/api/cm/hopper/opencontacts",
7161 "title": "Gets Open Contacts",
7164 "title": "Example usage:",
7165 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7169 "name": "getOpenContacts",
7170 "group": "Cm_Hopper",
7171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7173 "filename": "server/api/cmHopper/index.js",
7174 "groupTitle": "Cm_Hopper"
7178 "url": "/api/cm/hopper/preview",
7179 "title": "Gets Preview Dialer Contacts",
7182 "title": "Example usage:",
7183 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7187 "name": "getPreview",
7188 "group": "Cm_Hopper",
7189 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7191 "filename": "server/api/cmHopper/index.js",
7192 "groupTitle": "Cm_Hopper"
7196 "url": "/api/cm/hopper/{id}",
7197 "title": "Update an existing Hopper",
7200 "title": "Example usage:",
7201 "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",
7205 "name": "updateHopper",
7206 "group": "Cm_Hopper",
7207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7209 "filename": "server/api/cmHopper/index.js",
7210 "groupTitle": "Cm_Hopper"
7214 "url": "/api/cm/lists",
7215 "title": "Creates a new List",
7218 "title": "Example usage:",
7219 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7223 "name": "CreateLists",
7224 "group": "Cm_Lists",
7239 "field": "description",
7246 "field": "dialPrefix",
7252 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7254 "filename": "server/api/cmList/index.js",
7255 "groupTitle": "Cm_Lists"
7259 "url": "/api/cm/lists/{id}",
7260 "title": "Deletes a List",
7263 "title": "Example usage:",
7264 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7268 "name": "DeleteLists",
7269 "group": "Cm_Lists",
7270 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7272 "filename": "server/api/cmList/index.js",
7273 "groupTitle": "Cm_Lists"
7277 "url": "/api/cm/lists/describe",
7278 "title": "Gets table info about Lists",
7281 "title": "Example usage:",
7282 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7286 "name": "DescribeLists",
7287 "group": "Cm_Lists",
7288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7290 "filename": "server/api/cmList/index.js",
7291 "groupTitle": "Cm_Lists"
7295 "url": "/api/cm/lists/{id}/users",
7296 "title": "Gets agents from list",
7299 "title": "Example usage:",
7300 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7304 "name": "GetAgents",
7305 "group": "Cm_Lists",
7306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7308 "filename": "server/api/cmList/index.js",
7309 "groupTitle": "Cm_Lists"
7313 "url": "/api/cm/lists",
7314 "title": "Gets a list of Lists",
7317 "title": "Example usage:",
7318 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7323 "group": "Cm_Lists",
7324 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7326 "filename": "server/api/cmList/index.js",
7327 "groupTitle": "Cm_Lists"
7331 "url": "/api/cm/lists/{id}/users",
7332 "title": "Removes agents from a list",
7335 "title": "Example usage:",
7336 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7340 "name": "RemoveAgents",
7341 "group": "Cm_Lists",
7342 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7344 "filename": "server/api/cmList/index.js",
7345 "groupTitle": "Cm_Lists"
7349 "url": "/api/cm/lists/{id}/dispositions",
7350 "title": "Removes dispositions from account",
7353 "title": "Example usage:",
7354 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7358 "name": "RemoveDispositions",
7359 "group": "Cm_Lists",
7360 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7362 "filename": "server/api/cmList/index.js",
7363 "groupTitle": "Cm_Lists"
7367 "url": "/api/cm/lists/{id}",
7368 "title": "Gets a single List",
7371 "title": "Example usage:",
7372 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7376 "name": "ShowLists",
7377 "group": "Cm_Lists",
7378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7380 "filename": "server/api/cmList/index.js",
7381 "groupTitle": "Cm_Lists"
7385 "url": "/api/cm/lists/{id}/users",
7386 "title": "Adds agents to a list",
7389 "title": "Example usage:",
7390 "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",
7394 "name": "addAgents",
7395 "group": "Cm_Lists",
7396 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7398 "filename": "server/api/cmList/index.js",
7399 "groupTitle": "Cm_Lists"
7403 "url": "/api/cm/lists/{id}/contacts",
7404 "title": "Creates new contacts",
7407 "title": "Example usage:",
7408 "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",
7412 "name": "addContacts",
7413 "group": "Cm_Lists",
7421 "field": "firstName",
7428 "field": "lastName",
7442 "field": "postalCode",
7463 "field": "dateOfBirth",
7470 "field": "description",
7512 "field": "facebook",
7568 "field": "telegram",
7582 "field": "priority",
7589 "field": "scheduledat",
7595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7597 "filename": "server/api/cmList/index.js",
7598 "groupTitle": "Cm_Lists"
7602 "url": "/api/cm/lists/{id}/fields",
7603 "title": "Creates a new custom field",
7606 "title": "Example usage:",
7607 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7611 "name": "addCustomField",
7612 "group": "Cm_Lists",
7613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7615 "filename": "server/api/cmList/index.js",
7616 "groupTitle": "Cm_Lists"
7620 "url": "/api/cm/lists/{id}/dispositions",
7621 "title": "Creates new disposition",
7624 "title": "Example usage:",
7625 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7629 "name": "addDisposition",
7630 "group": "Cm_Lists",
7657 "field": "description",
7663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7665 "filename": "server/api/cmList/index.js",
7666 "groupTitle": "Cm_Lists"
7670 "url": "/api/cm/lists/{id}/contacts",
7671 "title": "Gets List Contacts",
7674 "title": "Example usage:",
7675 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7679 "name": "getContacts",
7680 "group": "Cm_Lists",
7681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7683 "filename": "server/api/cmList/index.js",
7684 "groupTitle": "Cm_Lists"
7688 "url": "/api/cm/lists/{id}/fields",
7689 "title": "Gets Custom Fields",
7692 "title": "Example usage:",
7693 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7697 "name": "getCustomFields",
7698 "group": "Cm_Lists",
7699 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7701 "filename": "server/api/cmList/index.js",
7702 "groupTitle": "Cm_Lists"
7706 "url": "/api/cm/lists/{id}/dispositions",
7707 "title": "Gets list dispositions",
7710 "title": "Example usage:",
7711 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7715 "name": "getDispositions",
7716 "group": "Cm_Lists",
7717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7719 "filename": "server/api/cmList/index.js",
7720 "groupTitle": "Cm_Lists"
7724 "url": "/api/cm/lists/{id}/contacts/csv",
7725 "title": "Gets CSV List Contacts",
7728 "title": "Example usage:",
7729 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7734 "group": "Cm_Lists",
7735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7737 "filename": "server/api/cmList/index.js",
7738 "groupTitle": "Cm_Lists"
7742 "url": "/api/cm/lists/{id}",
7743 "title": "Update an existing List",
7746 "title": "Example usage:",
7747 "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",
7751 "name": "updateLists",
7752 "group": "Cm_Lists",
7753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7755 "filename": "server/api/cmList/index.js",
7756 "groupTitle": "Cm_Lists"
7760 "url": "/api/cm/contacts/upload/:id",
7761 "title": "Import new contacts by csv",
7764 "title": "Example usage:",
7765 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7770 "group": "Cm_contacts",
7771 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7773 "filename": "server/api/cmContact/index.js",
7774 "groupTitle": "Cm_contacts"
7778 "url": "/api/cm/contacts/upload",
7779 "title": "Upload csv",
7782 "title": "Example usage:",
7783 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7788 "group": "Cm_contacts",
7789 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7791 "filename": "server/api/cmContact/index.js",
7792 "groupTitle": "Cm_contacts"
7796 "url": "/api/cm/contacts/csv",
7797 "title": "Create new contacts by csv",
7800 "title": "Example usage:",
7801 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7805 "name": "uploadCsv",
7806 "group": "Cm_contacts",
7807 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7809 "filename": "server/api/cmContact/index.js",
7810 "groupTitle": "Cm_contacts"
7814 "url": "/api/conditions/{id}",
7815 "title": "Deletes a Condition",
7818 "title": "Example usage:",
7819 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7823 "name": "DeleteConditions",
7824 "group": "Conditions",
7825 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7827 "filename": "server/api/condition/index.js",
7828 "groupTitle": "Conditions"
7832 "url": "/api/conditions/{id}",
7833 "title": "Update an existing Condition",
7836 "title": "Example usage:",
7837 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7841 "name": "updateConditions",
7842 "group": "Conditions",
7843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7845 "filename": "server/api/condition/index.js",
7846 "groupTitle": "Conditions"
7850 "url": "/api/cm/custom_field",
7851 "title": "Create a new custom field",
7854 "title": "Example usage:",
7855 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7859 "name": "CreateCustomField",
7860 "group": "Custom_Fields",
7861 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7863 "filename": "server/api/cmCustomField/index.js",
7864 "groupTitle": "Custom_Fields"
7868 "url": "/api/dashboards/items",
7869 "title": "Create dasboard item",
7872 "title": "Example usage:",
7873 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7878 "group": "Dashboard_Items",
7879 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7881 "filename": "server/api/dashboardItem/index.js",
7882 "groupTitle": "Dashboard_Items"
7886 "url": "/api/dashboards/items/{id}",
7887 "title": "Deletes a Dashboard Item",
7890 "title": "Example usage:",
7891 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7895 "name": "DeleteDashboard_Items",
7896 "group": "Dashboard_Items",
7897 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7899 "filename": "server/api/dashboardItem/index.js",
7900 "groupTitle": "Dashboard_Items"
7904 "url": "/api/dashboards/items/{id}",
7905 "title": "Gets a single Dashboard Item",
7908 "title": "Example usage:",
7909 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7913 "name": "ShowDashboard_Items",
7914 "group": "Dashboard_Items",
7915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7917 "filename": "server/api/dashboardItem/index.js",
7918 "groupTitle": "Dashboard_Items"
7922 "url": "/api/dashboards/items/{id}",
7923 "title": "Update an existing item",
7926 "title": "Example usage:",
7927 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7932 "group": "Dashboard_Items",
7933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7935 "filename": "server/api/dashboardItem/index.js",
7936 "groupTitle": "Dashboard_Items"
7940 "url": "/api/dashboards/clone",
7941 "title": "Clone an existing Dashboard",
7944 "title": "Example usage:",
7945 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7949 "name": "CloneDashboards",
7950 "group": "Dashboards",
7951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7953 "filename": "server/api/dashboard/index.js",
7954 "groupTitle": "Dashboards"
7958 "url": "/api/dashboards",
7959 "title": "Creates a new Dashboard",
7962 "title": "Example usage:",
7963 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7967 "name": "CreateDashboards",
7968 "group": "Dashboards",
7983 "field": "description",
7989 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7991 "filename": "server/api/dashboard/index.js",
7992 "groupTitle": "Dashboards"
7996 "url": "/api/dashboards/{id}",
7997 "title": "Deletes a Dashboard",
8000 "title": "Example usage:",
8001 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8005 "name": "DeleteDashboards",
8006 "group": "Dashboards",
8007 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8009 "filename": "server/api/dashboard/index.js",
8010 "groupTitle": "Dashboards"
8014 "url": "/api/dashboards",
8015 "title": "Gets a list of Dashboards",
8018 "title": "Example usage:",
8019 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8023 "name": "GetDashboards",
8024 "group": "Dashboards",
8025 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8027 "filename": "server/api/dashboard/index.js",
8028 "groupTitle": "Dashboards"
8032 "url": "/api/dashboards/{id}",
8033 "title": "Gets a single Dashboard",
8036 "title": "Example usage:",
8037 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8041 "name": "ShowDashboards",
8042 "group": "Dashboards",
8043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8045 "filename": "server/api/dashboard/index.js",
8046 "groupTitle": "Dashboards"
8050 "url": "/api/dashboards/{id}/items",
8051 "title": "Creates new item",
8054 "title": "Example usage:",
8055 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8060 "group": "Dashboards",
8061 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8063 "filename": "server/api/dashboard/index.js",
8064 "groupTitle": "Dashboards"
8068 "url": "/api/dashboards/{id}/items",
8069 "title": "Gets items",
8072 "title": "Example usage:",
8073 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8078 "group": "Dashboards",
8079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8081 "filename": "server/api/dashboard/index.js",
8082 "groupTitle": "Dashboards"
8086 "url": "/api/dashboards/{id}",
8087 "title": "Update an existing Dashboard",
8090 "title": "Example usage:",
8091 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8095 "name": "updateDashboards",
8096 "group": "Dashboards",
8097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8099 "filename": "server/api/dashboard/index.js",
8100 "groupTitle": "Dashboards"
8104 "url": "/api/integrations/desk/accounts",
8105 "title": "Creates a new Desk Account",
8108 "title": "Example usage:",
8109 "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",
8113 "name": "CreateDesk_Accounts",
8114 "group": "Desk_Accounts",
8129 "field": "description",
8136 "field": "username",
8143 "field": "remoteUri",
8153 "field": "authType",
8160 "field": "password",
8167 "field": "consumerKey",
8174 "field": "consumerSecret",
8188 "field": "tokenSecret",
8195 "field": "serverUrl",
8202 "\"integrationTab\"",
8212 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8214 "filename": "server/api/intDeskAccount/index.js",
8215 "groupTitle": "Desk_Accounts"
8219 "url": "/api/integrations/desk/accounts/{id}",
8220 "title": "Deletes a Desk Account",
8223 "title": "Example usage:",
8224 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8228 "name": "DeleteDesk_Accounts",
8229 "group": "Desk_Accounts",
8230 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8232 "filename": "server/api/intDeskAccount/index.js",
8233 "groupTitle": "Desk_Accounts"
8237 "url": "/api/integrations/desk/accounts",
8238 "title": "Gets a list of Desk Accounts",
8241 "title": "Example usage:",
8242 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8246 "name": "GetDesk_Accounts",
8247 "group": "Desk_Accounts",
8248 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8250 "filename": "server/api/intDeskAccount/index.js",
8251 "groupTitle": "Desk_Accounts"
8255 "url": "/api/integrations/desk/accounts/{id}",
8256 "title": "Gets a single Desk Account",
8259 "title": "Example usage:",
8260 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8264 "name": "ShowDesk_Accounts",
8265 "group": "Desk_Accounts",
8266 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8268 "filename": "server/api/intDeskAccount/index.js",
8269 "groupTitle": "Desk_Accounts"
8273 "url": "/api/integrations/desk/accounts/{id}/configurations",
8274 "title": "Creates new configuration",
8277 "title": "Example usage:",
8278 "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",
8282 "name": "addConfiguration",
8283 "group": "Desk_Accounts",
8284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8286 "filename": "server/api/intDeskAccount/index.js",
8287 "groupTitle": "Desk_Accounts"
8291 "url": "/api/integrations/desk/accounts/{id}/configurations",
8292 "title": "Gets account configurations",
8295 "title": "Example usage:",
8296 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8300 "name": "getConfigurations",
8301 "group": "Desk_Accounts",
8302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8304 "filename": "server/api/intDeskAccount/index.js",
8305 "groupTitle": "Desk_Accounts"
8309 "url": "/api/integrations/desk/accounts/{id}/fields",
8310 "title": "Gets account fields",
8313 "title": "Example usage:",
8314 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8318 "name": "getFields",
8319 "group": "Desk_Accounts",
8320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8322 "filename": "server/api/intDeskAccount/index.js",
8323 "groupTitle": "Desk_Accounts"
8327 "url": "/api/integrations/desk/accounts/{id}",
8328 "title": "Update an existing Desk Account",
8331 "title": "Example usage:",
8332 "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",
8336 "name": "updateDesk_Accounts",
8337 "group": "Desk_Accounts",
8338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8340 "filename": "server/api/intDeskAccount/index.js",
8341 "groupTitle": "Desk_Accounts"
8345 "url": "/api/integrations/desk/configurations",
8346 "title": "Creates a new Desk Configuration",
8349 "title": "Example usage:",
8350 "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",
8354 "name": "CreateDesk_Configurations",
8355 "group": "Desk_Configurations",
8370 "field": "description",
8376 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8378 "filename": "server/api/intDeskConfiguration/index.js",
8379 "groupTitle": "Desk_Configurations"
8383 "url": "/api/integrations/desk/configurations/{id}",
8384 "title": "Deletes a Desk Configuration",
8387 "title": "Example usage:",
8388 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8392 "name": "DeleteDesk_Configurations",
8393 "group": "Desk_Configurations",
8394 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8396 "filename": "server/api/intDeskConfiguration/index.js",
8397 "groupTitle": "Desk_Configurations"
8401 "url": "/api/integrations/desk/configurations",
8402 "title": "Gets a list of Desk Configurations",
8405 "title": "Example usage:",
8406 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8410 "name": "GetDesk_Configurations",
8411 "group": "Desk_Configurations",
8412 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8414 "filename": "server/api/intDeskConfiguration/index.js",
8415 "groupTitle": "Desk_Configurations"
8419 "url": "/api/integrations/desk/configurations/{id}",
8420 "title": "Gets a single Desk Configuration",
8423 "title": "Example usage:",
8424 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8428 "name": "ShowDesk_Configurations",
8429 "group": "Desk_Configurations",
8430 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8432 "filename": "server/api/intDeskConfiguration/index.js",
8433 "groupTitle": "Desk_Configurations"
8437 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8438 "title": "Gets configurations descriptions",
8441 "title": "Example usage:",
8442 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8446 "name": "getDescriptions",
8447 "group": "Desk_Configurations",
8448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8450 "filename": "server/api/intDeskConfiguration/index.js",
8451 "groupTitle": "Desk_Configurations"
8455 "url": "/api/integrations/desk/configurations/{id}/fields",
8456 "title": "Gets configurations fields",
8459 "title": "Example usage:",
8460 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8464 "name": "getFields",
8465 "group": "Desk_Configurations",
8466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8468 "filename": "server/api/intDeskConfiguration/index.js",
8469 "groupTitle": "Desk_Configurations"
8473 "url": "/api/integrations/desk/configurations/{id}/subjects",
8474 "title": "Gets configurations subjects",
8477 "title": "Example usage:",
8478 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8482 "name": "getSubjects",
8483 "group": "Desk_Configurations",
8484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8486 "filename": "server/api/intDeskConfiguration/index.js",
8487 "groupTitle": "Desk_Configurations"
8491 "url": "/api/integrations/desk/configurations/{id}/tags",
8492 "title": "Gets configurations tags",
8495 "title": "Example usage:",
8496 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8501 "group": "Desk_Configurations",
8502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8504 "filename": "server/api/intDeskConfiguration/index.js",
8505 "groupTitle": "Desk_Configurations"
8509 "url": "/api/integrations/desk/configurations/{id}/tags",
8510 "title": "Sets new tags",
8513 "title": "Example usage:",
8514 "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",
8519 "group": "Desk_Configurations",
8520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8522 "filename": "server/api/intDeskConfiguration/index.js",
8523 "groupTitle": "Desk_Configurations"
8527 "url": "/api/integrations/desk/configurations/{id}",
8528 "title": "Update an existing Desk Configuration",
8531 "title": "Example usage:",
8532 "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",
8536 "name": "updateDesk_Configurations",
8537 "group": "Desk_Configurations",
8538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8540 "filename": "server/api/intDeskConfiguration/index.js",
8541 "groupTitle": "Desk_Configurations"
8545 "url": "/api/integrations/desk/fields",
8546 "title": "Creates a new Desk Field",
8549 "title": "Example usage:",
8550 "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",
8554 "name": "CreateDesk_Fields",
8555 "group": "Desk_Fields",
8565 "\"customVariable\"",
8593 "\"customVariable\""
8603 "field": "keyContent",
8617 "field": "nameField",
8624 "field": "customField",
8631 "field": "variableName",
8637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8639 "filename": "server/api/intDeskField/index.js",
8640 "groupTitle": "Desk_Fields"
8644 "url": "/api/integrations/desk/fields/{id}",
8645 "title": "Deletes a Desk Field",
8648 "title": "Example usage:",
8649 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8653 "name": "DeleteDesk_Fields",
8654 "group": "Desk_Fields",
8655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8657 "filename": "server/api/intDeskField/index.js",
8658 "groupTitle": "Desk_Fields"
8662 "url": "/api/integrations/desk/fields",
8663 "title": "Gets a list of Desk Fields",
8666 "title": "Example usage:",
8667 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8671 "name": "GetDesk_Fields",
8672 "group": "Desk_Fields",
8673 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8675 "filename": "server/api/intDeskField/index.js",
8676 "groupTitle": "Desk_Fields"
8680 "url": "/api/integrations/desk/fields/{id}",
8681 "title": "Gets a single Desk Field",
8684 "title": "Example usage:",
8685 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8689 "name": "ShowDesk_Fields",
8690 "group": "Desk_Fields",
8691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8693 "filename": "server/api/intDeskField/index.js",
8694 "groupTitle": "Desk_Fields"
8698 "url": "/api/integrations/desk/fields/{id}",
8699 "title": "Update an existing Desk Field",
8702 "title": "Example usage:",
8703 "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",
8707 "name": "updateDesk_Fields",
8708 "group": "Desk_Fields",
8709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8711 "filename": "server/api/intDeskField/index.js",
8712 "groupTitle": "Desk_Fields"
8716 "url": "/api/dispositions",
8717 "title": "Creates a new Disposition",
8720 "title": "Example usage:",
8721 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8725 "name": "CreateDispositions",
8726 "group": "Dispositions",
8753 "field": "description",
8759 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8761 "filename": "server/api/disposition/index.js",
8762 "groupTitle": "Dispositions"
8766 "url": "/api/dispositions/{id}",
8767 "title": "Deletes a Disposition",
8770 "title": "Example usage:",
8771 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8775 "name": "DeleteDispositions",
8776 "group": "Dispositions",
8777 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8779 "filename": "server/api/disposition/index.js",
8780 "groupTitle": "Dispositions"
8784 "url": "/api/dispositions",
8785 "title": "Gets a list of Dispositions",
8788 "title": "Example usage:",
8789 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8793 "name": "GetDispositions",
8794 "group": "Dispositions",
8795 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8797 "filename": "server/api/disposition/index.js",
8798 "groupTitle": "Dispositions"
8802 "url": "/api/dispositions/{id}",
8803 "title": "Gets a single Disposition",
8806 "title": "Example usage:",
8807 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8811 "name": "ShowDispositions",
8812 "group": "Dispositions",
8813 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8815 "filename": "server/api/disposition/index.js",
8816 "groupTitle": "Dispositions"
8820 "url": "/api/dispositions/{id}",
8821 "title": "Update an existing Disposition",
8824 "title": "Example usage:",
8825 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8829 "name": "updateDispositions",
8830 "group": "Dispositions",
8831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8833 "filename": "server/api/disposition/index.js",
8834 "groupTitle": "Dispositions"
8838 "url": "/api/integrations/dynamics365/accounts",
8839 "title": "Creates a new Dynamics365 Account",
8842 "title": "Example usage:",
8843 "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",
8847 "name": "CreateDynamics365_Accounts",
8848 "group": "Dynamics365_Accounts",
8863 "field": "username",
8870 "field": "password",
8877 "field": "remoteUri",
8884 "field": "tenantId",
8891 "field": "clientId",
8898 "field": "clientSecret",
8905 "field": "serverUrl",
8912 "field": "description",
8918 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8920 "filename": "server/api/intDynamics365Account/index.js",
8921 "groupTitle": "Dynamics365_Accounts"
8925 "url": "/api/integrations/dynamics365/accounts/{id}",
8926 "title": "Deletes a Dynamics365 Account",
8929 "title": "Example usage:",
8930 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8934 "name": "DeleteDynamics365_Accounts",
8935 "group": "Dynamics365_Accounts",
8936 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8938 "filename": "server/api/intDynamics365Account/index.js",
8939 "groupTitle": "Dynamics365_Accounts"
8943 "url": "/api/integrations/dynamics365/accounts",
8944 "title": "Gets a list of Dynamics365 Accounts",
8947 "title": "Example usage:",
8948 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8952 "name": "GetDynamics365_Accounts",
8953 "group": "Dynamics365_Accounts",
8954 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8956 "filename": "server/api/intDynamics365Account/index.js",
8957 "groupTitle": "Dynamics365_Accounts"
8961 "url": "/api/integrations/dynamics365/accounts/{id}",
8962 "title": "Gets a single Dynamics365 Account",
8965 "title": "Example usage:",
8966 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8970 "name": "ShowDynamics365_Accounts",
8971 "group": "Dynamics365_Accounts",
8972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8974 "filename": "server/api/intDynamics365Account/index.js",
8975 "groupTitle": "Dynamics365_Accounts"
8979 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8980 "title": "Creates new configuration",
8983 "title": "Example usage:",
8984 "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",
8988 "name": "addConfiguration",
8989 "group": "Dynamics365_Accounts",
8990 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8992 "filename": "server/api/intDynamics365Account/index.js",
8993 "groupTitle": "Dynamics365_Accounts"
8997 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8998 "title": "Gets account configurations",
9001 "title": "Example usage:",
9002 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9006 "name": "getConfigurations",
9007 "group": "Dynamics365_Accounts",
9008 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9010 "filename": "server/api/intDynamics365Account/index.js",
9011 "groupTitle": "Dynamics365_Accounts"
9015 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9016 "title": "Gets account fields",
9019 "title": "Example usage:",
9020 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9024 "name": "getFields",
9025 "group": "Dynamics365_Accounts",
9026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9028 "filename": "server/api/intDynamics365Account/index.js",
9029 "groupTitle": "Dynamics365_Accounts"
9033 "url": "/api/integrations/dynamics365/accounts/{id}",
9034 "title": "Update an existing Dynamics365 Account",
9037 "title": "Example usage:",
9038 "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",
9042 "name": "updateDynamics365_Accounts",
9043 "group": "Dynamics365_Accounts",
9044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9046 "filename": "server/api/intDynamics365Account/index.js",
9047 "groupTitle": "Dynamics365_Accounts"
9051 "url": "/api/integrations/dynamics365/configurations",
9052 "title": "Creates a new Dynamics365 Configuration",
9055 "title": "Example usage:",
9056 "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",
9060 "name": "CreateDynamics365_Configurations",
9061 "group": "Dynamics365_Configurations",
9076 "field": "description",
9087 "field": "ticketType",
9093 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9095 "filename": "server/api/intDynamics365Configuration/index.js",
9096 "groupTitle": "Dynamics365_Configurations"
9100 "url": "/api/integrations/dynamics365/configurations/{id}",
9101 "title": "Deletes a Dynamics365 Configuration",
9104 "title": "Example usage:",
9105 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9109 "name": "DeleteDynamics365_Configurations",
9110 "group": "Dynamics365_Configurations",
9111 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9113 "filename": "server/api/intDynamics365Configuration/index.js",
9114 "groupTitle": "Dynamics365_Configurations"
9118 "url": "/api/integrations/dynamics365/configurations",
9119 "title": "Gets a list of Dynamics365 Configurations",
9122 "title": "Example usage:",
9123 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9127 "name": "GetDynamics365_Configurations",
9128 "group": "Dynamics365_Configurations",
9129 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9131 "filename": "server/api/intDynamics365Configuration/index.js",
9132 "groupTitle": "Dynamics365_Configurations"
9136 "url": "/api/integrations/dynamics365/configurations/{id}",
9137 "title": "Gets a single Dynamics365 Configuration",
9140 "title": "Example usage:",
9141 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9145 "name": "ShowDynamics365_Configurations",
9146 "group": "Dynamics365_Configurations",
9147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9149 "filename": "server/api/intDynamics365Configuration/index.js",
9150 "groupTitle": "Dynamics365_Configurations"
9154 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9155 "title": "Gets configurations descriptions",
9158 "title": "Example usage:",
9159 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9163 "name": "getDescriptions",
9164 "group": "Dynamics365_Configurations",
9165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9167 "filename": "server/api/intDynamics365Configuration/index.js",
9168 "groupTitle": "Dynamics365_Configurations"
9172 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9173 "title": "Gets configurations fields",
9176 "title": "Example usage:",
9177 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9181 "name": "getFields",
9182 "group": "Dynamics365_Configurations",
9183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9185 "filename": "server/api/intDynamics365Configuration/index.js",
9186 "groupTitle": "Dynamics365_Configurations"
9190 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9191 "title": "Gets configurations subjects",
9194 "title": "Example usage:",
9195 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9199 "name": "getSubjects",
9200 "group": "Dynamics365_Configurations",
9201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9203 "filename": "server/api/intDynamics365Configuration/index.js",
9204 "groupTitle": "Dynamics365_Configurations"
9208 "url": "/api/integrations/dynamics365/configurations/{id}",
9209 "title": "Update an existing Dynamics365 Configuration",
9212 "title": "Example usage:",
9213 "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",
9217 "name": "updateDynamics365_Configurations",
9218 "group": "Dynamics365_Configurations",
9219 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9221 "filename": "server/api/intDynamics365Configuration/index.js",
9222 "groupTitle": "Dynamics365_Configurations"
9226 "url": "/api/integrations/dynamics365/fields",
9227 "title": "Creates a new Dynamics365 Field",
9230 "title": "Example usage:",
9231 "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",
9235 "name": "CreateDynamics365_Fields",
9236 "group": "Dynamics365_Fields",
9246 "\"customVariable\"",
9274 "\"customVariable\""
9284 "field": "keyContent",
9298 "field": "nameField",
9305 "field": "customField",
9312 "field": "variableName",
9318 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9320 "filename": "server/api/intDynamics365Field/index.js",
9321 "groupTitle": "Dynamics365_Fields"
9325 "url": "/api/integrations/dynamics365/fields/{id}",
9326 "title": "Deletes a Dynamics365 Field",
9329 "title": "Example usage:",
9330 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9334 "name": "DeleteDynamics365_Fields",
9335 "group": "Dynamics365_Fields",
9336 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9338 "filename": "server/api/intDynamics365Field/index.js",
9339 "groupTitle": "Dynamics365_Fields"
9343 "url": "/api/integrations/dynamics365/fields",
9344 "title": "Gets a list of Dynamics365 Fields",
9347 "title": "Example usage:",
9348 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9352 "name": "GetDynamics365_Fields",
9353 "group": "Dynamics365_Fields",
9354 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9356 "filename": "server/api/intDynamics365Field/index.js",
9357 "groupTitle": "Dynamics365_Fields"
9361 "url": "/api/integrations/dynamics365/fields/{id}",
9362 "title": "Gets a single Dynamics365 Field",
9365 "title": "Example usage:",
9366 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9370 "name": "ShowDynamics365_Fields",
9371 "group": "Dynamics365_Fields",
9372 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9374 "filename": "server/api/intDynamics365Field/index.js",
9375 "groupTitle": "Dynamics365_Fields"
9379 "url": "/api/integrations/dynamics365/fields/{id}",
9380 "title": "Update an existing Dynamics365 Field",
9383 "title": "Example usage:",
9384 "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",
9388 "name": "updateDynamics365_Fields",
9389 "group": "Dynamics365_Fields",
9390 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9392 "filename": "server/api/intDynamics365Field/index.js",
9393 "groupTitle": "Dynamics365_Fields"
9397 "url": "/api/fax/accounts/{id}/users",
9398 "title": "Add agents to a fax account",
9401 "title": "Example usage:",
9402 "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",
9406 "name": "AddAgents",
9407 "group": "Fax_Accounts",
9408 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9410 "filename": "server/api/faxAccount/index.js",
9411 "groupTitle": "Fax_Accounts"
9415 "url": "/api/fax/accounts",
9416 "title": "Creates a new Account",
9419 "title": "Example usage:",
9420 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9424 "name": "CreateAccounts",
9425 "group": "Fax_Accounts",
9440 "field": "description",
9458 "field": "headerinfo",
9465 "field": "localstationid",
9516 "field": "faxdetect",
9523 "field": "t38timeout",
9550 "field": "notificationTemplate",
9557 "field": "notificationSound",
9564 "field": "notificationShake",
9571 "field": "waitForTheAssignedAgent",
9578 "field": "queueTransfer",
9585 "field": "queueTransferTimeout",
9592 "field": "agentTransfer",
9599 "field": "agentTransferTimeout",
9606 "field": "mandatoryDispositionPauseId",
9607 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9613 "field": "mandatoryDisposition",
9614 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9621 "filename": "server/api/faxAccount/index.js",
9622 "groupTitle": "Fax_Accounts"
9626 "url": "/api/fax/accounts/{id}",
9627 "title": "Deletes a Account",
9630 "title": "Example usage:",
9631 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9635 "name": "DeleteAccounts",
9636 "group": "Fax_Accounts",
9637 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9639 "filename": "server/api/faxAccount/index.js",
9640 "groupTitle": "Fax_Accounts"
9644 "url": "/api/fax/accounts/describe",
9645 "title": "Gets table info about Accounts",
9648 "title": "Example usage:",
9649 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9653 "name": "DescribeAccounts",
9654 "group": "Fax_Accounts",
9655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9657 "filename": "server/api/faxAccount/index.js",
9658 "groupTitle": "Fax_Accounts"
9662 "url": "/api/fax/accounts",
9663 "title": "Gets a list of Accounts",
9666 "title": "Example usage:",
9667 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9671 "name": "GetAccounts",
9672 "group": "Fax_Accounts",
9673 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9675 "filename": "server/api/faxAccount/index.js",
9676 "groupTitle": "Fax_Accounts"
9680 "url": "/api/fax/accounts/{id}/users",
9681 "title": "Gets agents from fax account",
9684 "title": "Example usage:",
9685 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9689 "name": "GetAgents",
9690 "group": "Fax_Accounts",
9691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9693 "filename": "server/api/faxAccount/index.js",
9694 "groupTitle": "Fax_Accounts"
9698 "url": "/api/fax/accounts/{id}/users",
9699 "title": "Removes agents from a fax account",
9702 "title": "Example usage:",
9703 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9707 "name": "RemoveAgents",
9708 "group": "Fax_Accounts",
9709 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9711 "filename": "server/api/faxAccount/index.js",
9712 "groupTitle": "Fax_Accounts"
9716 "url": "/api/fax/accounts/{id}/canned_answers",
9717 "title": "Removes canned answers from account",
9720 "title": "Example usage:",
9721 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9725 "name": "RemoveAnswers",
9726 "group": "Fax_Accounts",
9727 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9729 "filename": "server/api/faxAccount/index.js",
9730 "groupTitle": "Fax_Accounts"
9734 "url": "/api/fax/accounts/{id}/dispositions",
9735 "title": "Removes dispositions from account",
9738 "title": "Example usage:",
9739 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9743 "name": "RemoveDispositions",
9744 "group": "Fax_Accounts",
9745 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9747 "filename": "server/api/faxAccount/index.js",
9748 "groupTitle": "Fax_Accounts"
9752 "url": "/api/fax/accounts/{id}",
9753 "title": "Gets a single Account",
9756 "title": "Example usage:",
9757 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9761 "name": "ShowAccounts",
9762 "group": "Fax_Accounts",
9763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9765 "filename": "server/api/faxAccount/index.js",
9766 "groupTitle": "Fax_Accounts"
9770 "url": "/api/fax/accounts/{id}/canned_answers",
9771 "title": "Creates new canned answer",
9774 "title": "Example usage:",
9775 "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",
9779 "name": "addAnswer",
9780 "group": "Fax_Accounts",
9802 "field": "description",
9815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9817 "filename": "server/api/faxAccount/index.js",
9818 "groupTitle": "Fax_Accounts"
9822 "url": "/api/fax/accounts/addaccountapplications",
9823 "title": "Creates new account and applications",
9826 "title": "Example usage:",
9827 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9831 "name": "addApplications",
9832 "group": "Fax_Accounts",
9840 "field": "priority",
9861 "field": "description",
9868 "field": "interval",
9874 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9876 "filename": "server/api/faxAccount/index.js",
9877 "groupTitle": "Fax_Accounts"
9881 "url": "/api/fax/accounts/{id}/applications",
9882 "title": "Creates new applications",
9885 "title": "Example usage:",
9886 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9890 "name": "addApplications",
9891 "group": "Fax_Accounts",
9899 "field": "priority",
9920 "field": "description",
9927 "field": "interval",
9933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9935 "filename": "server/api/faxAccount/index.js",
9936 "groupTitle": "Fax_Accounts"
9940 "url": "/api/fax/accounts/{id}/dispositions",
9941 "title": "Creates new disposition",
9944 "title": "Example usage:",
9945 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9949 "name": "addDisposition",
9950 "group": "Fax_Accounts",
9977 "field": "description",
9983 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9985 "filename": "server/api/faxAccount/index.js",
9986 "groupTitle": "Fax_Accounts"
9990 "url": "/api/fax/accounts/{id}/interactions",
9991 "title": "Creates new interactions",
9994 "title": "Example usage:",
9995 "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",
9999 "name": "addInteraction",
10000 "group": "Fax_Accounts",
10015 "field": "closedAt",
10022 "field": "disposition",
10029 "field": "secondDisposition",
10036 "field": "thirdDisposition",
10050 "field": "read1stAt",
10068 "field": "firstMsgDirection",
10075 "field": "lastMsgAt",
10086 "field": "lastMsgDirection",
10092 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10093 "version": "0.0.0",
10094 "filename": "server/api/faxAccount/index.js",
10095 "groupTitle": "Fax_Accounts"
10099 "url": "/api/fax/accounts/{id}/canned_answers",
10100 "title": "Gets account canned answers",
10103 "title": "Example usage:",
10104 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10108 "name": "getAnswers",
10109 "group": "Fax_Accounts",
10110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10111 "version": "0.0.0",
10112 "filename": "server/api/faxAccount/index.js",
10113 "groupTitle": "Fax_Accounts"
10117 "url": "/api/fax/accounts/{id}/applications",
10118 "title": "Gets account pplications",
10121 "title": "Example usage:",
10122 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10126 "name": "getApplications",
10127 "group": "Fax_Accounts",
10128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10129 "version": "0.0.0",
10130 "filename": "server/api/faxAccount/index.js",
10131 "groupTitle": "Fax_Accounts"
10135 "url": "/api/fax/accounts/{id}/dispositions",
10136 "title": "Gets account dispositions",
10139 "title": "Example usage:",
10140 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10144 "name": "getDispositions",
10145 "group": "Fax_Accounts",
10146 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10147 "version": "0.0.0",
10148 "filename": "server/api/faxAccount/index.js",
10149 "groupTitle": "Fax_Accounts"
10153 "url": "/api/fax/accounts/{id}/interactions",
10154 "title": "Gets account interactions",
10157 "title": "Example usage:",
10158 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10162 "name": "getInteraction",
10163 "group": "Fax_Accounts",
10164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10165 "version": "0.0.0",
10166 "filename": "server/api/faxAccount/index.js",
10167 "groupTitle": "Fax_Accounts"
10171 "url": "/api/fax/accounts/{id}/messages",
10172 "title": "Gets account messages",
10175 "title": "Example usage:",
10176 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10180 "name": "getMessages",
10181 "group": "Fax_Accounts",
10182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10183 "version": "0.0.0",
10184 "filename": "server/api/faxAccount/index.js",
10185 "groupTitle": "Fax_Accounts"
10189 "url": "/api/fax/accounts/{id}/send",
10190 "title": "Send new fax",
10193 "title": "Example usage:",
10194 "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",
10199 "group": "Fax_Accounts",
10200 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10201 "version": "0.0.0",
10202 "filename": "server/api/faxAccount/index.js",
10203 "groupTitle": "Fax_Accounts"
10207 "url": "/api/fax/accounts/{id}",
10208 "title": "Update an existing Account",
10211 "title": "Example usage:",
10212 "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",
10216 "name": "updateAccounts",
10217 "group": "Fax_Accounts",
10218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10219 "version": "0.0.0",
10220 "filename": "server/api/faxAccount/index.js",
10221 "groupTitle": "Fax_Accounts"
10225 "url": "/api/fax/accounts/updateaccountapplications",
10226 "title": "Update account and applications",
10229 "title": "Example usage:",
10230 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10234 "name": "updateApplications",
10235 "group": "Fax_Accounts",
10243 "field": "priority",
10257 "field": "appdata",
10264 "field": "description",
10271 "field": "interval",
10277 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10278 "version": "0.0.0",
10279 "filename": "server/api/faxAccount/index.js",
10280 "groupTitle": "Fax_Accounts"
10284 "url": "/api/fax/applications",
10285 "title": "Creates a new Application",
10288 "title": "Example usage:",
10289 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10293 "name": "CreateApplications",
10294 "group": "Fax_Applications",
10302 "field": "priority",
10316 "field": "appdata",
10323 "field": "description",
10330 "field": "interval",
10336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10337 "version": "0.0.0",
10338 "filename": "server/api/faxApplication/index.js",
10339 "groupTitle": "Fax_Applications"
10343 "url": "/api/fax/applications/{id}",
10344 "title": "Deletes a Application",
10347 "title": "Example usage:",
10348 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10352 "name": "DeleteApplications",
10353 "group": "Fax_Applications",
10354 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10355 "version": "0.0.0",
10356 "filename": "server/api/faxApplication/index.js",
10357 "groupTitle": "Fax_Applications"
10361 "url": "/api/fax/applications",
10362 "title": "Gets a list of Applications",
10365 "title": "Example usage:",
10366 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10370 "name": "GetApplications",
10371 "group": "Fax_Applications",
10372 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10373 "version": "0.0.0",
10374 "filename": "server/api/faxApplication/index.js",
10375 "groupTitle": "Fax_Applications"
10379 "url": "/api/fax/applications/{id}",
10380 "title": "Gets a single Application",
10383 "title": "Example usage:",
10384 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10388 "name": "ShowApplications",
10389 "group": "Fax_Applications",
10390 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10391 "version": "0.0.0",
10392 "filename": "server/api/faxApplication/index.js",
10393 "groupTitle": "Fax_Applications"
10397 "url": "/api/fax/applications/{id}",
10398 "title": "Update an existing Application",
10401 "title": "Example usage:",
10402 "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",
10406 "name": "updateApplications",
10407 "group": "Fax_Applications",
10408 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10409 "version": "0.0.0",
10410 "filename": "server/api/faxApplication/index.js",
10411 "groupTitle": "Fax_Applications"
10415 "url": "/api/fax/interactions/{id}/tags",
10416 "title": "Add tags to the interaction",
10419 "title": "Example usage:",
10420 "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",
10425 "group": "Fax_Interactions",
10426 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10427 "version": "0.0.0",
10428 "filename": "server/api/faxInteraction/index.js",
10429 "groupTitle": "Fax_Interactions"
10433 "url": "/api/fax/interactions",
10434 "title": "Creates a new Interaction",
10437 "title": "Example usage:",
10438 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10442 "name": "CreateInteractions",
10443 "group": "Fax_Interactions",
10458 "field": "closedAt",
10465 "field": "disposition",
10472 "field": "secondDisposition",
10479 "field": "thirdDisposition",
10493 "field": "read1stAt",
10511 "field": "firstMsgDirection",
10518 "field": "lastMsgAt",
10529 "field": "lastMsgDirection",
10535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10536 "version": "0.0.0",
10537 "filename": "server/api/faxInteraction/index.js",
10538 "groupTitle": "Fax_Interactions"
10542 "url": "/api/fax/interactions/{id}",
10543 "title": "Deletes a Interaction",
10546 "title": "Example usage:",
10547 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10551 "name": "DeleteInteractions",
10552 "group": "Fax_Interactions",
10553 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10554 "version": "0.0.0",
10555 "filename": "server/api/faxInteraction/index.js",
10556 "groupTitle": "Fax_Interactions"
10560 "url": "/api/fax/interactions/describe",
10561 "title": "Gets table info about Interactions",
10564 "title": "Example usage:",
10565 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10569 "name": "DescribeInteractions",
10570 "group": "Fax_Interactions",
10571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10572 "version": "0.0.0",
10573 "filename": "server/api/faxInteraction/index.js",
10574 "groupTitle": "Fax_Interactions"
10578 "url": "/api/fax/interactions",
10579 "title": "Gets a list of Interactions",
10582 "title": "Example usage:",
10583 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10587 "name": "GetInteractions",
10588 "group": "Fax_Interactions",
10589 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10590 "version": "0.0.0",
10591 "filename": "server/api/faxInteraction/index.js",
10592 "groupTitle": "Fax_Interactions"
10596 "url": "/api/fax/interactions/{id}/tags",
10597 "title": "Removes tags from interaction",
10600 "title": "Example usage:",
10601 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10605 "name": "RemoveTags",
10606 "group": "Fax_Interactions",
10607 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10608 "version": "0.0.0",
10609 "filename": "server/api/faxInteraction/index.js",
10610 "groupTitle": "Fax_Interactions"
10614 "url": "/api/fax/interactions/{id}",
10615 "title": "Gets a single Interaction",
10618 "title": "Example usage:",
10619 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10623 "name": "ShowInteractions",
10624 "group": "Fax_Interactions",
10625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10626 "version": "0.0.0",
10627 "filename": "server/api/faxInteraction/index.js",
10628 "groupTitle": "Fax_Interactions"
10632 "url": "/api/fax/interactions/{id}/messages",
10633 "title": "Creates new messages",
10636 "title": "Example usage:",
10637 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10641 "name": "addMessage",
10642 "group": "Fax_Interactions",
10668 "field": "direction",
10675 "field": "failMessage",
10688 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10689 "version": "0.0.0",
10690 "filename": "server/api/faxInteraction/index.js",
10691 "groupTitle": "Fax_Interactions"
10695 "url": "/api/fax/interactions/{id}/download",
10696 "title": "Get interactions",
10699 "title": "Example usage:",
10700 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10704 "name": "download",
10705 "group": "Fax_Interactions",
10706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10707 "version": "0.0.0",
10708 "filename": "server/api/faxInteraction/index.js",
10709 "groupTitle": "Fax_Interactions"
10713 "url": "/api/fax/interactions/{id}/messages",
10714 "title": "Gets interaction messages",
10717 "title": "Example usage:",
10718 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10722 "name": "getMessages",
10723 "group": "Fax_Interactions",
10724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10725 "version": "0.0.0",
10726 "filename": "server/api/faxInteraction/index.js",
10727 "groupTitle": "Fax_Interactions"
10731 "url": "/api/fax/interactions/{id}",
10732 "title": "Update an existing Interaction",
10735 "title": "Example usage:",
10736 "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",
10740 "name": "updateInteractions",
10741 "group": "Fax_Interactions",
10742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10743 "version": "0.0.0",
10744 "filename": "server/api/faxInteraction/index.js",
10745 "groupTitle": "Fax_Interactions"
10749 "url": "/api/fax/messages/{id}/download",
10750 "title": "Get message",
10753 "title": "Example usage:",
10754 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10758 "name": "download",
10759 "group": "Fax_Message",
10760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10761 "version": "0.0.0",
10762 "filename": "server/api/faxMessage/index.js",
10763 "groupTitle": "Fax_Message"
10767 "url": "/api/fax/messages/{id}",
10768 "title": "Deletes a Message",
10771 "title": "Example usage:",
10772 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10776 "name": "DeleteMessages",
10777 "group": "Fax_Messages",
10778 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10779 "version": "0.0.0",
10780 "filename": "server/api/faxMessage/index.js",
10781 "groupTitle": "Fax_Messages"
10785 "url": "/api/fax/messages/describe",
10786 "title": "Gets table info about Messages",
10789 "title": "Example usage:",
10790 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10794 "name": "DescribeMessages",
10795 "group": "Fax_Messages",
10796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10797 "version": "0.0.0",
10798 "filename": "server/api/faxMessage/index.js",
10799 "groupTitle": "Fax_Messages"
10803 "url": "/api/fax/messages",
10804 "title": "Gets a list of Messages",
10807 "title": "Example usage:",
10808 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10812 "name": "GetMessages",
10813 "group": "Fax_Messages",
10814 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10815 "version": "0.0.0",
10816 "filename": "server/api/faxMessage/index.js",
10817 "groupTitle": "Fax_Messages"
10821 "url": "/api/fax/messages/{id}",
10822 "title": "Gets a single Message",
10825 "title": "Example usage:",
10826 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10830 "name": "ShowMessages",
10831 "group": "Fax_Messages",
10832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10833 "version": "0.0.0",
10834 "filename": "server/api/faxMessage/index.js",
10835 "groupTitle": "Fax_Messages"
10839 "url": "/api/fax/messages/{id}/accept",
10840 "title": "Accepts message",
10843 "title": "Example usage:",
10844 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10848 "name": "acceptMessage",
10849 "group": "Fax_Messages",
10850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10851 "version": "0.0.0",
10852 "filename": "server/api/faxMessage/index.js",
10853 "groupTitle": "Fax_Messages"
10857 "url": "/api/fax/messages",
10858 "title": "Create message and send Fax",
10861 "title": "Example usage:",
10862 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10866 "name": "rejectMessage",
10867 "group": "Fax_Messages",
10868 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10869 "version": "0.0.0",
10870 "filename": "server/api/faxMessage/index.js",
10871 "groupTitle": "Fax_Messages"
10875 "url": "/api/fax/messages/{id}/reject",
10876 "title": "Rejects message",
10879 "title": "Example usage:",
10880 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10884 "name": "rejectMessage",
10885 "group": "Fax_Messages",
10886 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10887 "version": "0.0.0",
10888 "filename": "server/api/faxMessage/index.js",
10889 "groupTitle": "Fax_Messages"
10893 "url": "/api/fax/messages/{id}",
10894 "title": "Update an existing Message",
10897 "title": "Example usage:",
10898 "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",
10902 "name": "updateMessages",
10903 "group": "Fax_Messages",
10904 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10905 "version": "0.0.0",
10906 "filename": "server/api/faxMessage/index.js",
10907 "groupTitle": "Fax_Messages"
10911 "url": "/api/fax/reports/queue",
10912 "title": "Creates a new Fax Queue Report",
10915 "title": "Example usage:",
10916 "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",
10920 "name": "CreateFax_Queue_Reports",
10921 "group": "Fax_Queue_Reports",
10929 "field": "uniqueid",
10950 "field": "leaveAt",
10957 "field": "acceptAt",
10977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10978 "version": "0.0.0",
10979 "filename": "server/api/faxQueueReport/index.js",
10980 "groupTitle": "Fax_Queue_Reports"
10984 "url": "/api/fax/reports/queue/{id}",
10985 "title": "Deletes a Fax Queue Report",
10988 "title": "Example usage:",
10989 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10993 "name": "DeleteFax_Queue_Reports",
10994 "group": "Fax_Queue_Reports",
10995 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10996 "version": "0.0.0",
10997 "filename": "server/api/faxQueueReport/index.js",
10998 "groupTitle": "Fax_Queue_Reports"
11002 "url": "/api/fax/reports/queue/describe",
11003 "title": "Gets table info about Fax Queue Reports",
11006 "title": "Example usage:",
11007 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11011 "name": "DescribeFax_Queue_Reports",
11012 "group": "Fax_Queue_Reports",
11013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11014 "version": "0.0.0",
11015 "filename": "server/api/faxQueueReport/index.js",
11016 "groupTitle": "Fax_Queue_Reports"
11020 "url": "/api/fax/reports/queue",
11021 "title": "Gets a list of Fax Queue Reports",
11024 "title": "Example usage:",
11025 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11029 "name": "GetFax_Queue_Reports",
11030 "group": "Fax_Queue_Reports",
11031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11032 "version": "0.0.0",
11033 "filename": "server/api/faxQueueReport/index.js",
11034 "groupTitle": "Fax_Queue_Reports"
11038 "url": "/api/fax/reports/queue/{id}",
11039 "title": "Gets a single Fax Queue Report",
11042 "title": "Example usage:",
11043 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11047 "name": "ShowFax_Queue_Reports",
11048 "group": "Fax_Queue_Reports",
11049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11050 "version": "0.0.0",
11051 "filename": "server/api/faxQueueReport/index.js",
11052 "groupTitle": "Fax_Queue_Reports"
11056 "url": "/api/fax/reports/queue/{id}",
11057 "title": "Update an existing Fax Queue Report",
11060 "title": "Example usage:",
11061 "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",
11065 "name": "updateFax_Queue_Reports",
11066 "group": "Fax_Queue_Reports",
11067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11068 "version": "0.0.0",
11069 "filename": "server/api/faxQueueReport/index.js",
11070 "groupTitle": "Fax_Queue_Reports"
11074 "url": "/api/fax/queues/{id}/users",
11075 "title": "Add agents to a queue",
11078 "title": "Example usage:",
11079 "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",
11083 "name": "AddAgents",
11084 "group": "Fax_Queues",
11085 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11086 "version": "0.0.0",
11087 "filename": "server/api/faxQueue/index.js",
11088 "groupTitle": "Fax_Queues"
11092 "url": "/api/fax/queues/{id}/teams",
11093 "title": "Add teams to a queue",
11096 "title": "Example usage:",
11097 "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",
11101 "name": "AddTeams",
11102 "group": "Fax_Queues",
11103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11104 "version": "0.0.0",
11105 "filename": "server/api/faxQueue/index.js",
11106 "groupTitle": "Fax_Queues"
11110 "url": "/api/fax/queues",
11111 "title": "Creates a new Queue",
11114 "title": "Example usage:",
11115 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11119 "name": "CreateQueues",
11120 "group": "Fax_Queues",
11135 "field": "description",
11142 "field": "timeout",
11154 "field": "strategy",
11161 "field": "lastAgent",
11167 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11168 "version": "0.0.0",
11169 "filename": "server/api/faxQueue/index.js",
11170 "groupTitle": "Fax_Queues"
11174 "url": "/api/fax/queues/{id}",
11175 "title": "Deletes a Queue",
11178 "title": "Example usage:",
11179 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11183 "name": "DeleteQueues",
11184 "group": "Fax_Queues",
11185 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11186 "version": "0.0.0",
11187 "filename": "server/api/faxQueue/index.js",
11188 "groupTitle": "Fax_Queues"
11192 "url": "/api/fax/queues/describe",
11193 "title": "Gets table info about Queues",
11196 "title": "Example usage:",
11197 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11201 "name": "DescribeQueues",
11202 "group": "Fax_Queues",
11203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11204 "version": "0.0.0",
11205 "filename": "server/api/faxQueue/index.js",
11206 "groupTitle": "Fax_Queues"
11210 "url": "/api/fax/queues/{id}/users",
11211 "title": "Gets queue agents",
11214 "title": "Example usage:",
11215 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11219 "name": "GetAgents",
11220 "group": "Fax_Queues",
11221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11222 "version": "0.0.0",
11223 "filename": "server/api/faxQueue/index.js",
11224 "groupTitle": "Fax_Queues"
11228 "url": "/api/fax/queues/{id}/members",
11229 "title": "GetMembers",
11232 "title": "Example usage:",
11233 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11237 "name": "GetMembers",
11238 "group": "Fax_Queues",
11239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11240 "version": "0.0.0",
11241 "filename": "server/api/faxQueue/index.js",
11242 "groupTitle": "Fax_Queues"
11246 "url": "/api/fax/queues",
11247 "title": "Gets a list of Queues",
11250 "title": "Example usage:",
11251 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11255 "name": "GetQueues",
11256 "group": "Fax_Queues",
11257 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11258 "version": "0.0.0",
11259 "filename": "server/api/faxQueue/index.js",
11260 "groupTitle": "Fax_Queues"
11264 "url": "/api/fax/queues/{id}/teams",
11265 "title": "Gets queues list",
11268 "title": "Example usage:",
11269 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11273 "name": "GetTeams",
11274 "group": "Fax_Queues",
11275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11276 "version": "0.0.0",
11277 "filename": "server/api/faxQueue/index.js",
11278 "groupTitle": "Fax_Queues"
11282 "url": "/api/fax/queues/{id}/users",
11283 "title": "Removes agents from a queue",
11286 "title": "Example usage:",
11287 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11291 "name": "RemoveAgents",
11292 "group": "Fax_Queues",
11293 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11294 "version": "0.0.0",
11295 "filename": "server/api/faxQueue/index.js",
11296 "groupTitle": "Fax_Queues"
11300 "url": "/api/fax/queues/{id}",
11301 "title": "Gets a single Queue",
11304 "title": "Example usage:",
11305 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11309 "name": "ShowQueues",
11310 "group": "Fax_Queues",
11311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11312 "version": "0.0.0",
11313 "filename": "server/api/faxQueue/index.js",
11314 "groupTitle": "Fax_Queues"
11318 "url": "/api/fax/queues/{id}",
11319 "title": "Update an existing Queue",
11322 "title": "Example usage:",
11323 "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",
11327 "name": "updateQueues",
11328 "group": "Fax_Queues",
11329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11330 "version": "0.0.0",
11331 "filename": "server/api/faxQueue/index.js",
11332 "groupTitle": "Fax_Queues"
11336 "url": "/api/fax/reports/transfer",
11337 "title": "Creates a new Fax Transfer Report",
11340 "title": "Example usage:",
11341 "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",
11345 "name": "CreateFax_Transfer_Reports",
11346 "group": "Fax_Transfer_Reports",
11354 "field": "uniqueid",
11373 "field": "transferredAt",
11379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11380 "version": "0.0.0",
11381 "filename": "server/api/faxTransferReport/index.js",
11382 "groupTitle": "Fax_Transfer_Reports"
11386 "url": "/api/fax/reports/transfer/{id}",
11387 "title": "Deletes a Fax Transfer Report",
11390 "title": "Example usage:",
11391 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11395 "name": "DeleteFax_Transfer_Reports",
11396 "group": "Fax_Transfer_Reports",
11397 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11398 "version": "0.0.0",
11399 "filename": "server/api/faxTransferReport/index.js",
11400 "groupTitle": "Fax_Transfer_Reports"
11404 "url": "/api/fax/reports/transfer/describe",
11405 "title": "Gets table info about Fax Transfer Reports",
11408 "title": "Example usage:",
11409 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11413 "name": "DescribeFax_Transfer_Reports",
11414 "group": "Fax_Transfer_Reports",
11415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11416 "version": "0.0.0",
11417 "filename": "server/api/faxTransferReport/index.js",
11418 "groupTitle": "Fax_Transfer_Reports"
11422 "url": "/api/fax/reports/transfer",
11423 "title": "Gets a list of Fax Transfer Reports",
11426 "title": "Example usage:",
11427 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11431 "name": "GetFax_Transfer_Reports",
11432 "group": "Fax_Transfer_Reports",
11433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11434 "version": "0.0.0",
11435 "filename": "server/api/faxTransferReport/index.js",
11436 "groupTitle": "Fax_Transfer_Reports"
11440 "url": "/api/fax/reports/transfer/{id}",
11441 "title": "Gets a single Fax Transfer Report",
11444 "title": "Example usage:",
11445 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11449 "name": "ShowFax_Transfer_Reports",
11450 "group": "Fax_Transfer_Reports",
11451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11452 "version": "0.0.0",
11453 "filename": "server/api/faxTransferReport/index.js",
11454 "groupTitle": "Fax_Transfer_Reports"
11458 "url": "/api/fax/reports/transfer/{id}",
11459 "title": "Update an existing Fax Transfer Report",
11462 "title": "Example usage:",
11463 "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",
11467 "name": "updateFax_Transfer_Reports",
11468 "group": "Fax_Transfer_Reports",
11469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11470 "version": "0.0.0",
11471 "filename": "server/api/faxTransferReport/index.js",
11472 "groupTitle": "Fax_Transfer_Reports"
11476 "url": "/api/integrations/freshdesk/accounts",
11477 "title": "Creates a new Freshdesk Account",
11480 "title": "Example usage:",
11481 "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",
11485 "name": "CreateFreshdesk_Accounts",
11486 "group": "Freshdesk_Accounts",
11501 "field": "description",
11508 "field": "username",
11522 "field": "remoteUri",
11529 "field": "serverUrl",
11535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11536 "version": "0.0.0",
11537 "filename": "server/api/intFreshdeskAccount/index.js",
11538 "groupTitle": "Freshdesk_Accounts"
11542 "url": "/api/integrations/freshdesk/accounts/{id}",
11543 "title": "Deletes a Freshdesk Account",
11546 "title": "Example usage:",
11547 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11551 "name": "DeleteFreshdesk_Accounts",
11552 "group": "Freshdesk_Accounts",
11553 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11554 "version": "0.0.0",
11555 "filename": "server/api/intFreshdeskAccount/index.js",
11556 "groupTitle": "Freshdesk_Accounts"
11560 "url": "/api/integrations/freshdesk/accounts",
11561 "title": "Gets a list of Freshdesk Accounts",
11564 "title": "Example usage:",
11565 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11569 "name": "GetFreshdesk_Accounts",
11570 "group": "Freshdesk_Accounts",
11571 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11572 "version": "0.0.0",
11573 "filename": "server/api/intFreshdeskAccount/index.js",
11574 "groupTitle": "Freshdesk_Accounts"
11578 "url": "/api/integrations/freshdesk/accounts/{id}",
11579 "title": "Gets a single Freshdesk Account",
11582 "title": "Example usage:",
11583 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11587 "name": "ShowFreshdesk_Accounts",
11588 "group": "Freshdesk_Accounts",
11589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11590 "version": "0.0.0",
11591 "filename": "server/api/intFreshdeskAccount/index.js",
11592 "groupTitle": "Freshdesk_Accounts"
11596 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11597 "title": "Creates new configuration",
11600 "title": "Example usage:",
11601 "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",
11605 "name": "addConfiguration",
11606 "group": "Freshdesk_Accounts",
11607 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11608 "version": "0.0.0",
11609 "filename": "server/api/intFreshdeskAccount/index.js",
11610 "groupTitle": "Freshdesk_Accounts"
11614 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11615 "title": "Gets account configurations",
11618 "title": "Example usage:",
11619 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11623 "name": "getConfigurations",
11624 "group": "Freshdesk_Accounts",
11625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11626 "version": "0.0.0",
11627 "filename": "server/api/intFreshdeskAccount/index.js",
11628 "groupTitle": "Freshdesk_Accounts"
11632 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11633 "title": "Gets account fields",
11636 "title": "Example usage:",
11637 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11641 "name": "getFields",
11642 "group": "Freshdesk_Accounts",
11643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11644 "version": "0.0.0",
11645 "filename": "server/api/intFreshdeskAccount/index.js",
11646 "groupTitle": "Freshdesk_Accounts"
11650 "url": "/api/integrations/freshdesk/accounts/{id}",
11651 "title": "Update an existing Freshdesk Account",
11654 "title": "Example usage:",
11655 "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",
11659 "name": "updateFreshdesk_Accounts",
11660 "group": "Freshdesk_Accounts",
11661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11662 "version": "0.0.0",
11663 "filename": "server/api/intFreshdeskAccount/index.js",
11664 "groupTitle": "Freshdesk_Accounts"
11668 "url": "/api/integrations/freshdesk/configurations",
11669 "title": "Creates a new Freshdesk Configuration",
11672 "title": "Example usage:",
11673 "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",
11677 "name": "CreateFreshdesk_Configurations",
11678 "group": "Freshdesk_Configurations",
11693 "field": "description",
11699 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11700 "version": "0.0.0",
11701 "filename": "server/api/intFreshdeskConfiguration/index.js",
11702 "groupTitle": "Freshdesk_Configurations"
11706 "url": "/api/integrations/freshdesk/configurations/{id}",
11707 "title": "Deletes a Freshdesk Configuration",
11710 "title": "Example usage:",
11711 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11715 "name": "DeleteFreshdesk_Configurations",
11716 "group": "Freshdesk_Configurations",
11717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11718 "version": "0.0.0",
11719 "filename": "server/api/intFreshdeskConfiguration/index.js",
11720 "groupTitle": "Freshdesk_Configurations"
11724 "url": "/api/integrations/freshdesk/configurations",
11725 "title": "Gets a list of Freshdesk Configurations",
11728 "title": "Example usage:",
11729 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11733 "name": "GetFreshdesk_Configurations",
11734 "group": "Freshdesk_Configurations",
11735 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11736 "version": "0.0.0",
11737 "filename": "server/api/intFreshdeskConfiguration/index.js",
11738 "groupTitle": "Freshdesk_Configurations"
11742 "url": "/api/integrations/freshdesk/configurations/{id}",
11743 "title": "Gets a single Freshdesk Configuration",
11746 "title": "Example usage:",
11747 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11751 "name": "ShowFreshdesk_Configurations",
11752 "group": "Freshdesk_Configurations",
11753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11754 "version": "0.0.0",
11755 "filename": "server/api/intFreshdeskConfiguration/index.js",
11756 "groupTitle": "Freshdesk_Configurations"
11760 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11761 "title": "Gets configurations descriptions",
11764 "title": "Example usage:",
11765 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11769 "name": "getDescriptions",
11770 "group": "Freshdesk_Configurations",
11771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11772 "version": "0.0.0",
11773 "filename": "server/api/intFreshdeskConfiguration/index.js",
11774 "groupTitle": "Freshdesk_Configurations"
11778 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11779 "title": "Gets configurations fields",
11782 "title": "Example usage:",
11783 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11787 "name": "getFields",
11788 "group": "Freshdesk_Configurations",
11789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11790 "version": "0.0.0",
11791 "filename": "server/api/intFreshdeskConfiguration/index.js",
11792 "groupTitle": "Freshdesk_Configurations"
11796 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11797 "title": "Gets configurations subjects",
11800 "title": "Example usage:",
11801 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11805 "name": "getSubjects",
11806 "group": "Freshdesk_Configurations",
11807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11808 "version": "0.0.0",
11809 "filename": "server/api/intFreshdeskConfiguration/index.js",
11810 "groupTitle": "Freshdesk_Configurations"
11814 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11815 "title": "Gets configurations tags",
11818 "title": "Example usage:",
11819 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11824 "group": "Freshdesk_Configurations",
11825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11826 "version": "0.0.0",
11827 "filename": "server/api/intFreshdeskConfiguration/index.js",
11828 "groupTitle": "Freshdesk_Configurations"
11832 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11833 "title": "Sets new tags",
11836 "title": "Example usage:",
11837 "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",
11842 "group": "Freshdesk_Configurations",
11843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11844 "version": "0.0.0",
11845 "filename": "server/api/intFreshdeskConfiguration/index.js",
11846 "groupTitle": "Freshdesk_Configurations"
11850 "url": "/api/integrations/freshdesk/configurations/{id}",
11851 "title": "Update an existing Freshdesk Configuration",
11854 "title": "Example usage:",
11855 "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",
11859 "name": "updateFreshdesk_Configurations",
11860 "group": "Freshdesk_Configurations",
11861 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11862 "version": "0.0.0",
11863 "filename": "server/api/intFreshdeskConfiguration/index.js",
11864 "groupTitle": "Freshdesk_Configurations"
11868 "url": "/api/integrations/freshdesk/fields",
11869 "title": "Creates a new Freshdesk Field",
11872 "title": "Example usage:",
11873 "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",
11877 "name": "CreateFreshdesk_Fields",
11878 "group": "Freshdesk_Fields",
11888 "\"customVariable\"",
11900 "field": "content",
11916 "\"customVariable\""
11919 "field": "keyType",
11926 "field": "keyContent",
11933 "field": "idField",
11940 "field": "nameField",
11947 "field": "customField",
11954 "field": "variableName",
11960 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11961 "version": "0.0.0",
11962 "filename": "server/api/intFreshdeskField/index.js",
11963 "groupTitle": "Freshdesk_Fields"
11967 "url": "/api/integrations/freshdesk/fields/{id}",
11968 "title": "Deletes a Freshdesk Field",
11971 "title": "Example usage:",
11972 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11976 "name": "DeleteFreshdesk_Fields",
11977 "group": "Freshdesk_Fields",
11978 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11979 "version": "0.0.0",
11980 "filename": "server/api/intFreshdeskField/index.js",
11981 "groupTitle": "Freshdesk_Fields"
11985 "url": "/api/integrations/freshdesk/fields",
11986 "title": "Gets a list of Freshdesk Fields",
11989 "title": "Example usage:",
11990 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11994 "name": "GetFreshdesk_Fields",
11995 "group": "Freshdesk_Fields",
11996 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11997 "version": "0.0.0",
11998 "filename": "server/api/intFreshdeskField/index.js",
11999 "groupTitle": "Freshdesk_Fields"
12003 "url": "/api/integrations/freshdesk/fields/{id}",
12004 "title": "Gets a single Freshdesk Field",
12007 "title": "Example usage:",
12008 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12012 "name": "ShowFreshdesk_Fields",
12013 "group": "Freshdesk_Fields",
12014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12015 "version": "0.0.0",
12016 "filename": "server/api/intFreshdeskField/index.js",
12017 "groupTitle": "Freshdesk_Fields"
12021 "url": "/api/integrations/freshdesk/fields/{id}",
12022 "title": "Update an existing Freshdesk Field",
12025 "title": "Example usage:",
12026 "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",
12030 "name": "updateFreshdesk_Fields",
12031 "group": "Freshdesk_Fields",
12032 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12033 "version": "0.0.0",
12034 "filename": "server/api/intFreshdeskField/index.js",
12035 "groupTitle": "Freshdesk_Fields"
12039 "url": "/api/integrations/freshsales/accounts",
12040 "title": "Creates a new Freshsales Account",
12043 "title": "Example usage:",
12044 "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",
12048 "name": "CreateFreshsales_Accounts",
12049 "group": "Freshsales_Accounts",
12064 "field": "description",
12071 "field": "username",
12085 "field": "remoteUri",
12092 "field": "serverUrl",
12098 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12099 "version": "0.0.0",
12100 "filename": "server/api/intFreshsalesAccount/index.js",
12101 "groupTitle": "Freshsales_Accounts"
12105 "url": "/api/integrations/freshsales/accounts/{id}",
12106 "title": "Deletes a Freshsales Account",
12109 "title": "Example usage:",
12110 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12114 "name": "DeleteFreshsales_Accounts",
12115 "group": "Freshsales_Accounts",
12116 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12117 "version": "0.0.0",
12118 "filename": "server/api/intFreshsalesAccount/index.js",
12119 "groupTitle": "Freshsales_Accounts"
12123 "url": "/api/integrations/freshsales/accounts",
12124 "title": "Gets a list of Freshsales Accounts",
12127 "title": "Example usage:",
12128 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12132 "name": "GetFreshsales_Accounts",
12133 "group": "Freshsales_Accounts",
12134 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12135 "version": "0.0.0",
12136 "filename": "server/api/intFreshsalesAccount/index.js",
12137 "groupTitle": "Freshsales_Accounts"
12141 "url": "/api/integrations/freshsales/accounts/{id}",
12142 "title": "Gets a single Freshsales Account",
12145 "title": "Example usage:",
12146 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12150 "name": "ShowFreshsales_Accounts",
12151 "group": "Freshsales_Accounts",
12152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12153 "version": "0.0.0",
12154 "filename": "server/api/intFreshsalesAccount/index.js",
12155 "groupTitle": "Freshsales_Accounts"
12159 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12160 "title": "Creates new configuration",
12163 "title": "Example usage:",
12164 "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",
12168 "name": "addConfiguration",
12169 "group": "Freshsales_Accounts",
12170 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12171 "version": "0.0.0",
12172 "filename": "server/api/intFreshsalesAccount/index.js",
12173 "groupTitle": "Freshsales_Accounts"
12177 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12178 "title": "Gets account configurations",
12181 "title": "Example usage:",
12182 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12186 "name": "getConfigurations",
12187 "group": "Freshsales_Accounts",
12188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12189 "version": "0.0.0",
12190 "filename": "server/api/intFreshsalesAccount/index.js",
12191 "groupTitle": "Freshsales_Accounts"
12195 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12196 "title": "Gets account fields",
12199 "title": "Example usage:",
12200 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12204 "name": "getFields",
12205 "group": "Freshsales_Accounts",
12206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12207 "version": "0.0.0",
12208 "filename": "server/api/intFreshsalesAccount/index.js",
12209 "groupTitle": "Freshsales_Accounts"
12213 "url": "/api/integrations/freshsales/accounts/{id}",
12214 "title": "Update an existing Freshsales Account",
12217 "title": "Example usage:",
12218 "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",
12222 "name": "updateFreshsales_Accounts",
12223 "group": "Freshsales_Accounts",
12224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12225 "version": "0.0.0",
12226 "filename": "server/api/intFreshsalesAccount/index.js",
12227 "groupTitle": "Freshsales_Accounts"
12231 "url": "/api/integrations/freshsales/configurations",
12232 "title": "Creates a new Freshsales Configuration",
12235 "title": "Example usage:",
12236 "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",
12240 "name": "CreateFreshsales_Configurations",
12241 "group": "Freshsales_Configurations",
12256 "field": "description",
12262 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12263 "version": "0.0.0",
12264 "filename": "server/api/intFreshsalesConfiguration/index.js",
12265 "groupTitle": "Freshsales_Configurations"
12269 "url": "/api/integrations/freshsales/configurations/{id}",
12270 "title": "Deletes a Freshsales Configuration",
12273 "title": "Example usage:",
12274 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12278 "name": "DeleteFreshsales_Configurations",
12279 "group": "Freshsales_Configurations",
12280 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12281 "version": "0.0.0",
12282 "filename": "server/api/intFreshsalesConfiguration/index.js",
12283 "groupTitle": "Freshsales_Configurations"
12287 "url": "/api/integrations/freshsales/configurations",
12288 "title": "Gets a list of Freshsales Configurations",
12291 "title": "Example usage:",
12292 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12296 "name": "GetFreshsales_Configurations",
12297 "group": "Freshsales_Configurations",
12298 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12299 "version": "0.0.0",
12300 "filename": "server/api/intFreshsalesConfiguration/index.js",
12301 "groupTitle": "Freshsales_Configurations"
12305 "url": "/api/integrations/freshsales/configurations/{id}",
12306 "title": "Gets a single Freshsales Configuration",
12309 "title": "Example usage:",
12310 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12314 "name": "ShowFreshsales_Configurations",
12315 "group": "Freshsales_Configurations",
12316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12317 "version": "0.0.0",
12318 "filename": "server/api/intFreshsalesConfiguration/index.js",
12319 "groupTitle": "Freshsales_Configurations"
12323 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12324 "title": "Gets configurations descriptions",
12327 "title": "Example usage:",
12328 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12332 "name": "getDescriptions",
12333 "group": "Freshsales_Configurations",
12334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12335 "version": "0.0.0",
12336 "filename": "server/api/intFreshsalesConfiguration/index.js",
12337 "groupTitle": "Freshsales_Configurations"
12341 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12342 "title": "Gets configurations fields",
12345 "title": "Example usage:",
12346 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12350 "name": "getFields",
12351 "group": "Freshsales_Configurations",
12352 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12353 "version": "0.0.0",
12354 "filename": "server/api/intFreshsalesConfiguration/index.js",
12355 "groupTitle": "Freshsales_Configurations"
12359 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12360 "title": "Gets configurations subjects",
12363 "title": "Example usage:",
12364 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12368 "name": "getSubjects",
12369 "group": "Freshsales_Configurations",
12370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12371 "version": "0.0.0",
12372 "filename": "server/api/intFreshsalesConfiguration/index.js",
12373 "groupTitle": "Freshsales_Configurations"
12377 "url": "/api/integrations/freshsales/configurations/{id}",
12378 "title": "Update an existing Freshsales Configuration",
12381 "title": "Example usage:",
12382 "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",
12386 "name": "updateFreshsales_Configurations",
12387 "group": "Freshsales_Configurations",
12388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12389 "version": "0.0.0",
12390 "filename": "server/api/intFreshsalesConfiguration/index.js",
12391 "groupTitle": "Freshsales_Configurations"
12395 "url": "/api/integrations/freshsales/fields",
12396 "title": "Creates a new Freshsales Field",
12399 "title": "Example usage:",
12400 "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",
12404 "name": "CreateFreshsales_Fields",
12405 "group": "Freshsales_Fields",
12415 "\"customVariable\"",
12427 "field": "content",
12443 "\"customVariable\""
12446 "field": "keyType",
12453 "field": "keyContent",
12460 "field": "idField",
12467 "field": "nameField",
12474 "field": "customField",
12481 "field": "variableName",
12487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488 "version": "0.0.0",
12489 "filename": "server/api/intFreshsalesField/index.js",
12490 "groupTitle": "Freshsales_Fields"
12494 "url": "/api/integrations/freshsales/fields/{id}",
12495 "title": "Deletes a Freshsales Field",
12498 "title": "Example usage:",
12499 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12503 "name": "DeleteFreshsales_Fields",
12504 "group": "Freshsales_Fields",
12505 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12506 "version": "0.0.0",
12507 "filename": "server/api/intFreshsalesField/index.js",
12508 "groupTitle": "Freshsales_Fields"
12512 "url": "/api/integrations/freshsales/fields",
12513 "title": "Gets a list of Freshsales Fields",
12516 "title": "Example usage:",
12517 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12521 "name": "GetFreshsales_Fields",
12522 "group": "Freshsales_Fields",
12523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12524 "version": "0.0.0",
12525 "filename": "server/api/intFreshsalesField/index.js",
12526 "groupTitle": "Freshsales_Fields"
12530 "url": "/api/integrations/freshsales/fields/{id}",
12531 "title": "Gets a single Freshsales Field",
12534 "title": "Example usage:",
12535 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12539 "name": "ShowFreshsales_Fields",
12540 "group": "Freshsales_Fields",
12541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542 "version": "0.0.0",
12543 "filename": "server/api/intFreshsalesField/index.js",
12544 "groupTitle": "Freshsales_Fields"
12548 "url": "/api/integrations/freshsales/fields/{id}",
12549 "title": "Update an existing Freshsales Field",
12552 "title": "Example usage:",
12553 "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",
12557 "name": "updateFreshsales_Fields",
12558 "group": "Freshsales_Fields",
12559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560 "version": "0.0.0",
12561 "filename": "server/api/intFreshsalesField/index.js",
12562 "groupTitle": "Freshsales_Fields"
12566 "url": "/api/campaigns/{id}/blacklists",
12567 "title": "Add blacklists to an IVR campaign",
12570 "title": "Example usage:",
12571 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12575 "name": "AddBlackLists",
12576 "group": "IVR_Campaigns",
12577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578 "version": "0.0.0",
12579 "filename": "server/api/campaign/index.js",
12580 "groupTitle": "IVR_Campaigns"
12584 "url": "/api/campaigns/{id}/lists",
12585 "title": "Add lists to an IVR campaign",
12588 "title": "Example usage:",
12589 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12593 "name": "AddLists",
12594 "group": "IVR_Campaigns",
12595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596 "version": "0.0.0",
12597 "filename": "server/api/campaign/index.js",
12598 "groupTitle": "IVR_Campaigns"
12602 "url": "/api/campaigns/clone",
12603 "title": "Clone an existing IVR Campaign",
12606 "title": "Example usage:",
12607 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12611 "name": "CloneIVR_Campaigns",
12612 "group": "IVR_Campaigns",
12613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12614 "version": "0.0.0",
12615 "filename": "server/api/campaign/index.js",
12616 "groupTitle": "IVR_Campaigns"
12620 "url": "/api/campaigns",
12621 "title": "Creates a new IVR Campaign",
12624 "title": "Example usage:",
12625 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12629 "name": "CreateIVR_Campaigns",
12630 "group": "IVR_Campaigns",
12655 "field": "description",
12663 "description": "<p>Active/Disactive Campaign</p>"
12669 "field": "limitCalls",
12670 "description": "<p>Max 200 calls.</p>"
12676 "field": "dialOriginateCallerIdName",
12683 "field": "dialOriginateCallerIdNumber",
12690 "field": "dialOriginateTimeout",
12691 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12697 "field": "dialCongestionMaxRetry",
12698 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12704 "field": "dialCongestionRetryFrequency",
12705 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12711 "field": "dialBusyMaxRetry",
12712 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12718 "field": "dialBusyRetryFrequency",
12719 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12725 "field": "dialNoAnswerMaxRetry",
12726 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12732 "field": "dialNoAnswerRetryFrequency",
12733 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12739 "field": "dialGlobalMaxRetry",
12740 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12746 "field": "dialTimezone",
12753 "field": "dialGlobalInterval",
12765 "field": "dialCheckDuplicateType",
12772 "field": "dialAMDActive",
12773 "description": "<p>Active/Disactive AMD</p>"
12779 "field": "dialAMDInitialSilence",
12780 "description": "<p>#AMD Initial Silence</p>"
12786 "field": "dialAMDGreeting",
12787 "description": "<p>#AMD Greeting</p>"
12793 "field": "dialAMDAfterGreetingSilence",
12794 "description": "<p>#AMD After Greeting Silence</p>"
12800 "field": "dialAMDTotalAnalysisTime",
12801 "description": "<p>#AMD Total Analysis Time</p>"
12807 "field": "dialAMDMinWordLength",
12808 "description": "<p>#AMD Min Word Length</p>"
12814 "field": "dialAMDBetweenWordsSilence",
12815 "description": "<p>#AMD Between Words Silence</p>"
12821 "field": "dialAMDMaximumNumberOfWords",
12822 "description": "<p>#AMD Maximum Number Of Words</p>"
12828 "field": "dialAMDSilenceThreshold",
12829 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12835 "field": "dialAMDMaximumWordLength",
12836 "description": "<p>#AMD Maximum Word Length</p>"
12846 "field": "dialOrderByScheduledAt",
12853 "field": "dialPrefix",
12860 "field": "dialRandomLastDigitCallerIdNumber",
12861 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12867 "field": "dialCutDigit",
12868 "description": "<p>Cut Digit (min:1, max:15)</p>"
12874 "field": "dialNoSuchNumberMaxRetry",
12875 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12881 "field": "dialNoSuchNumberRetryFrequency",
12882 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12888 "field": "dialDropMaxRetry",
12889 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12895 "field": "dialDropRetryFrequency",
12896 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12902 "field": "dialAbandonedMaxRetry",
12903 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12909 "field": "dialAbandonedRetryFrequency",
12910 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12916 "field": "dialMachineMaxRetry",
12917 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12923 "field": "dialMachineRetryFrequency",
12924 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12930 "field": "dialAgentRejectMaxRetry",
12931 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12937 "field": "dialAgentRejectRetryFrequency",
12938 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12944 "version": "0.0.0",
12945 "filename": "server/api/campaign/index.js",
12946 "groupTitle": "IVR_Campaigns"
12950 "url": "/api/campaigns/{id}",
12951 "title": "Deletes a IVR Campaign",
12954 "title": "Example usage:",
12955 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12959 "name": "DeleteIVR_Campaigns",
12960 "group": "IVR_Campaigns",
12961 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12962 "version": "0.0.0",
12963 "filename": "server/api/campaign/index.js",
12964 "groupTitle": "IVR_Campaigns"
12968 "url": "/api/campaigns/{id}/blacklists",
12969 "title": "Get IVR campaign blacklists",
12972 "title": "Example usage:",
12973 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12977 "name": "GetBlackLists",
12978 "group": "IVR_Campaigns",
12979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12980 "version": "0.0.0",
12981 "filename": "server/api/campaign/index.js",
12982 "groupTitle": "IVR_Campaigns"
12986 "url": "/api/campaigns/{id}/finals",
12987 "title": "Gets IVR campaign hopper finals",
12990 "title": "Example usage:",
12991 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12995 "name": "GetHopperFinals",
12996 "group": "IVR_Campaigns",
12997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12998 "version": "0.0.0",
12999 "filename": "server/api/campaign/index.js",
13000 "groupTitle": "IVR_Campaigns"
13004 "url": "/api/campaigns/{id}/hopper_histories",
13005 "title": "Gets IVR campaign hopper histories",
13008 "title": "Example usage:",
13009 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13013 "name": "GetHopperHistories",
13014 "group": "IVR_Campaigns",
13015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13016 "version": "0.0.0",
13017 "filename": "server/api/campaign/index.js",
13018 "groupTitle": "IVR_Campaigns"
13022 "url": "/api/campaigns/{id}/hoppers",
13023 "title": "Gets IVR campaign hoppers",
13026 "title": "Example usage:",
13027 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13031 "name": "GetHoppers",
13032 "group": "IVR_Campaigns",
13033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13034 "version": "0.0.0",
13035 "filename": "server/api/campaign/index.js",
13036 "groupTitle": "IVR_Campaigns"
13040 "url": "/api/campaigns",
13041 "title": "Gets a list of IVR Campaigns",
13044 "title": "Example usage:",
13045 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13049 "name": "GetIVR_Campaigns",
13050 "group": "IVR_Campaigns",
13051 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13052 "version": "0.0.0",
13053 "filename": "server/api/campaign/index.js",
13054 "groupTitle": "IVR_Campaigns"
13058 "url": "/api/campaigns/{id}/lists",
13059 "title": "Get IVR campaign lists",
13062 "title": "Example usage:",
13063 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13067 "name": "GetLists",
13068 "group": "IVR_Campaigns",
13069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13070 "version": "0.0.0",
13071 "filename": "server/api/campaign/index.js",
13072 "groupTitle": "IVR_Campaigns"
13076 "url": "/api/campaigns/{id}/blacklists",
13077 "title": "Remove blacklists from an IVR Campaign",
13080 "title": "Example usage:",
13081 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13085 "name": "RemoveBlackLists",
13086 "group": "IVR_Campaigns",
13087 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13088 "version": "0.0.0",
13089 "filename": "server/api/campaign/index.js",
13090 "groupTitle": "IVR_Campaigns"
13094 "url": "/api/campaigns/{id}/lists",
13095 "title": "Remove lists from an IVR Campaign",
13098 "title": "Example usage:",
13099 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13103 "name": "RemoveLists",
13104 "group": "IVR_Campaigns",
13105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13106 "version": "0.0.0",
13107 "filename": "server/api/campaign/index.js",
13108 "groupTitle": "IVR_Campaigns"
13112 "url": "/api/campaigns/{id}",
13113 "title": "Gets a single IVR Campaign",
13116 "title": "Example usage:",
13117 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13121 "name": "ShowIVR_Campaigns",
13122 "group": "IVR_Campaigns",
13123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13124 "version": "0.0.0",
13125 "filename": "server/api/campaign/index.js",
13126 "groupTitle": "IVR_Campaigns"
13130 "url": "/api/campaigns/{id}/blacks",
13131 "title": "Gets IVR campaign hopper blacks",
13134 "title": "Example usage:",
13135 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13139 "name": "getHopperBlacks",
13140 "group": "IVR_Campaigns",
13141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13142 "version": "0.0.0",
13143 "filename": "server/api/campaign/index.js",
13144 "groupTitle": "IVR_Campaigns"
13148 "url": "/api/campaigns/{id}",
13149 "title": "Update an existing IVR Campaign",
13152 "title": "Example usage:",
13153 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13157 "name": "updateIVR_Campaigns",
13158 "group": "IVR_Campaigns",
13159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13160 "version": "0.0.0",
13161 "filename": "server/api/campaign/index.js",
13162 "groupTitle": "IVR_Campaigns"
13166 "url": "/api/integrations/reports",
13167 "title": "Creates a new Integration Report",
13170 "title": "Example usage:",
13171 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13175 "name": "CreateIntegration_Reports",
13176 "group": "Integration_Reports",
13184 "field": "integration",
13191 "field": "eventChannel",
13198 "field": "exitStatus",
13205 "field": "ticketId",
13212 "field": "integrationId",
13219 "field": "contacts",
13226 "field": "uniqueid",
13233 "field": "calleridnum",
13240 "field": "calleridname",
13254 "field": "interface",
13261 "field": "membername",
13268 "field": "agentcalledAt",
13275 "field": "agentconnectAt",
13282 "field": "holdtime",
13289 "field": "agentcomplete",
13296 "field": "agentcompleteAt",
13303 "field": "talktime",
13310 "field": "agentacw",
13317 "field": "acwtime",
13331 "field": "agentringnoanswer",
13338 "field": "agentringnoanswerAt",
13345 "field": "agentdump",
13352 "field": "agentdumpAt",
13359 "field": "lastevent",
13366 "field": "channel",
13373 "field": "channelstate",
13380 "field": "channelstatedesc",
13387 "field": "connectedlinenum",
13394 "field": "connectedlinename",
13401 "field": "language",
13408 "field": "accountcode",
13415 "field": "context",
13429 "field": "priority",
13436 "field": "destchannel",
13443 "field": "destchannelstate",
13450 "field": "destchannelstatedesc",
13457 "field": "destcalleridnum",
13464 "field": "destcalleridname",
13471 "field": "destconnectedlinenum",
13478 "field": "destconnectedlinename",
13485 "field": "destlanguage",
13492 "field": "destaccountcode",
13499 "field": "destcontext",
13506 "field": "destexten",
13513 "field": "destpriority",
13520 "field": "destuniqueid",
13527 "field": "messageId",
13534 "field": "inReplyTo",
13541 "field": "subject",
13569 "field": "attachment",
13617 "field": "appdata",
13624 "field": "projectId",
13630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13631 "version": "0.0.0",
13632 "filename": "server/api/integrationReport/index.js",
13633 "groupTitle": "Integration_Reports"
13637 "url": "/api/integrations/reports/{id}",
13638 "title": "Deletes a Integration Report",
13641 "title": "Example usage:",
13642 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13646 "name": "DeleteIntegration_Reports",
13647 "group": "Integration_Reports",
13648 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13649 "version": "0.0.0",
13650 "filename": "server/api/integrationReport/index.js",
13651 "groupTitle": "Integration_Reports"
13655 "url": "/api/integrations/reports/describe",
13656 "title": "Gets table info about Integration Reports",
13659 "title": "Example usage:",
13660 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13664 "name": "DescribeIntegration_Reports",
13665 "group": "Integration_Reports",
13666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13667 "version": "0.0.0",
13668 "filename": "server/api/integrationReport/index.js",
13669 "groupTitle": "Integration_Reports"
13673 "url": "/api/integrations/reports",
13674 "title": "Gets a list of Integration Reports",
13677 "title": "Example usage:",
13678 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13682 "name": "GetIntegration_Reports",
13683 "group": "Integration_Reports",
13684 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13685 "version": "0.0.0",
13686 "filename": "server/api/integrationReport/index.js",
13687 "groupTitle": "Integration_Reports"
13691 "url": "/api/integrations/reports/{id}",
13692 "title": "Gets a single Integration Report",
13695 "title": "Example usage:",
13696 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13700 "name": "ShowIntegration_Reports",
13701 "group": "Integration_Reports",
13702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13703 "version": "0.0.0",
13704 "filename": "server/api/integrationReport/index.js",
13705 "groupTitle": "Integration_Reports"
13709 "url": "/api/integrations/reports/{id}",
13710 "title": "Update an existing Integration Report",
13713 "title": "Example usage:",
13714 "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",
13718 "name": "updateIntegration_Reports",
13719 "group": "Integration_Reports",
13720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13721 "version": "0.0.0",
13722 "filename": "server/api/integrationReport/index.js",
13723 "groupTitle": "Integration_Reports"
13727 "url": "/api/intervals",
13728 "title": "Creates a new Interval",
13731 "title": "Example usage:",
13732 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13736 "name": "CreateIntervals",
13737 "group": "Intervals",
13752 "field": "description",
13759 "field": "interval",
13765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13766 "version": "0.0.0",
13767 "filename": "server/api/interval/index.js",
13768 "groupTitle": "Intervals"
13772 "url": "/api/intervals/{id}",
13773 "title": "Deletes a Interval",
13776 "title": "Example usage:",
13777 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13781 "name": "DeleteIntervals",
13782 "group": "Intervals",
13783 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13784 "version": "0.0.0",
13785 "filename": "server/api/interval/index.js",
13786 "groupTitle": "Intervals"
13790 "url": "/api/intervals",
13791 "title": "Gets a list of Intervals",
13794 "title": "Example usage:",
13795 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13799 "name": "GetIntervals",
13800 "group": "Intervals",
13801 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13802 "version": "0.0.0",
13803 "filename": "server/api/interval/index.js",
13804 "groupTitle": "Intervals"
13808 "url": "/api/intervals/{id}",
13809 "title": "Gets a single Interval",
13812 "title": "Example usage:",
13813 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13817 "name": "ShowIntervals",
13818 "group": "Intervals",
13819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13820 "version": "0.0.0",
13821 "filename": "server/api/interval/index.js",
13822 "groupTitle": "Intervals"
13826 "url": "/api/intervals/{id}/sub_intervals",
13827 "title": "Creates a new sub interval",
13830 "title": "Example usage:",
13831 "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",
13835 "name": "addInterval",
13836 "group": "Intervals",
13837 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13838 "version": "0.0.0",
13839 "filename": "server/api/interval/index.js",
13840 "groupTitle": "Intervals"
13844 "url": "/api/intervals/{id}/sub_intervals/create_many",
13845 "title": "Create new sub intervals set",
13848 "title": "Example usage:",
13849 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13853 "name": "addIntervals",
13854 "group": "Intervals",
13855 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13856 "version": "0.0.0",
13857 "filename": "server/api/interval/index.js",
13858 "groupTitle": "Intervals"
13862 "url": "/api/intervals/{id}/sub_intervals",
13863 "title": "Get sub intervals set",
13866 "title": "Example usage:",
13867 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13871 "name": "getIntervals",
13872 "group": "Intervals",
13873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13874 "version": "0.0.0",
13875 "filename": "server/api/interval/index.js",
13876 "groupTitle": "Intervals"
13880 "url": "/api/intervals/{id}",
13881 "title": "Update an existing Interval",
13884 "title": "Example usage:",
13885 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13889 "name": "updateIntervals",
13890 "group": "Intervals",
13891 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13892 "version": "0.0.0",
13893 "filename": "server/api/interval/index.js",
13894 "groupTitle": "Intervals"
13898 "url": "/api/jira",
13899 "title": "Creates a new issue",
13902 "title": "Example usage:",
13903 "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}",
13907 "name": "Creates_Issue",
13919 "field": "issuetype",
13926 "field": "summary",
13933 "field": "description",
13939 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13940 "version": "0.0.0",
13941 "filename": "server/api/jira/index.js",
13942 "groupTitle": "Issue"
13946 "url": "/api/jscripty/answers/reports",
13947 "title": "Creates a new Report",
13950 "title": "Example usage:",
13951 "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",
13955 "name": "CreateReports",
13956 "group": "JscriptyAnswerReport",
13964 "field": "question",
13978 "field": "membername",
13985 "field": "projectname",
13999 "field": "uniqueid",
14006 "field": "calleridname",
14013 "field": "calleridnum",
14020 "field": "questionId",
14026 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14027 "version": "0.0.0",
14028 "filename": "server/api/jscriptyAnswerReport/index.js",
14029 "groupTitle": "JscriptyAnswerReport"
14033 "url": "/api/jscripty/answers/reports/{id}",
14034 "title": "Deletes a Report",
14037 "title": "Example usage:",
14038 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14042 "name": "DeleteReports",
14043 "group": "JscriptyAnswerReport",
14044 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14045 "version": "0.0.0",
14046 "filename": "server/api/jscriptyAnswerReport/index.js",
14047 "groupTitle": "JscriptyAnswerReport"
14051 "url": "/api/jscripty/answers/reports/describe",
14052 "title": "Gets table info about Reports",
14055 "title": "Example usage:",
14056 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14060 "name": "DescribeReports",
14061 "group": "JscriptyAnswerReport",
14062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14063 "version": "0.0.0",
14064 "filename": "server/api/jscriptyAnswerReport/index.js",
14065 "groupTitle": "JscriptyAnswerReport"
14069 "url": "/api/jscripty/answers/reports",
14070 "title": "Gets a list of Reports",
14073 "title": "Example usage:",
14074 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14078 "name": "GetReports",
14079 "group": "JscriptyAnswerReport",
14080 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14081 "version": "0.0.0",
14082 "filename": "server/api/jscriptyAnswerReport/index.js",
14083 "groupTitle": "JscriptyAnswerReport"
14087 "url": "/api/jscripty/answers/reports/{id}",
14088 "title": "Gets a single Report",
14091 "title": "Example usage:",
14092 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14096 "name": "ShowReports",
14097 "group": "JscriptyAnswerReport",
14098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14099 "version": "0.0.0",
14100 "filename": "server/api/jscriptyAnswerReport/index.js",
14101 "groupTitle": "JscriptyAnswerReport"
14105 "url": "/api/jscripty/answers/reports/{id}",
14106 "title": "Update an existing Report",
14109 "title": "Example usage:",
14110 "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",
14114 "name": "updateReports",
14115 "group": "JscriptyAnswerReport",
14116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14117 "version": "0.0.0",
14118 "filename": "server/api/jscriptyAnswerReport/index.js",
14119 "groupTitle": "JscriptyAnswerReport"
14123 "url": "/api/jscripty/questions/reports",
14124 "title": "Creates a new Report",
14127 "title": "Example usage:",
14128 "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",
14132 "name": "CreateReports",
14133 "group": "JscriptyQuestionReport",
14141 "field": "question",
14155 "field": "membername",
14162 "field": "projectname",
14176 "field": "uniqueid",
14183 "field": "calleridname",
14190 "field": "calleridnum",
14197 "field": "questionId",
14203 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14204 "version": "0.0.0",
14205 "filename": "server/api/jscriptyQuestionReport/index.js",
14206 "groupTitle": "JscriptyQuestionReport"
14210 "url": "/api/jscripty/questions/reports/{id}",
14211 "title": "Deletes a Report",
14214 "title": "Example usage:",
14215 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14219 "name": "DeleteReports",
14220 "group": "JscriptyQuestionReport",
14221 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14222 "version": "0.0.0",
14223 "filename": "server/api/jscriptyQuestionReport/index.js",
14224 "groupTitle": "JscriptyQuestionReport"
14228 "url": "/api/jscripty/questions/reports/describe",
14229 "title": "Gets table info about Reports",
14232 "title": "Example usage:",
14233 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14237 "name": "DescribeReports",
14238 "group": "JscriptyQuestionReport",
14239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14240 "version": "0.0.0",
14241 "filename": "server/api/jscriptyQuestionReport/index.js",
14242 "groupTitle": "JscriptyQuestionReport"
14246 "url": "/api/jscripty/questions/reports",
14247 "title": "Gets a list of Reports",
14250 "title": "Example usage:",
14251 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14255 "name": "GetReports",
14256 "group": "JscriptyQuestionReport",
14257 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14258 "version": "0.0.0",
14259 "filename": "server/api/jscriptyQuestionReport/index.js",
14260 "groupTitle": "JscriptyQuestionReport"
14264 "url": "/api/jscripty/questions/reports/{id}",
14265 "title": "Gets a single Report",
14268 "title": "Example usage:",
14269 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14273 "name": "ShowReports",
14274 "group": "JscriptyQuestionReport",
14275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14276 "version": "0.0.0",
14277 "filename": "server/api/jscriptyQuestionReport/index.js",
14278 "groupTitle": "JscriptyQuestionReport"
14282 "url": "/api/jscripty/questions/reports/{id}",
14283 "title": "Update an existing Report",
14286 "title": "Example usage:",
14287 "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",
14291 "name": "updateReports",
14292 "group": "JscriptyQuestionReport",
14293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14294 "version": "0.0.0",
14295 "filename": "server/api/jscriptyQuestionReport/index.js",
14296 "groupTitle": "JscriptyQuestionReport"
14300 "url": "/api/jscripty/sessions/reports",
14301 "title": "Creates a new Report",
14304 "title": "Example usage:",
14305 "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",
14309 "name": "CreateReports",
14310 "group": "JscriptySessionReport",
14318 "field": "starttime",
14325 "field": "endtime",
14332 "field": "membername",
14339 "field": "projectname",
14353 "field": "uniqueid",
14360 "field": "calleridname",
14367 "field": "calleridnum",
14374 "field": "completed",
14380 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14381 "version": "0.0.0",
14382 "filename": "server/api/jscriptySessionReport/index.js",
14383 "groupTitle": "JscriptySessionReport"
14387 "url": "/api/jscripty/sessions/reports/{id}",
14388 "title": "Deletes a Report",
14391 "title": "Example usage:",
14392 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14396 "name": "DeleteReports",
14397 "group": "JscriptySessionReport",
14398 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14399 "version": "0.0.0",
14400 "filename": "server/api/jscriptySessionReport/index.js",
14401 "groupTitle": "JscriptySessionReport"
14405 "url": "/api/jscripty/sessions/reports/describe",
14406 "title": "Gets table info about Reports",
14409 "title": "Example usage:",
14410 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14414 "name": "DescribeReports",
14415 "group": "JscriptySessionReport",
14416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14417 "version": "0.0.0",
14418 "filename": "server/api/jscriptySessionReport/index.js",
14419 "groupTitle": "JscriptySessionReport"
14423 "url": "/api/jscripty/sessions/reports",
14424 "title": "Gets a list of Reports",
14427 "title": "Example usage:",
14428 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14432 "name": "GetReports",
14433 "group": "JscriptySessionReport",
14434 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14435 "version": "0.0.0",
14436 "filename": "server/api/jscriptySessionReport/index.js",
14437 "groupTitle": "JscriptySessionReport"
14441 "url": "/api/jscripty/sessions/reports/{id}",
14442 "title": "Gets a single Report",
14445 "title": "Example usage:",
14446 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14450 "name": "ShowReports",
14451 "group": "JscriptySessionReport",
14452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453 "version": "0.0.0",
14454 "filename": "server/api/jscriptySessionReport/index.js",
14455 "groupTitle": "JscriptySessionReport"
14459 "url": "/api/jscripty/sessions/reports/{id}/questions",
14460 "title": "Gets Jscripty Session questions",
14463 "title": "Example usage:",
14464 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14468 "name": "getQuestions",
14469 "group": "JscriptySessionReport",
14470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471 "version": "0.0.0",
14472 "filename": "server/api/jscriptySessionReport/index.js",
14473 "groupTitle": "JscriptySessionReport"
14477 "url": "/api/jscripty/sessions/reports/{id}",
14478 "title": "Update an existing Report",
14481 "title": "Example usage:",
14482 "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",
14486 "name": "updateReports",
14487 "group": "JscriptySessionReport",
14488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14489 "version": "0.0.0",
14490 "filename": "server/api/jscriptySessionReport/index.js",
14491 "groupTitle": "JscriptySessionReport"
14495 "url": "/api/jscripty/projects/clone",
14496 "title": "Clone an existing Project",
14499 "title": "Example usage:",
14500 "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",
14504 "name": "CloneProjects",
14505 "group": "Jscripty_Projects",
14506 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14507 "version": "0.0.0",
14508 "filename": "server/api/jscriptyProject/index.js",
14509 "groupTitle": "Jscripty_Projects"
14513 "url": "/api/jscripty/projects",
14514 "title": "Creates a new Project",
14517 "title": "Example usage:",
14518 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14522 "name": "CreateProjects",
14523 "group": "Jscripty_Projects",
14538 "field": "description",
14545 "field": "formData",
14552 "field": "enableUncompleteSave",
14559 "field": "sendUnpauseOnSubmit",
14565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14566 "version": "0.0.0",
14567 "filename": "server/api/jscriptyProject/index.js",
14568 "groupTitle": "Jscripty_Projects"
14572 "url": "/api/jscripty/projects/{id}",
14573 "title": "Deletes a Project",
14576 "title": "Example usage:",
14577 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14581 "name": "DeleteProjects",
14582 "group": "Jscripty_Projects",
14583 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14584 "version": "0.0.0",
14585 "filename": "server/api/jscriptyProject/index.js",
14586 "groupTitle": "Jscripty_Projects"
14590 "url": "/api/jscripty/projects",
14591 "title": "Gets a list of Projects",
14594 "title": "Example usage:",
14595 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14599 "name": "GetProjects",
14600 "group": "Jscripty_Projects",
14601 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14602 "version": "0.0.0",
14603 "filename": "server/api/jscriptyProject/index.js",
14604 "groupTitle": "Jscripty_Projects"
14608 "url": "/api/jscripty/projects/{id}",
14609 "title": "Gets a single Project",
14612 "title": "Example usage:",
14613 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14617 "name": "ShowProjects",
14618 "group": "Jscripty_Projects",
14619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14620 "version": "0.0.0",
14621 "filename": "server/api/jscriptyProject/index.js",
14622 "groupTitle": "Jscripty_Projects"
14626 "url": "/api/jscripty/projects/{id}/answers",
14627 "title": "Gets jscripty project answers",
14630 "title": "Example usage:",
14631 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14635 "name": "getAnswers",
14636 "group": "Jscripty_Projects",
14637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14638 "version": "0.0.0",
14639 "filename": "server/api/jscriptyProject/index.js",
14640 "groupTitle": "Jscripty_Projects"
14644 "url": "/api/jscripty/projects/{id}/sessions",
14645 "title": "Gets jscripty project sessions",
14648 "title": "Example usage:",
14649 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14653 "name": "getSessions",
14654 "group": "Jscripty_Projects",
14655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14656 "version": "0.0.0",
14657 "filename": "server/api/jscriptyProject/index.js",
14658 "groupTitle": "Jscripty_Projects"
14662 "url": "/api/jscripty/projects/{id}/summary",
14663 "title": "Gets jscripty project summary",
14666 "title": "Example usage:",
14667 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14671 "name": "getSummary",
14672 "group": "Jscripty_Projects",
14673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14674 "version": "0.0.0",
14675 "filename": "server/api/jscriptyProject/index.js",
14676 "groupTitle": "Jscripty_Projects"
14680 "url": "/api/jscripty/projects/{id}",
14681 "title": "Update an existing Project",
14684 "title": "Example usage:",
14685 "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",
14689 "name": "updateProjects",
14690 "group": "Jscripty_Projects",
14691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14692 "version": "0.0.0",
14693 "filename": "server/api/jscriptyProject/index.js",
14694 "groupTitle": "Jscripty_Projects"
14698 "url": "/api/license",
14699 "title": "Gets License Info",
14702 "title": "Example usage:",
14703 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14708 "group": "License",
14709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710 "version": "0.0.0",
14711 "filename": "server/api/license/index.js",
14712 "groupTitle": "License"
14716 "url": "/api/license/{id}",
14717 "title": "Update License Info",
14720 "title": "Example usage:",
14721 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14726 "group": "License",
14727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14728 "version": "0.0.0",
14729 "filename": "server/api/license/index.js",
14730 "groupTitle": "License"
14734 "url": "/api/mail/accounts/{id}/users",
14735 "title": "Add agents to a mail account",
14738 "title": "Example usage:",
14739 "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",
14743 "name": "AddAgents",
14744 "group": "Mail_Accounts",
14745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14746 "version": "0.0.0",
14747 "filename": "server/api/mailAccount/index.js",
14748 "groupTitle": "Mail_Accounts"
14752 "url": "/api/mail/accounts/{id}/in_servers",
14753 "title": "Creates a new IMAP server",
14756 "title": "Example usage:",
14757 "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",
14762 "group": "Mail_Accounts",
14770 "field": "description",
14784 "field": "authentication",
14798 "field": "password",
14819 "field": "mailbox",
14826 "field": "connTimeout",
14833 "field": "authTimeout",
14840 "field": "service",
14846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14847 "version": "0.0.0",
14848 "filename": "server/api/mailAccount/index.js",
14849 "groupTitle": "Mail_Accounts"
14853 "url": "/api/mail/accounts/{id}/out_servers",
14854 "title": "Creates a new SMTP server",
14857 "title": "Example usage:",
14858 "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",
14863 "group": "Mail_Accounts",
14871 "field": "description",
14913 "field": "service",
14920 "field": "authentication",
14926 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14927 "version": "0.0.0",
14928 "filename": "server/api/mailAccount/index.js",
14929 "groupTitle": "Mail_Accounts"
14933 "url": "/api/mail/accounts/{id}",
14934 "title": "Deletes a mail account",
14937 "title": "Example usage:",
14938 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14942 "name": "DeleteMailAccounts",
14943 "group": "Mail_Accounts",
14944 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14945 "version": "0.0.0",
14946 "filename": "server/api/mailAccount/index.js",
14947 "groupTitle": "Mail_Accounts"
14951 "url": "/api/mail/accounts/describe",
14952 "title": "Gets table info about Accounts",
14955 "title": "Example usage:",
14956 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14960 "name": "DescribeAccounts",
14961 "group": "Mail_Accounts",
14962 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14963 "version": "0.0.0",
14964 "filename": "server/api/mailAccount/index.js",
14965 "groupTitle": "Mail_Accounts"
14969 "url": "/api/mail/accounts",
14970 "title": "Gets a list of Accounts",
14973 "title": "Example usage:",
14974 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14978 "name": "GetAccounts",
14979 "group": "Mail_Accounts",
14980 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14981 "version": "0.0.0",
14982 "filename": "server/api/mailAccount/index.js",
14983 "groupTitle": "Mail_Accounts"
14987 "url": "/api/mail/accounts/{id}/users",
14988 "title": "Gets agents from mail account",
14991 "title": "Example usage:",
14992 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14996 "name": "GetAgents",
14997 "group": "Mail_Accounts",
14998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14999 "version": "0.0.0",
15000 "filename": "server/api/mailAccount/index.js",
15001 "groupTitle": "Mail_Accounts"
15005 "url": "/api/mail/accounts/{id}/in_servers",
15006 "title": "Gets account IMAP server",
15009 "title": "Example usage:",
15010 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15015 "group": "Mail_Accounts",
15016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15017 "version": "0.0.0",
15018 "filename": "server/api/mailAccount/index.js",
15019 "groupTitle": "Mail_Accounts"
15023 "url": "/api/mail/accounts/{id}/out_servers",
15024 "title": "Gets account SMTP server",
15027 "title": "Example usage:",
15028 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15033 "group": "Mail_Accounts",
15034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15035 "version": "0.0.0",
15036 "filename": "server/api/mailAccount/index.js",
15037 "groupTitle": "Mail_Accounts"
15041 "url": "/api/mail/accounts/{id}/users",
15042 "title": "Removes agents from a mail account",
15045 "title": "Example usage:",
15046 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15050 "name": "RemoveAgents",
15051 "group": "Mail_Accounts",
15052 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15053 "version": "0.0.0",
15054 "filename": "server/api/mailAccount/index.js",
15055 "groupTitle": "Mail_Accounts"
15059 "url": "/api/mail/accounts/{id}/canned_answers",
15060 "title": "Removes canned answers from account",
15063 "title": "Example usage:",
15064 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15068 "name": "RemoveAnswers",
15069 "group": "Mail_Accounts",
15070 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15071 "version": "0.0.0",
15072 "filename": "server/api/mailAccount/index.js",
15073 "groupTitle": "Mail_Accounts"
15077 "url": "/api/mail/accounts/{id}/dispositions",
15078 "title": "Removes dispositions from account",
15081 "title": "Example usage:",
15082 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15086 "name": "RemoveDispositions",
15087 "group": "Mail_Accounts",
15088 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15089 "version": "0.0.0",
15090 "filename": "server/api/mailAccount/index.js",
15091 "groupTitle": "Mail_Accounts"
15095 "url": "/api/mail/accounts/{id}/in_servers",
15096 "title": "Removes IMAP server from an account",
15099 "title": "Example usage:",
15100 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15104 "name": "RemoveImmap",
15105 "group": "Mail_Accounts",
15106 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15107 "version": "0.0.0",
15108 "filename": "server/api/mailAccount/index.js",
15109 "groupTitle": "Mail_Accounts"
15113 "url": "/api/mail/accounts/{id}/out_servers",
15114 "title": "Removes SMTP server from an account",
15117 "title": "Example usage:",
15118 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15122 "name": "RemoveSmtp",
15123 "group": "Mail_Accounts",
15124 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15125 "version": "0.0.0",
15126 "filename": "server/api/mailAccount/index.js",
15127 "groupTitle": "Mail_Accounts"
15131 "url": "/api/mail/accounts/{id}",
15132 "title": "Gets a single Account",
15135 "title": "Example usage:",
15136 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15140 "name": "ShowAccounts",
15141 "group": "Mail_Accounts",
15142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15143 "version": "0.0.0",
15144 "filename": "server/api/mailAccount/index.js",
15145 "groupTitle": "Mail_Accounts"
15149 "url": "/api/mail/accounts/{id}/canned_answers",
15150 "title": "Creates new canned answer",
15153 "title": "Example usage:",
15154 "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",
15158 "name": "addAnswer",
15159 "group": "Mail_Accounts",
15181 "field": "description",
15194 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15195 "version": "0.0.0",
15196 "filename": "server/api/mailAccount/index.js",
15197 "groupTitle": "Mail_Accounts"
15201 "url": "/api/mail/accounts/{id}/applications",
15202 "title": "Creates new applications",
15205 "title": "Example usage:",
15206 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15210 "name": "addApplications",
15211 "group": "Mail_Accounts",
15219 "field": "priority",
15233 "field": "appdata",
15240 "field": "description",
15247 "field": "interval",
15253 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15254 "version": "0.0.0",
15255 "filename": "server/api/mailAccount/index.js",
15256 "groupTitle": "Mail_Accounts"
15260 "url": "/api/mail/accounts/{id}/dispositions",
15261 "title": "Creates new disposition",
15264 "title": "Example usage:",
15265 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15269 "name": "addDisposition",
15270 "group": "Mail_Accounts",
15297 "field": "description",
15303 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15304 "version": "0.0.0",
15305 "filename": "server/api/mailAccount/index.js",
15306 "groupTitle": "Mail_Accounts"
15310 "url": "/api/mail/accounts/{id}/interactions",
15311 "title": "Creates new interactions",
15314 "title": "Example usage:",
15315 "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",
15319 "name": "addInteraction",
15320 "group": "Mail_Accounts",
15335 "field": "closedAt",
15342 "field": "disposition",
15349 "field": "secondDisposition",
15356 "field": "thirdDisposition",
15370 "field": "inReplyTo",
15391 "field": "subject",
15405 "field": "read1stAt",
15412 "field": "substatus",
15419 "field": "substatusAt",
15430 "field": "firstMsgDirection",
15437 "field": "lastMsgAt",
15448 "field": "lastMsgDirection",
15454 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15455 "version": "0.0.0",
15456 "filename": "server/api/mailAccount/index.js",
15457 "groupTitle": "Mail_Accounts"
15461 "url": "/api/mail/accounts",
15462 "title": "Create a mail account",
15465 "title": "Example usage:",
15466 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15471 "group": "Mail_Accounts",
15472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15473 "version": "0.0.0",
15474 "filename": "server/api/mailAccount/index.js",
15475 "groupTitle": "Mail_Accounts"
15479 "url": "/api/mail/accounts/{id}/canned_answers",
15480 "title": "Gets account canned answers",
15483 "title": "Example usage:",
15484 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15488 "name": "getAnswers",
15489 "group": "Mail_Accounts",
15490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15491 "version": "0.0.0",
15492 "filename": "server/api/mailAccount/index.js",
15493 "groupTitle": "Mail_Accounts"
15497 "url": "/api/mail/accounts/{id}/applications",
15498 "title": "Gets account applications",
15501 "title": "Example usage:",
15502 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15506 "name": "getApplications",
15507 "group": "Mail_Accounts",
15508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15509 "version": "0.0.0",
15510 "filename": "server/api/mailAccount/index.js",
15511 "groupTitle": "Mail_Accounts"
15515 "url": "/api/mail/accounts/{id}/dispositions",
15516 "title": "Gets account dispositions",
15519 "title": "Example usage:",
15520 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15524 "name": "getDispositions",
15525 "group": "Mail_Accounts",
15526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15527 "version": "0.0.0",
15528 "filename": "server/api/mailAccount/index.js",
15529 "groupTitle": "Mail_Accounts"
15533 "url": "/api/mail/accounts/{id}/interactions",
15534 "title": "Gets account interactions",
15537 "title": "Example usage:",
15538 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15542 "name": "getInteraction",
15543 "group": "Mail_Accounts",
15544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15545 "version": "0.0.0",
15546 "filename": "server/api/mailAccount/index.js",
15547 "groupTitle": "Mail_Accounts"
15551 "url": "/api/mail/accounts/{id}/messages",
15552 "title": "Gets account messages",
15555 "title": "Example usage:",
15556 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15560 "name": "getMessages",
15561 "group": "Mail_Accounts",
15562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15563 "version": "0.0.0",
15564 "filename": "server/api/mailAccount/index.js",
15565 "groupTitle": "Mail_Accounts"
15569 "url": "/api/mail/accounts/{id}/send",
15570 "title": "Send new mail",
15573 "title": "Example usage:",
15574 "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",
15578 "name": "sendMail",
15579 "group": "Mail_Accounts",
15580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15581 "version": "0.0.0",
15582 "filename": "server/api/mailAccount/index.js",
15583 "groupTitle": "Mail_Accounts"
15587 "url": "/api/mail/accounts/{id}",
15588 "title": "Update an existing Account",
15591 "title": "Example usage:",
15592 "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",
15596 "name": "updateAccounts",
15597 "group": "Mail_Accounts",
15598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15599 "version": "0.0.0",
15600 "filename": "server/api/mailAccount/index.js",
15601 "groupTitle": "Mail_Accounts"
15605 "url": "/api/mail/accounts/{id}/verify",
15606 "title": "Verify mail account",
15609 "title": "Example usage:",
15610 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15614 "name": "verifySmtp",
15615 "group": "Mail_Accounts",
15616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15617 "version": "0.0.0",
15618 "filename": "server/api/mailAccount/index.js",
15619 "groupTitle": "Mail_Accounts"
15623 "url": "/api/mail/applications/{id}",
15624 "title": "Deletes a Application",
15627 "title": "Example usage:",
15628 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15632 "name": "DeleteApplications",
15633 "group": "Mail_Applications",
15634 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15635 "version": "0.0.0",
15636 "filename": "server/api/mailApplication/index.js",
15637 "groupTitle": "Mail_Applications"
15641 "url": "/api/mail/applications/{id}",
15642 "title": "Gets a single Application",
15645 "title": "Example usage:",
15646 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15650 "name": "ShowApplications",
15651 "group": "Mail_Applications",
15652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15653 "version": "0.0.0",
15654 "filename": "server/api/mailApplication/index.js",
15655 "groupTitle": "Mail_Applications"
15659 "url": "/api/mail/applications/{id}",
15660 "title": "Update an existing Application",
15663 "title": "Example usage:",
15664 "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",
15668 "name": "updateApplications",
15669 "group": "Mail_Applications",
15670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15671 "version": "0.0.0",
15672 "filename": "server/api/mailApplication/index.js",
15673 "groupTitle": "Mail_Applications"
15677 "url": "/api/mail/interactions/{id}/tags",
15678 "title": "Add tags to the interaction",
15681 "title": "Example usage:",
15682 "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",
15687 "group": "Mail_Interactions",
15688 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15689 "version": "0.0.0",
15690 "filename": "server/api/mailInteraction/index.js",
15691 "groupTitle": "Mail_Interactions"
15695 "url": "/api/mail/interactions",
15696 "title": "Creates a new Interaction",
15699 "title": "Example usage:",
15700 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15704 "name": "CreateInteractions",
15705 "group": "Mail_Interactions",
15720 "field": "closedAt",
15727 "field": "disposition",
15734 "field": "secondDisposition",
15741 "field": "thirdDisposition",
15755 "field": "inReplyTo",
15776 "field": "subject",
15790 "field": "read1stAt",
15797 "field": "substatus",
15804 "field": "substatusAt",
15815 "field": "firstMsgDirection",
15822 "field": "lastMsgAt",
15833 "field": "lastMsgDirection",
15839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15840 "version": "0.0.0",
15841 "filename": "server/api/mailInteraction/index.js",
15842 "groupTitle": "Mail_Interactions"
15846 "url": "/api/mail/interactions/{id}",
15847 "title": "Deletes a Interaction",
15850 "title": "Example usage:",
15851 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15855 "name": "DeleteInteractions",
15856 "group": "Mail_Interactions",
15857 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15858 "version": "0.0.0",
15859 "filename": "server/api/mailInteraction/index.js",
15860 "groupTitle": "Mail_Interactions"
15864 "url": "/api/mail/interactions/describe",
15865 "title": "Gets table info about Interactions",
15868 "title": "Example usage:",
15869 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15873 "name": "DescribeInteractions",
15874 "group": "Mail_Interactions",
15875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15876 "version": "0.0.0",
15877 "filename": "server/api/mailInteraction/index.js",
15878 "groupTitle": "Mail_Interactions"
15882 "url": "/api/mail/interactions",
15883 "title": "Gets a list of Interactions",
15886 "title": "Example usage:",
15887 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15891 "name": "GetInteractions",
15892 "group": "Mail_Interactions",
15893 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15894 "version": "0.0.0",
15895 "filename": "server/api/mailInteraction/index.js",
15896 "groupTitle": "Mail_Interactions"
15900 "url": "/api/mail/interactions/{id}/tags",
15901 "title": "Removes tags from interaction",
15904 "title": "Example usage:",
15905 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15909 "name": "RemoveTags",
15910 "group": "Mail_Interactions",
15911 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15912 "version": "0.0.0",
15913 "filename": "server/api/mailInteraction/index.js",
15914 "groupTitle": "Mail_Interactions"
15918 "url": "/api/mail/interactions/{id}",
15919 "title": "Gets a single Interaction",
15922 "title": "Example usage:",
15923 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15927 "name": "ShowInteractions",
15928 "group": "Mail_Interactions",
15929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15930 "version": "0.0.0",
15931 "filename": "server/api/mailInteraction/index.js",
15932 "groupTitle": "Mail_Interactions"
15936 "url": "/api/mail/interactions/{id}/messages",
15937 "title": "Creates new message",
15940 "title": "Example usage:",
15941 "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",
15945 "name": "addMessage",
15946 "group": "Mail_Interactions",
15961 "field": "plainBody",
15979 "field": "direction",
15986 "field": "messageId",
16021 "field": "subject",
16056 "field": "originTo",
16063 "field": "originCc",
16074 "field": "originChannel",
16080 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16081 "version": "0.0.0",
16082 "filename": "server/api/mailInteraction/index.js",
16083 "groupTitle": "Mail_Interactions"
16087 "url": "/api/mail/interactions/{id}/download",
16088 "title": "Gets interaction",
16091 "title": "Example usage:",
16092 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16096 "name": "download",
16097 "group": "Mail_Interactions",
16098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16099 "version": "0.0.0",
16100 "filename": "server/api/mailInteraction/index.js",
16101 "groupTitle": "Mail_Interactions"
16105 "url": "/api/mail/interactions/{id}/messages",
16106 "title": "Gets interaction messages",
16109 "title": "Example usage:",
16110 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16114 "name": "getMessages",
16115 "group": "Mail_Interactions",
16116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16117 "version": "0.0.0",
16118 "filename": "server/api/mailInteraction/index.js",
16119 "groupTitle": "Mail_Interactions"
16123 "url": "/api/mail/interactions/{id}",
16124 "title": "Update an existing Interaction",
16127 "title": "Example usage:",
16128 "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",
16132 "name": "updateInteractions",
16133 "group": "Mail_Interactions",
16134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16135 "version": "0.0.0",
16136 "filename": "server/api/mailInteraction/index.js",
16137 "groupTitle": "Mail_Interactions"
16141 "url": "/api/mail/messages/{id}",
16142 "title": "Deletes a Message",
16145 "title": "Example usage:",
16146 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16150 "name": "DeleteMessages",
16151 "group": "Mail_Messages",
16152 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16153 "version": "0.0.0",
16154 "filename": "server/api/mailMessage/index.js",
16155 "groupTitle": "Mail_Messages"
16159 "url": "/api/mail/messages/describe",
16160 "title": "Gets table info about Messages",
16163 "title": "Example usage:",
16164 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16168 "name": "DescribeMessages",
16169 "group": "Mail_Messages",
16170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16171 "version": "0.0.0",
16172 "filename": "server/api/mailMessage/index.js",
16173 "groupTitle": "Mail_Messages"
16177 "url": "/api/mail/messages",
16178 "title": "Gets a list of Messages",
16181 "title": "Example usage:",
16182 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16186 "name": "GetMessages",
16187 "group": "Mail_Messages",
16188 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16189 "version": "0.0.0",
16190 "filename": "server/api/mailMessage/index.js",
16191 "groupTitle": "Mail_Messages"
16195 "url": "/api/mail/messages/{id}",
16196 "title": "Gets a single Message",
16199 "title": "Example usage:",
16200 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16204 "name": "ShowMessages",
16205 "group": "Mail_Messages",
16206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16207 "version": "0.0.0",
16208 "filename": "server/api/mailMessage/index.js",
16209 "groupTitle": "Mail_Messages"
16213 "url": "/api/mail/messages/{id}/accept",
16214 "title": "Accepts message",
16217 "title": "Example usage:",
16218 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16222 "name": "acceptMessage",
16223 "group": "Mail_Messages",
16224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16225 "version": "0.0.0",
16226 "filename": "server/api/mailMessage/index.js",
16227 "groupTitle": "Mail_Messages"
16231 "url": "/api/mail/messages",
16232 "title": "Create a message",
16235 "title": "Example usage:",
16236 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16240 "name": "createMessage",
16241 "group": "Mail_Messages",
16242 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16243 "version": "0.0.0",
16244 "filename": "server/api/mailMessage/index.js",
16245 "groupTitle": "Mail_Messages"
16249 "url": "/api/mail/messages/{id}/download",
16250 "title": "Gets message",
16253 "title": "Example usage:",
16254 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16258 "name": "download",
16259 "group": "Mail_Messages",
16260 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16261 "version": "0.0.0",
16262 "filename": "server/api/mailMessage/index.js",
16263 "groupTitle": "Mail_Messages"
16267 "url": "/api/mail/messages/{id}/reject",
16268 "title": "Rejects message",
16271 "title": "Example usage:",
16272 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16276 "name": "rejectMessage",
16277 "group": "Mail_Messages",
16278 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16279 "version": "0.0.0",
16280 "filename": "server/api/mailMessage/index.js",
16281 "groupTitle": "Mail_Messages"
16285 "url": "/api/mail/messages/{id}",
16286 "title": "Update an existing Message",
16289 "title": "Example usage:",
16290 "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",
16294 "name": "updateMessages",
16295 "group": "Mail_Messages",
16296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16297 "version": "0.0.0",
16298 "filename": "server/api/mailMessage/index.js",
16299 "groupTitle": "Mail_Messages"
16303 "url": "/api/mail/reports/queue",
16304 "title": "Creates a new Mail Queue Report",
16307 "title": "Example usage:",
16308 "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",
16312 "name": "CreateMail_Queue_Reports",
16313 "group": "Mail_Queue_Reports",
16321 "field": "uniqueid",
16342 "field": "leaveAt",
16349 "field": "acceptAt",
16369 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16370 "version": "0.0.0",
16371 "filename": "server/api/mailQueueReport/index.js",
16372 "groupTitle": "Mail_Queue_Reports"
16376 "url": "/api/mail/reports/queue/{id}",
16377 "title": "Deletes a Mail Queue Report",
16380 "title": "Example usage:",
16381 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16385 "name": "DeleteMail_Queue_Reports",
16386 "group": "Mail_Queue_Reports",
16387 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16388 "version": "0.0.0",
16389 "filename": "server/api/mailQueueReport/index.js",
16390 "groupTitle": "Mail_Queue_Reports"
16394 "url": "/api/mail/reports/queue/describe",
16395 "title": "Gets table info about Mail Queue Reports",
16398 "title": "Example usage:",
16399 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16403 "name": "DescribeMail_Queue_Reports",
16404 "group": "Mail_Queue_Reports",
16405 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16406 "version": "0.0.0",
16407 "filename": "server/api/mailQueueReport/index.js",
16408 "groupTitle": "Mail_Queue_Reports"
16412 "url": "/api/mail/reports/queue",
16413 "title": "Gets a list of Mail Queue Reports",
16416 "title": "Example usage:",
16417 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16421 "name": "GetMail_Queue_Reports",
16422 "group": "Mail_Queue_Reports",
16423 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16424 "version": "0.0.0",
16425 "filename": "server/api/mailQueueReport/index.js",
16426 "groupTitle": "Mail_Queue_Reports"
16430 "url": "/api/mail/reports/queue/{id}",
16431 "title": "Gets a single Mail Queue Report",
16434 "title": "Example usage:",
16435 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16439 "name": "ShowMail_Queue_Reports",
16440 "group": "Mail_Queue_Reports",
16441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16442 "version": "0.0.0",
16443 "filename": "server/api/mailQueueReport/index.js",
16444 "groupTitle": "Mail_Queue_Reports"
16448 "url": "/api/mail/reports/queue/{id}",
16449 "title": "Update an existing Mail Queue Report",
16452 "title": "Example usage:",
16453 "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",
16457 "name": "updateMail_Queue_Reports",
16458 "group": "Mail_Queue_Reports",
16459 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16460 "version": "0.0.0",
16461 "filename": "server/api/mailQueueReport/index.js",
16462 "groupTitle": "Mail_Queue_Reports"
16466 "url": "/api/mail/queues/{id}/users",
16467 "title": "Add agents to a queue",
16470 "title": "Example usage:",
16471 "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",
16475 "name": "AddAgents",
16476 "group": "Mail_Queues",
16477 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16478 "version": "0.0.0",
16479 "filename": "server/api/mailQueue/index.js",
16480 "groupTitle": "Mail_Queues"
16484 "url": "/api/mail/queues/{id}/teams",
16485 "title": "Add teams to a queue",
16488 "title": "Example usage:",
16489 "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",
16493 "name": "AddTeams",
16494 "group": "Mail_Queues",
16495 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16496 "version": "0.0.0",
16497 "filename": "server/api/mailQueue/index.js",
16498 "groupTitle": "Mail_Queues"
16502 "url": "/api/mail/queues",
16503 "title": "Creates a new Queue",
16506 "title": "Example usage:",
16507 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16511 "name": "CreateQueues",
16512 "group": "Mail_Queues",
16527 "field": "description",
16534 "field": "timeout",
16546 "field": "strategy",
16552 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16553 "version": "0.0.0",
16554 "filename": "server/api/mailQueue/index.js",
16555 "groupTitle": "Mail_Queues"
16559 "url": "/api/mail/queues/{id}",
16560 "title": "Deletes a Queue",
16563 "title": "Example usage:",
16564 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16568 "name": "DeleteQueues",
16569 "group": "Mail_Queues",
16570 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16571 "version": "0.0.0",
16572 "filename": "server/api/mailQueue/index.js",
16573 "groupTitle": "Mail_Queues"
16577 "url": "/api/mail/queues/describe",
16578 "title": "Gets table info about Queues",
16581 "title": "Example usage:",
16582 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16586 "name": "DescribeQueues",
16587 "group": "Mail_Queues",
16588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16589 "version": "0.0.0",
16590 "filename": "server/api/mailQueue/index.js",
16591 "groupTitle": "Mail_Queues"
16595 "url": "/api/mail/queues/{id}/users",
16596 "title": "Gets queue agents",
16599 "title": "Example usage:",
16600 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16604 "name": "GetAgents",
16605 "group": "Mail_Queues",
16606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16607 "version": "0.0.0",
16608 "filename": "server/api/mailQueue/index.js",
16609 "groupTitle": "Mail_Queues"
16613 "url": "/api/mail/queues/{id}/members",
16614 "title": "GetMembers",
16617 "title": "Example usage:",
16618 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16622 "name": "GetMembers",
16623 "group": "Mail_Queues",
16624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16625 "version": "0.0.0",
16626 "filename": "server/api/mailQueue/index.js",
16627 "groupTitle": "Mail_Queues"
16631 "url": "/api/mail/queues",
16632 "title": "Gets a list of Queues",
16635 "title": "Example usage:",
16636 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16640 "name": "GetQueues",
16641 "group": "Mail_Queues",
16642 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16643 "version": "0.0.0",
16644 "filename": "server/api/mailQueue/index.js",
16645 "groupTitle": "Mail_Queues"
16649 "url": "/api/mail/queues/{id}/teams",
16650 "title": "Gets queues list",
16653 "title": "Example usage:",
16654 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16658 "name": "GetTeams",
16659 "group": "Mail_Queues",
16660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16661 "version": "0.0.0",
16662 "filename": "server/api/mailQueue/index.js",
16663 "groupTitle": "Mail_Queues"
16667 "url": "/api/mail/queues/{id}/users",
16668 "title": "Removes agents from a queue",
16671 "title": "Example usage:",
16672 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16676 "name": "RemoveAgents",
16677 "group": "Mail_Queues",
16678 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679 "version": "0.0.0",
16680 "filename": "server/api/mailQueue/index.js",
16681 "groupTitle": "Mail_Queues"
16685 "url": "/api/mail/queues/{id}",
16686 "title": "Gets a single Queue",
16689 "title": "Example usage:",
16690 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16694 "name": "ShowQueues",
16695 "group": "Mail_Queues",
16696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16697 "version": "0.0.0",
16698 "filename": "server/api/mailQueue/index.js",
16699 "groupTitle": "Mail_Queues"
16703 "url": "/api/mail/queues/{id}",
16704 "title": "Update an existing Queue",
16707 "title": "Example usage:",
16708 "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",
16712 "name": "updateQueues",
16713 "group": "Mail_Queues",
16714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16715 "version": "0.0.0",
16716 "filename": "server/api/mailQueue/index.js",
16717 "groupTitle": "Mail_Queues"
16721 "url": "/api/mail/out_servers",
16722 "title": "Creates a new SMTP",
16725 "title": "Example usage:",
16726 "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",
16730 "name": "CreateSMTPs",
16731 "group": "Mail_SMTP",
16739 "field": "description",
16781 "field": "service",
16788 "field": "authentication",
16794 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16795 "version": "0.0.0",
16796 "filename": "server/api/mailServerOut/index.js",
16797 "groupTitle": "Mail_SMTP"
16801 "url": "/api/mail/out_servers/{id}",
16802 "title": "Deletes a SMTP",
16805 "title": "Example usage:",
16806 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16810 "name": "DeleteSMTPs",
16811 "group": "Mail_SMTP",
16812 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16813 "version": "0.0.0",
16814 "filename": "server/api/mailServerOut/index.js",
16815 "groupTitle": "Mail_SMTP"
16819 "url": "/api/mail/out_servers",
16820 "title": "Gets a list of SMTPs",
16823 "title": "Example usage:",
16824 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16828 "name": "GetSMTPs",
16829 "group": "Mail_SMTP",
16830 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16831 "version": "0.0.0",
16832 "filename": "server/api/mailServerOut/index.js",
16833 "groupTitle": "Mail_SMTP"
16837 "url": "/api/mail/out_servers/{id}",
16838 "title": "Gets a single SMTP",
16841 "title": "Example usage:",
16842 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16846 "name": "ShowSMTPs",
16847 "group": "Mail_SMTP",
16848 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16849 "version": "0.0.0",
16850 "filename": "server/api/mailServerOut/index.js",
16851 "groupTitle": "Mail_SMTP"
16855 "url": "/api/mail/out_servers/{id}",
16856 "title": "Update an existing SMTP",
16859 "title": "Example usage:",
16860 "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",
16864 "name": "updateSMTPs",
16865 "group": "Mail_SMTP",
16866 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16867 "version": "0.0.0",
16868 "filename": "server/api/mailServerOut/index.js",
16869 "groupTitle": "Mail_SMTP"
16873 "url": "/api/mail/substatuses",
16874 "title": "Creates a new Queue",
16877 "title": "Example usage:",
16878 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16882 "name": "CreateSubstatuses",
16883 "group": "Mail_Substatuses",
16898 "field": "description",
16904 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16905 "version": "0.0.0",
16906 "filename": "server/api/mailSubstatus/index.js",
16907 "groupTitle": "Mail_Substatuses"
16911 "url": "/api/mail/substatuses/{id}",
16912 "title": "Deletes a Queue",
16915 "title": "Example usage:",
16916 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16920 "name": "DeleteSubstatuses",
16921 "group": "Mail_Substatuses",
16922 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16923 "version": "0.0.0",
16924 "filename": "server/api/mailSubstatus/index.js",
16925 "groupTitle": "Mail_Substatuses"
16929 "url": "/api/mail/substatuses/describe",
16930 "title": "Gets table info about Substatuses",
16933 "title": "Example usage:",
16934 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16938 "name": "DescribeSubstatuses",
16939 "group": "Mail_Substatuses",
16940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16941 "version": "0.0.0",
16942 "filename": "server/api/mailSubstatus/index.js",
16943 "groupTitle": "Mail_Substatuses"
16947 "url": "/api/mail/substatuses",
16948 "title": "Gets a list of Substatuses",
16951 "title": "Example usage:",
16952 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16956 "name": "GetSubstatuses",
16957 "group": "Mail_Substatuses",
16958 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16959 "version": "0.0.0",
16960 "filename": "server/api/mailSubstatus/index.js",
16961 "groupTitle": "Mail_Substatuses"
16965 "url": "/api/mail/substatuses/{id}",
16966 "title": "Gets a single Queue",
16969 "title": "Example usage:",
16970 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16974 "name": "ShowSubstatuses",
16975 "group": "Mail_Substatuses",
16976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16977 "version": "0.0.0",
16978 "filename": "server/api/mailSubstatus/index.js",
16979 "groupTitle": "Mail_Substatuses"
16983 "url": "/api/mail/substatuses/{id}",
16984 "title": "Update an existing Queue",
16987 "title": "Example usage:",
16988 "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",
16992 "name": "updateSubstatuses",
16993 "group": "Mail_Substatuses",
16994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16995 "version": "0.0.0",
16996 "filename": "server/api/mailSubstatus/index.js",
16997 "groupTitle": "Mail_Substatuses"
17001 "url": "/api/mail/reports/transfer",
17002 "title": "Creates a new Mail Transfer Report",
17005 "title": "Example usage:",
17006 "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",
17010 "name": "CreateMail_Transfer_Reports",
17011 "group": "Mail_Transfer_Reports",
17019 "field": "uniqueid",
17038 "field": "transferredAt",
17044 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17045 "version": "0.0.0",
17046 "filename": "server/api/mailTransferReport/index.js",
17047 "groupTitle": "Mail_Transfer_Reports"
17051 "url": "/api/mail/reports/transfer/{id}",
17052 "title": "Deletes a Mail Transfer Report",
17055 "title": "Example usage:",
17056 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17060 "name": "DeleteMail_Transfer_Reports",
17061 "group": "Mail_Transfer_Reports",
17062 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17063 "version": "0.0.0",
17064 "filename": "server/api/mailTransferReport/index.js",
17065 "groupTitle": "Mail_Transfer_Reports"
17069 "url": "/api/mail/reports/transfer/describe",
17070 "title": "Gets table info about Mail Transfer Reports",
17073 "title": "Example usage:",
17074 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17078 "name": "DescribeMail_Transfer_Reports",
17079 "group": "Mail_Transfer_Reports",
17080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17081 "version": "0.0.0",
17082 "filename": "server/api/mailTransferReport/index.js",
17083 "groupTitle": "Mail_Transfer_Reports"
17087 "url": "/api/mail/reports/transfer",
17088 "title": "Gets a list of Mail Transfer Reports",
17091 "title": "Example usage:",
17092 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17096 "name": "GetMail_Transfer_Reports",
17097 "group": "Mail_Transfer_Reports",
17098 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17099 "version": "0.0.0",
17100 "filename": "server/api/mailTransferReport/index.js",
17101 "groupTitle": "Mail_Transfer_Reports"
17105 "url": "/api/mail/reports/transfer/{id}",
17106 "title": "Gets a single Mail Transfer Report",
17109 "title": "Example usage:",
17110 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17114 "name": "ShowMail_Transfer_Reports",
17115 "group": "Mail_Transfer_Reports",
17116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17117 "version": "0.0.0",
17118 "filename": "server/api/mailTransferReport/index.js",
17119 "groupTitle": "Mail_Transfer_Reports"
17123 "url": "/api/mail/reports/transfer/{id}",
17124 "title": "Update an existing Mail Transfer Report",
17127 "title": "Example usage:",
17128 "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",
17132 "name": "updateMail_Transfer_Reports",
17133 "group": "Mail_Transfer_Reports",
17134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17135 "version": "0.0.0",
17136 "filename": "server/api/mailTransferReport/index.js",
17137 "groupTitle": "Mail_Transfer_Reports"
17141 "url": "/api/members/reports/describe",
17142 "title": "Gets table info about Member Reports",
17145 "title": "Example usage:",
17146 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17150 "name": "DescribeMember_Reports",
17151 "group": "Member_Reports",
17152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17153 "version": "0.0.0",
17154 "filename": "server/api/memberReport/index.js",
17155 "groupTitle": "Member_Reports"
17159 "url": "/api/members/reports",
17160 "title": "Gets a list of Member Reports",
17163 "title": "Example usage:",
17164 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17168 "name": "GetMember_Reports",
17169 "group": "Member_Reports",
17170 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17171 "version": "0.0.0",
17172 "filename": "server/api/memberReport/index.js",
17173 "groupTitle": "Member_Reports"
17177 "url": "/api/members/reports/{id}",
17178 "title": "Gets a single Member Report",
17181 "title": "Example usage:",
17182 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17186 "name": "ShowMember_Reports",
17187 "group": "Member_Reports",
17188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17189 "version": "0.0.0",
17190 "filename": "server/api/memberReport/index.js",
17191 "groupTitle": "Member_Reports"
17195 "url": "/api/migrations",
17196 "title": "Gets a list of Migrations",
17199 "title": "Example usage:",
17200 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17204 "name": "GetMigrations",
17205 "group": "Migrations",
17206 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17207 "version": "0.0.0",
17208 "filename": "server/api/migration/index.js",
17209 "groupTitle": "Migrations"
17213 "url": "/api/voice/networks",
17214 "title": "Create a new network",
17217 "title": "Example usage:",
17218 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17223 "group": "Networks",
17224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17225 "version": "0.0.0",
17226 "filename": "server/api/network/index.js",
17227 "groupTitle": "Networks"
17231 "url": "/api/voice/networks/{id}",
17232 "title": "Deletes a network",
17235 "title": "Example usage:",
17236 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17241 "group": "Networks",
17242 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17243 "version": "0.0.0",
17244 "filename": "server/api/network/index.js",
17245 "groupTitle": "Networks"
17249 "url": "/api/networks",
17250 "title": "Gets a list of Networks",
17253 "title": "Example usage:",
17254 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17258 "name": "GetNetworks",
17259 "group": "Networks",
17260 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17261 "version": "0.0.0",
17262 "filename": "server/api/network/index.js",
17263 "groupTitle": "Networks"
17267 "url": "/api/networks/{id}",
17268 "title": "Gets a single Network",
17271 "title": "Example usage:",
17272 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17276 "name": "ShowNetworks",
17277 "group": "Networks",
17278 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17279 "version": "0.0.0",
17280 "filename": "server/api/network/index.js",
17281 "groupTitle": "Networks"
17285 "url": "/api/voice/networks/{id}",
17286 "title": "Update an existing network",
17289 "title": "Example usage:",
17290 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17295 "group": "Networks",
17296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17297 "version": "0.0.0",
17298 "filename": "server/api/network/index.js",
17299 "groupTitle": "Networks"
17303 "url": "/api/openchannel/accounts/{id}/users",
17304 "title": "Add agents to a openchannel account",
17307 "title": "Example usage:",
17308 "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",
17312 "name": "AddAgents",
17313 "group": "Openchannel_Accounts",
17314 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17315 "version": "0.0.0",
17316 "filename": "server/api/openchannelAccount/index.js",
17317 "groupTitle": "Openchannel_Accounts"
17321 "url": "/api/openchannel/accounts",
17322 "title": "Creates a new Account",
17325 "title": "Example usage:",
17326 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17330 "name": "CreateAccounts",
17331 "group": "Openchannel_Accounts",
17346 "field": "description",
17360 "field": "replyUri",
17374 "field": "notificationTemplate",
17381 "field": "notificationSound",
17388 "field": "notificationShake",
17395 "field": "waitForTheAssignedAgent",
17409 "field": "queueTransfer",
17416 "field": "queueTransferTimeout",
17423 "field": "agentTransfer",
17430 "field": "agentTransferTimeout",
17437 "field": "mandatoryDispositionPauseId",
17438 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17444 "field": "mandatoryDisposition",
17445 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17450 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17451 "version": "0.0.0",
17452 "filename": "server/api/openchannelAccount/index.js",
17453 "groupTitle": "Openchannel_Accounts"
17457 "url": "/api/openchannel/accounts/{id}",
17458 "title": "Deletes a Account",
17461 "title": "Example usage:",
17462 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17466 "name": "DeleteAccounts",
17467 "group": "Openchannel_Accounts",
17468 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17469 "version": "0.0.0",
17470 "filename": "server/api/openchannelAccount/index.js",
17471 "groupTitle": "Openchannel_Accounts"
17475 "url": "/api/openchannel/accounts/describe",
17476 "title": "Gets table info about Accounts",
17479 "title": "Example usage:",
17480 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17484 "name": "DescribeAccounts",
17485 "group": "Openchannel_Accounts",
17486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17487 "version": "0.0.0",
17488 "filename": "server/api/openchannelAccount/index.js",
17489 "groupTitle": "Openchannel_Accounts"
17493 "url": "/api/openchannel/accounts",
17494 "title": "Gets a list of Accounts",
17497 "title": "Example usage:",
17498 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17502 "name": "GetAccounts",
17503 "group": "Openchannel_Accounts",
17504 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17505 "version": "0.0.0",
17506 "filename": "server/api/openchannelAccount/index.js",
17507 "groupTitle": "Openchannel_Accounts"
17511 "url": "/api/openchannel/accounts/{id}/users",
17512 "title": "Gets agents from openchannel account",
17515 "title": "Example usage:",
17516 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17520 "name": "GetAgents",
17521 "group": "Openchannel_Accounts",
17522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17523 "version": "0.0.0",
17524 "filename": "server/api/openchannelAccount/index.js",
17525 "groupTitle": "Openchannel_Accounts"
17529 "url": "/api/openchannel/accounts/{id}/users",
17530 "title": "Removes agents from a openchannel account",
17533 "title": "Example usage:",
17534 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17538 "name": "RemoveAgents",
17539 "group": "Openchannel_Accounts",
17540 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17541 "version": "0.0.0",
17542 "filename": "server/api/openchannelAccount/index.js",
17543 "groupTitle": "Openchannel_Accounts"
17547 "url": "/api/openchannel/accounts/{id}/canned_answers",
17548 "title": "Removes canned answers from account",
17551 "title": "Example usage:",
17552 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17556 "name": "RemoveAnswers",
17557 "group": "Openchannel_Accounts",
17558 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17559 "version": "0.0.0",
17560 "filename": "server/api/openchannelAccount/index.js",
17561 "groupTitle": "Openchannel_Accounts"
17565 "url": "/api/openchannel/accounts/{id}/dispositions",
17566 "title": "Removes dispositions from account",
17569 "title": "Example usage:",
17570 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17574 "name": "RemoveDispositions",
17575 "group": "Openchannel_Accounts",
17576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17577 "version": "0.0.0",
17578 "filename": "server/api/openchannelAccount/index.js",
17579 "groupTitle": "Openchannel_Accounts"
17583 "url": "/api/openchannel/accounts/{id}",
17584 "title": "Gets a single Account",
17587 "title": "Example usage:",
17588 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17592 "name": "ShowAccounts",
17593 "group": "Openchannel_Accounts",
17594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17595 "version": "0.0.0",
17596 "filename": "server/api/openchannelAccount/index.js",
17597 "groupTitle": "Openchannel_Accounts"
17601 "url": "/api/openchannel/accounts/{id}/canned_answers",
17602 "title": "Creates new canned answer",
17605 "title": "Example usage:",
17606 "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",
17610 "name": "addAnswer",
17611 "group": "Openchannel_Accounts",
17633 "field": "description",
17646 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17647 "version": "0.0.0",
17648 "filename": "server/api/openchannelAccount/index.js",
17649 "groupTitle": "Openchannel_Accounts"
17653 "url": "/api/openchannel/accounts/{id}/applications",
17654 "title": "Creates new applications",
17657 "title": "Example usage:",
17658 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17662 "name": "addApplications",
17663 "group": "Openchannel_Accounts",
17671 "field": "priority",
17685 "field": "appdata",
17692 "field": "description",
17699 "field": "interval",
17705 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17706 "version": "0.0.0",
17707 "filename": "server/api/openchannelAccount/index.js",
17708 "groupTitle": "Openchannel_Accounts"
17712 "url": "/api/openchannel/accounts/{id}/dispositions",
17713 "title": "Creates new disposition",
17716 "title": "Example usage:",
17717 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17721 "name": "addDisposition",
17722 "group": "Openchannel_Accounts",
17749 "field": "description",
17755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17756 "version": "0.0.0",
17757 "filename": "server/api/openchannelAccount/index.js",
17758 "groupTitle": "Openchannel_Accounts"
17762 "url": "/api/openchannel/accounts/{id}/canned_answers",
17763 "title": "Gets account canned answers",
17766 "title": "Example usage:",
17767 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17771 "name": "getAnswers",
17772 "group": "Openchannel_Accounts",
17773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17774 "version": "0.0.0",
17775 "filename": "server/api/openchannelAccount/index.js",
17776 "groupTitle": "Openchannel_Accounts"
17780 "url": "/api/openchannel/accounts/{id}/applications",
17781 "title": "Gets account applications",
17784 "title": "Example usage:",
17785 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17789 "name": "getApplications",
17790 "group": "Openchannel_Accounts",
17791 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17792 "version": "0.0.0",
17793 "filename": "server/api/openchannelAccount/index.js",
17794 "groupTitle": "Openchannel_Accounts"
17798 "url": "/api/openchannel/accounts/{id}/dispositions",
17799 "title": "Gets account dispositions",
17802 "title": "Example usage:",
17803 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17807 "name": "getDispositions",
17808 "group": "Openchannel_Accounts",
17809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17810 "version": "0.0.0",
17811 "filename": "server/api/openchannelAccount/index.js",
17812 "groupTitle": "Openchannel_Accounts"
17816 "url": "/api/openchannel/accounts/{id}/interactions",
17817 "title": "Gets Openchannel Account Interactions",
17820 "title": "Example usage:",
17821 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17825 "name": "getInteractions",
17826 "group": "Openchannel_Accounts",
17827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17828 "version": "0.0.0",
17829 "filename": "server/api/openchannelAccount/index.js",
17830 "groupTitle": "Openchannel_Accounts"
17834 "url": "/api/openchannel/accounts/{id}/notify",
17835 "title": "Notify new message",
17838 "title": "Example usage:",
17839 "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",
17844 "group": "Openchannel_Accounts",
17845 "description": "<p>Motion 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>",
17846 "version": "0.0.0",
17847 "filename": "server/api/openchannelAccount/index.js",
17848 "groupTitle": "Openchannel_Accounts"
17852 "url": "/api/openchannel/accounts/{id}/send",
17853 "title": "Send new openchannel message",
17856 "title": "Example usage:",
17857 "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",
17861 "name": "sendOpenchannel",
17862 "group": "Openchannel_Accounts",
17863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17864 "version": "0.0.0",
17865 "filename": "server/api/openchannelAccount/index.js",
17866 "groupTitle": "Openchannel_Accounts"
17870 "url": "/api/openchannel/accounts/{id}",
17871 "title": "Update an existing Account",
17874 "title": "Example usage:",
17875 "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",
17879 "name": "updateAccounts",
17880 "group": "Openchannel_Accounts",
17881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17882 "version": "0.0.0",
17883 "filename": "server/api/openchannelAccount/index.js",
17884 "groupTitle": "Openchannel_Accounts"
17888 "url": "/api/openchannel/applications",
17889 "title": "Creates a new Application",
17892 "title": "Example usage:",
17893 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17897 "name": "CreateApplications",
17898 "group": "Openchannel_Applications",
17906 "field": "priority",
17920 "field": "appdata",
17927 "field": "description",
17934 "field": "interval",
17940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17941 "version": "0.0.0",
17942 "filename": "server/api/openchannelApplication/index.js",
17943 "groupTitle": "Openchannel_Applications"
17947 "url": "/api/openchannel/applications/{id}",
17948 "title": "Deletes a Application",
17951 "title": "Example usage:",
17952 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17956 "name": "DeleteApplications",
17957 "group": "Openchannel_Applications",
17958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17959 "version": "0.0.0",
17960 "filename": "server/api/openchannelApplication/index.js",
17961 "groupTitle": "Openchannel_Applications"
17965 "url": "/api/openchannel/applications",
17966 "title": "Gets a list of Applications",
17969 "title": "Example usage:",
17970 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17974 "name": "GetApplications",
17975 "group": "Openchannel_Applications",
17976 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17977 "version": "0.0.0",
17978 "filename": "server/api/openchannelApplication/index.js",
17979 "groupTitle": "Openchannel_Applications"
17983 "url": "/api/openchannel/applications/{id}",
17984 "title": "Gets a single Application",
17987 "title": "Example usage:",
17988 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17992 "name": "ShowApplications",
17993 "group": "Openchannel_Applications",
17994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17995 "version": "0.0.0",
17996 "filename": "server/api/openchannelApplication/index.js",
17997 "groupTitle": "Openchannel_Applications"
18001 "url": "/api/openchannel/applications/{id}",
18002 "title": "Update an existing Application",
18005 "title": "Example usage:",
18006 "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",
18010 "name": "updateApplications",
18011 "group": "Openchannel_Applications",
18012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18013 "version": "0.0.0",
18014 "filename": "server/api/openchannelApplication/index.js",
18015 "groupTitle": "Openchannel_Applications"
18019 "url": "/api/openchannel/interactions/{id}/tags",
18020 "title": "Add tags to the interaction",
18023 "title": "Example usage:",
18024 "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",
18029 "group": "Openchannel_Interactions",
18030 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18031 "version": "0.0.0",
18032 "filename": "server/api/openchannelInteraction/index.js",
18033 "groupTitle": "Openchannel_Interactions"
18037 "url": "/api/openchannel/interactions",
18038 "title": "Creates a new Interaction",
18041 "title": "Example usage:",
18042 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18046 "name": "CreateInteractions",
18047 "group": "Openchannel_Interactions",
18062 "field": "closedAt",
18069 "field": "disposition",
18076 "field": "secondDisposition",
18083 "field": "thirdDisposition",
18097 "field": "read1stAt",
18104 "field": "threadId",
18111 "field": "externalUrl",
18118 "field": "lastMsgAt",
18129 "field": "lastMsgDirection",
18142 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18143 "version": "0.0.0",
18144 "filename": "server/api/openchannelInteraction/index.js",
18145 "groupTitle": "Openchannel_Interactions"
18149 "url": "/api/openchannel/interactions/{id}",
18150 "title": "Deletes a Interaction",
18153 "title": "Example usage:",
18154 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18158 "name": "DeleteInteractions",
18159 "group": "Openchannel_Interactions",
18160 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18161 "version": "0.0.0",
18162 "filename": "server/api/openchannelInteraction/index.js",
18163 "groupTitle": "Openchannel_Interactions"
18167 "url": "/api/openchannel/interactions/describe",
18168 "title": "Gets table info about Interactions",
18171 "title": "Example usage:",
18172 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18176 "name": "DescribeInteractions",
18177 "group": "Openchannel_Interactions",
18178 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18179 "version": "0.0.0",
18180 "filename": "server/api/openchannelInteraction/index.js",
18181 "groupTitle": "Openchannel_Interactions"
18185 "url": "/api/openchannel/interactions",
18186 "title": "Gets a list of Interactions",
18189 "title": "Example usage:",
18190 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18194 "name": "GetInteractions",
18195 "group": "Openchannel_Interactions",
18196 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18197 "version": "0.0.0",
18198 "filename": "server/api/openchannelInteraction/index.js",
18199 "groupTitle": "Openchannel_Interactions"
18203 "url": "/api/openchannel/interactions/{id}/tags",
18204 "title": "Removes tags from interaction",
18207 "title": "Example usage:",
18208 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18212 "name": "RemoveTags",
18213 "group": "Openchannel_Interactions",
18214 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18215 "version": "0.0.0",
18216 "filename": "server/api/openchannelInteraction/index.js",
18217 "groupTitle": "Openchannel_Interactions"
18221 "url": "/api/openchannel/interactions/{id}",
18222 "title": "Gets a single Interaction",
18225 "title": "Example usage:",
18226 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18230 "name": "ShowInteractions",
18231 "group": "Openchannel_Interactions",
18232 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18233 "version": "0.0.0",
18234 "filename": "server/api/openchannelInteraction/index.js",
18235 "groupTitle": "Openchannel_Interactions"
18239 "url": "/api/openchannel/interactions/{id}/messages",
18240 "title": "Creates new messages",
18243 "title": "Example usage:",
18244 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18248 "name": "addMessage",
18249 "group": "Openchannel_Interactions",
18282 "field": "direction",
18296 "field": "providerName",
18303 "field": "providerResponse",
18309 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18310 "version": "0.0.0",
18311 "filename": "server/api/openchannelInteraction/index.js",
18312 "groupTitle": "Openchannel_Interactions"
18316 "url": "/api/openchannel/interactions/{id}/download",
18317 "title": "Gets interaction",
18320 "title": "Example usage:",
18321 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18325 "name": "download",
18326 "group": "Openchannel_Interactions",
18327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18328 "version": "0.0.0",
18329 "filename": "server/api/openchannelInteraction/index.js",
18330 "groupTitle": "Openchannel_Interactions"
18334 "url": "/api/openchannel/interactions/{id}/messages",
18335 "title": "Gets interaction messages",
18338 "title": "Example usage:",
18339 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18343 "name": "getMessages",
18344 "group": "Openchannel_Interactions",
18345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18346 "version": "0.0.0",
18347 "filename": "server/api/openchannelInteraction/index.js",
18348 "groupTitle": "Openchannel_Interactions"
18352 "url": "/api/openchannel/interactions/{id}",
18353 "title": "Update an existing Interaction",
18356 "title": "Example usage:",
18357 "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",
18361 "name": "updateInteractions",
18362 "group": "Openchannel_Interactions",
18363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18364 "version": "0.0.0",
18365 "filename": "server/api/openchannelInteraction/index.js",
18366 "groupTitle": "Openchannel_Interactions"
18370 "url": "/api/openchannel/messages",
18371 "title": "Creates a new Message",
18374 "title": "Example usage:",
18375 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18379 "name": "CreateMessages",
18380 "group": "Openchannel_Messages",
18413 "field": "direction",
18427 "field": "providerName",
18434 "field": "providerResponse",
18440 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18441 "version": "0.0.0",
18442 "filename": "server/api/openchannelMessage/index.js",
18443 "groupTitle": "Openchannel_Messages"
18447 "url": "/api/openchannel/messages/{id}",
18448 "title": "Deletes a Message",
18451 "title": "Example usage:",
18452 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18456 "name": "DeleteMessages",
18457 "group": "Openchannel_Messages",
18458 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18459 "version": "0.0.0",
18460 "filename": "server/api/openchannelMessage/index.js",
18461 "groupTitle": "Openchannel_Messages"
18465 "url": "/api/openchannel/messages/describe",
18466 "title": "Gets table info about Messages",
18469 "title": "Example usage:",
18470 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18474 "name": "DescribeMessages",
18475 "group": "Openchannel_Messages",
18476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18477 "version": "0.0.0",
18478 "filename": "server/api/openchannelMessage/index.js",
18479 "groupTitle": "Openchannel_Messages"
18483 "url": "/api/openchannel/messages",
18484 "title": "Gets a list of Messages",
18487 "title": "Example usage:",
18488 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18492 "name": "GetMessages",
18493 "group": "Openchannel_Messages",
18494 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18495 "version": "0.0.0",
18496 "filename": "server/api/openchannelMessage/index.js",
18497 "groupTitle": "Openchannel_Messages"
18501 "url": "/api/openchannel/messages/{id}",
18502 "title": "Gets a single Message",
18505 "title": "Example usage:",
18506 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18510 "name": "ShowMessages",
18511 "group": "Openchannel_Messages",
18512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18513 "version": "0.0.0",
18514 "filename": "server/api/openchannelMessage/index.js",
18515 "groupTitle": "Openchannel_Messages"
18519 "url": "/api/openchannel/messages/{id}/accept",
18520 "title": "Accepts message",
18523 "title": "Example usage:",
18524 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18528 "name": "acceptMessage",
18529 "group": "Openchannel_Messages",
18530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18531 "version": "0.0.0",
18532 "filename": "server/api/openchannelMessage/index.js",
18533 "groupTitle": "Openchannel_Messages"
18537 "url": "/api/openchannel/messages/{id}/reject",
18538 "title": "Rejects message",
18541 "title": "Example usage:",
18542 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18546 "name": "rejectMessage",
18547 "group": "Openchannel_Messages",
18548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18549 "version": "0.0.0",
18550 "filename": "server/api/openchannelMessage/index.js",
18551 "groupTitle": "Openchannel_Messages"
18555 "url": "/api/openchannel/messages/{id}",
18556 "title": "Update an existing Message",
18559 "title": "Example usage:",
18560 "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",
18564 "name": "updateMessages",
18565 "group": "Openchannel_Messages",
18566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18567 "version": "0.0.0",
18568 "filename": "server/api/openchannelMessage/index.js",
18569 "groupTitle": "Openchannel_Messages"
18573 "url": "/api/openchannel/reports/queue",
18574 "title": "Creates a new Openchannel Queue Report",
18577 "title": "Example usage:",
18578 "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",
18582 "name": "CreateOpenchannel_Queue_Reports",
18583 "group": "Openchannel_Queue_Reports",
18591 "field": "uniqueid",
18612 "field": "leaveAt",
18619 "field": "acceptAt",
18639 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18640 "version": "0.0.0",
18641 "filename": "server/api/openchannelQueueReport/index.js",
18642 "groupTitle": "Openchannel_Queue_Reports"
18646 "url": "/api/openchannel/reports/queue/{id}",
18647 "title": "Deletes a Openchannel Queue Report",
18650 "title": "Example usage:",
18651 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18655 "name": "DeleteOpenchannel_Queue_Reports",
18656 "group": "Openchannel_Queue_Reports",
18657 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18658 "version": "0.0.0",
18659 "filename": "server/api/openchannelQueueReport/index.js",
18660 "groupTitle": "Openchannel_Queue_Reports"
18664 "url": "/api/openchannel/reports/queue/describe",
18665 "title": "Gets table info about Openchannel Queue Reports",
18668 "title": "Example usage:",
18669 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18673 "name": "DescribeOpenchannel_Queue_Reports",
18674 "group": "Openchannel_Queue_Reports",
18675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18676 "version": "0.0.0",
18677 "filename": "server/api/openchannelQueueReport/index.js",
18678 "groupTitle": "Openchannel_Queue_Reports"
18682 "url": "/api/openchannel/reports/queue",
18683 "title": "Gets a list of Openchannel Queue Reports",
18686 "title": "Example usage:",
18687 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18691 "name": "GetOpenchannel_Queue_Reports",
18692 "group": "Openchannel_Queue_Reports",
18693 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18694 "version": "0.0.0",
18695 "filename": "server/api/openchannelQueueReport/index.js",
18696 "groupTitle": "Openchannel_Queue_Reports"
18700 "url": "/api/openchannel/reports/queue/{id}",
18701 "title": "Gets a single Openchannel Queue Report",
18704 "title": "Example usage:",
18705 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18709 "name": "ShowOpenchannel_Queue_Reports",
18710 "group": "Openchannel_Queue_Reports",
18711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18712 "version": "0.0.0",
18713 "filename": "server/api/openchannelQueueReport/index.js",
18714 "groupTitle": "Openchannel_Queue_Reports"
18718 "url": "/api/openchannel/reports/queue/{id}",
18719 "title": "Update an existing Openchannel Queue Report",
18722 "title": "Example usage:",
18723 "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",
18727 "name": "updateOpenchannel_Queue_Reports",
18728 "group": "Openchannel_Queue_Reports",
18729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18730 "version": "0.0.0",
18731 "filename": "server/api/openchannelQueueReport/index.js",
18732 "groupTitle": "Openchannel_Queue_Reports"
18736 "url": "/api/openchannel/queues/{id}/users",
18737 "title": "Add agents to a queue",
18740 "title": "Example usage:",
18741 "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",
18745 "name": "AddAgents",
18746 "group": "Openchannel_Queues",
18747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18748 "version": "0.0.0",
18749 "filename": "server/api/openchannelQueue/index.js",
18750 "groupTitle": "Openchannel_Queues"
18754 "url": "/api/openchannel/queues/{id}/teams",
18755 "title": "Add teams to a queue",
18758 "title": "Example usage:",
18759 "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",
18763 "name": "AddTeams",
18764 "group": "Openchannel_Queues",
18765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18766 "version": "0.0.0",
18767 "filename": "server/api/openchannelQueue/index.js",
18768 "groupTitle": "Openchannel_Queues"
18772 "url": "/api/openchannel/queues",
18773 "title": "Creates a new Queue",
18776 "title": "Example usage:",
18777 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18781 "name": "CreateQueues",
18782 "group": "Openchannel_Queues",
18797 "field": "description",
18804 "field": "timeout",
18816 "field": "strategy",
18822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18823 "version": "0.0.0",
18824 "filename": "server/api/openchannelQueue/index.js",
18825 "groupTitle": "Openchannel_Queues"
18829 "url": "/api/openchannel/queues/{id}",
18830 "title": "Deletes a Queue",
18833 "title": "Example usage:",
18834 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18838 "name": "DeleteQueues",
18839 "group": "Openchannel_Queues",
18840 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18841 "version": "0.0.0",
18842 "filename": "server/api/openchannelQueue/index.js",
18843 "groupTitle": "Openchannel_Queues"
18847 "url": "/api/openchannel/queues/describe",
18848 "title": "Gets table info about Queues",
18851 "title": "Example usage:",
18852 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18856 "name": "DescribeQueues",
18857 "group": "Openchannel_Queues",
18858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18859 "version": "0.0.0",
18860 "filename": "server/api/openchannelQueue/index.js",
18861 "groupTitle": "Openchannel_Queues"
18865 "url": "/api/openchannel/queues/{id}/users",
18866 "title": "Gets queue agents",
18869 "title": "Example usage:",
18870 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18874 "name": "GetAgents",
18875 "group": "Openchannel_Queues",
18876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18877 "version": "0.0.0",
18878 "filename": "server/api/openchannelQueue/index.js",
18879 "groupTitle": "Openchannel_Queues"
18883 "url": "/api/openchannel/queues/{id}/members",
18884 "title": "GetMembers",
18887 "title": "Example usage:",
18888 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18892 "name": "GetMembers",
18893 "group": "Openchannel_Queues",
18894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18895 "version": "0.0.0",
18896 "filename": "server/api/openchannelQueue/index.js",
18897 "groupTitle": "Openchannel_Queues"
18901 "url": "/api/openchannel/queues",
18902 "title": "Gets a list of Queues",
18905 "title": "Example usage:",
18906 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18910 "name": "GetQueues",
18911 "group": "Openchannel_Queues",
18912 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18913 "version": "0.0.0",
18914 "filename": "server/api/openchannelQueue/index.js",
18915 "groupTitle": "Openchannel_Queues"
18919 "url": "/api/openchannel/queues/{id}/teams",
18920 "title": "Gets queues list",
18923 "title": "Example usage:",
18924 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18928 "name": "GetTeams",
18929 "group": "Openchannel_Queues",
18930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18931 "version": "0.0.0",
18932 "filename": "server/api/openchannelQueue/index.js",
18933 "groupTitle": "Openchannel_Queues"
18937 "url": "/api/openchannel/queues/{id}/users",
18938 "title": "Removes agents from a queue",
18941 "title": "Example usage:",
18942 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18946 "name": "RemoveAgents",
18947 "group": "Openchannel_Queues",
18948 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18949 "version": "0.0.0",
18950 "filename": "server/api/openchannelQueue/index.js",
18951 "groupTitle": "Openchannel_Queues"
18955 "url": "/api/openchannel/queues/{id}",
18956 "title": "Gets a single Queue",
18959 "title": "Example usage:",
18960 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18964 "name": "ShowQueues",
18965 "group": "Openchannel_Queues",
18966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18967 "version": "0.0.0",
18968 "filename": "server/api/openchannelQueue/index.js",
18969 "groupTitle": "Openchannel_Queues"
18973 "url": "/api/openchannel/queues/{id}",
18974 "title": "Update an existing Queue",
18977 "title": "Example usage:",
18978 "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",
18982 "name": "updateQueues",
18983 "group": "Openchannel_Queues",
18984 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18985 "version": "0.0.0",
18986 "filename": "server/api/openchannelQueue/index.js",
18987 "groupTitle": "Openchannel_Queues"
18991 "url": "/api/openchannel/reports/transfer",
18992 "title": "Creates a new Openchannel Transfer Report",
18995 "title": "Example usage:",
18996 "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",
19000 "name": "CreateOpenchannel_Transfer_Reports",
19001 "group": "Openchannel_Transfer_Reports",
19009 "field": "uniqueid",
19028 "field": "transferredAt",
19034 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19035 "version": "0.0.0",
19036 "filename": "server/api/openchannelTransferReport/index.js",
19037 "groupTitle": "Openchannel_Transfer_Reports"
19041 "url": "/api/openchannel/reports/transfer/{id}",
19042 "title": "Deletes a Openchannel Transfer Report",
19045 "title": "Example usage:",
19046 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19050 "name": "DeleteOpenchannel_Transfer_Reports",
19051 "group": "Openchannel_Transfer_Reports",
19052 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19053 "version": "0.0.0",
19054 "filename": "server/api/openchannelTransferReport/index.js",
19055 "groupTitle": "Openchannel_Transfer_Reports"
19059 "url": "/api/openchannel/reports/transfer/describe",
19060 "title": "Gets table info about Openchannel Transfer Reports",
19063 "title": "Example usage:",
19064 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19068 "name": "DescribeOpenchannel_Transfer_Reports",
19069 "group": "Openchannel_Transfer_Reports",
19070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19071 "version": "0.0.0",
19072 "filename": "server/api/openchannelTransferReport/index.js",
19073 "groupTitle": "Openchannel_Transfer_Reports"
19077 "url": "/api/openchannel/reports/transfer",
19078 "title": "Gets a list of Openchannel Transfer Reports",
19081 "title": "Example usage:",
19082 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19086 "name": "GetOpenchannel_Transfer_Reports",
19087 "group": "Openchannel_Transfer_Reports",
19088 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19089 "version": "0.0.0",
19090 "filename": "server/api/openchannelTransferReport/index.js",
19091 "groupTitle": "Openchannel_Transfer_Reports"
19095 "url": "/api/openchannel/reports/transfer/{id}",
19096 "title": "Gets a single Openchannel Transfer Report",
19099 "title": "Example usage:",
19100 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19104 "name": "ShowOpenchannel_Transfer_Reports",
19105 "group": "Openchannel_Transfer_Reports",
19106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19107 "version": "0.0.0",
19108 "filename": "server/api/openchannelTransferReport/index.js",
19109 "groupTitle": "Openchannel_Transfer_Reports"
19113 "url": "/api/openchannel/reports/transfer/{id}",
19114 "title": "Update an existing Openchannel Transfer Report",
19117 "title": "Example usage:",
19118 "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",
19122 "name": "updateOpenchannel_Transfer_Reports",
19123 "group": "Openchannel_Transfer_Reports",
19124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19125 "version": "0.0.0",
19126 "filename": "server/api/openchannelTransferReport/index.js",
19127 "groupTitle": "Openchannel_Transfer_Reports"
19131 "url": "/api/pauses",
19132 "title": "Creates a new Pause",
19135 "title": "Example usage:",
19136 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19140 "name": "CreatePauses",
19156 "field": "description",
19162 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19163 "version": "0.0.0",
19164 "filename": "server/api/pause/index.js",
19165 "groupTitle": "Pauses"
19169 "url": "/api/pauses/{id}",
19170 "title": "Deletes a Pause",
19173 "title": "Example usage:",
19174 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19178 "name": "DeletePauses",
19180 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/pause/index.js",
19183 "groupTitle": "Pauses"
19187 "url": "/api/pauses",
19188 "title": "Gets a list of Pauses",
19191 "title": "Example usage:",
19192 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19196 "name": "GetPauses",
19198 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19199 "version": "0.0.0",
19200 "filename": "server/api/pause/index.js",
19201 "groupTitle": "Pauses"
19205 "url": "/api/pauses/{id}",
19206 "title": "Gets a single Pause",
19209 "title": "Example usage:",
19210 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19214 "name": "ShowPauses",
19216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19217 "version": "0.0.0",
19218 "filename": "server/api/pause/index.js",
19219 "groupTitle": "Pauses"
19223 "url": "/api/pauses/{id}",
19224 "title": "Update an existing Pause",
19227 "title": "Example usage:",
19228 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19232 "name": "updatePauses",
19234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19235 "version": "0.0.0",
19236 "filename": "server/api/pause/index.js",
19237 "groupTitle": "Pauses"
19241 "url": "/api/plugins",
19242 "title": "Gets a list of Plugins",
19245 "title": "Example usage:",
19246 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19250 "name": "GetPlugins",
19251 "group": "Plugins",
19252 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19253 "version": "0.0.0",
19254 "filename": "server/api/plugin/index.js",
19255 "groupTitle": "Plugins"
19259 "url": "/api/plugins/{id}",
19260 "title": "Gets a single Plugin",
19263 "title": "Example usage:",
19264 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19268 "name": "ShowPlugins",
19269 "group": "Plugins",
19270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19271 "version": "0.0.0",
19272 "filename": "server/api/plugin/index.js",
19273 "groupTitle": "Plugins"
19277 "url": "/api/plugins/{id}",
19278 "title": "Delete a plugin",
19281 "title": "Example usage:",
19282 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19286 "name": "destroyPlugin",
19287 "group": "Plugins",
19288 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19289 "version": "0.0.0",
19290 "filename": "server/api/plugin/index.js",
19291 "groupTitle": "Plugins"
19295 "url": "/api/plugins/{id}/download",
19296 "title": "Download plugin source code",
19299 "title": "Example usage:",
19300 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19304 "name": "download",
19305 "group": "Plugins",
19306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19307 "version": "0.0.0",
19308 "filename": "server/api/plugin/index.js",
19309 "groupTitle": "Plugins"
19313 "url": "/api/plugins/{id}",
19314 "title": "Update an existing plugin",
19317 "title": "Example usage:",
19318 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19322 "name": "updatePlugin",
19323 "group": "Plugins",
19324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19325 "version": "0.0.0",
19326 "filename": "server/api/plugin/index.js",
19327 "groupTitle": "Plugins"
19331 "url": "/api/plugins",
19332 "title": "Upload new plugin",
19335 "title": "Example usage:",
19336 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19340 "name": "uploadPlugin",
19341 "group": "Plugins",
19342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19343 "version": "0.0.0",
19344 "filename": "server/api/plugin/index.js",
19345 "groupTitle": "Plugins"
19349 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19350 "title": "Redirect a plugin request to the specified path",
19353 "title": "Example usage:",
19354 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19358 "name": "webhookPlugin",
19359 "group": "Plugins",
19360 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19361 "version": "0.0.0",
19362 "filename": "server/api/plugin/index.js",
19363 "groupTitle": "Plugins"
19367 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19368 "title": "Redirect a plugin request to the specified path",
19371 "title": "Example usage:",
19372 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19376 "name": "webhookPlugin",
19377 "group": "Plugins",
19378 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19379 "version": "0.0.0",
19380 "filename": "server/api/plugin/index.js",
19381 "groupTitle": "Plugins"
19385 "url": "/api/pm2/{id}",
19386 "title": "Deletes an existing process",
19389 "title": "Example usage:",
19390 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19394 "name": "DeletePm2Process",
19396 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19397 "version": "0.0.0",
19398 "filename": "server/api/pm2/index.js",
19399 "groupTitle": "Pm2"
19403 "url": "/api/pm2/{id}",
19404 "title": "Gets a single pm2 process",
19407 "title": "Example usage:",
19408 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19412 "name": "GetPm2Process",
19414 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19415 "version": "0.0.0",
19416 "filename": "server/api/pm2/index.js",
19417 "groupTitle": "Pm2"
19422 "title": "Gets pm2 processes",
19425 "title": "Example usage:",
19426 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19430 "name": "GetPm2Processes",
19432 "description": "<p>Motion returns the pm2 processes list.</p>",
19433 "version": "0.0.0",
19434 "filename": "server/api/pm2/index.js",
19435 "groupTitle": "Pm2"
19440 "title": "Start a single pm2 process",
19443 "title": "Example usage:",
19444 "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",
19448 "name": "StartPm2Process",
19470 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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"
19477 "url": "/api/pm2/{id}",
19478 "title": "Update an existing process",
19481 "title": "Example usage:",
19482 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19486 "name": "UpdatePm2Process",
19488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19489 "version": "0.0.0",
19490 "filename": "server/api/pm2/index.js",
19491 "groupTitle": "Pm2"
19495 "url": "/api/rpc/campaigns/",
19496 "title": "Gets a list of campaigns",
19499 "title": "Example usage:",
19500 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19504 "name": "Campaigns",
19505 "group": "RPC_Realtime",
19506 "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>",
19507 "version": "0.0.0",
19508 "filename": "server/api/rpc/index.js",
19509 "groupTitle": "RPC_Realtime"
19513 "url": "/api/rpc/fax/accounts",
19514 "title": "Gets a list of FaxAccounts",
19517 "title": "Example usage:",
19518 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19522 "name": "FaxAccounts",
19523 "group": "RPC_Realtime",
19524 "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>",
19525 "version": "0.0.0",
19526 "filename": "server/api/rpc/index.js",
19527 "groupTitle": "RPC_Realtime"
19531 "url": "/api/rpc/agents/:id/capacity",
19532 "title": "Sets agent capacity",
19535 "title": "Example usage:",
19536 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19540 "name": "RTAgentCapacity",
19541 "group": "RPC_Realtime",
19542 "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>",
19543 "version": "0.0.0",
19544 "filename": "server/api/rpc/index.js",
19545 "groupTitle": "RPC_Realtime"
19549 "url": "/api/rpc/agents",
19550 "title": "Gets a list of RTAgents",
19553 "title": "Example usage:",
19554 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19558 "name": "RTAgents",
19559 "group": "RPC_Realtime",
19560 "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>",
19561 "version": "0.0.0",
19562 "filename": "server/api/rpc/index.js",
19563 "groupTitle": "RPC_Realtime"
19567 "url": "/api/rpc/chat/queues",
19568 "title": "Gets a list of RTChatQueues",
19571 "title": "Example usage:",
19572 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19576 "name": "RTChatQueues",
19577 "group": "RPC_Realtime",
19578 "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>",
19579 "version": "0.0.0",
19580 "filename": "server/api/rpc/index.js",
19581 "groupTitle": "RPC_Realtime"
19585 "url": "/api/rpc/fax/queues",
19586 "title": "Gets a list of RTFaxQueues",
19589 "title": "Example usage:",
19590 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19594 "name": "RTFaxQueues",
19595 "group": "RPC_Realtime",
19596 "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>",
19597 "version": "0.0.0",
19598 "filename": "server/api/rpc/index.js",
19599 "groupTitle": "RPC_Realtime"
19603 "url": "/api/rpc/mail/accounts",
19604 "title": "Gets a list of RTMailAccounts",
19607 "title": "Example usage:",
19608 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19612 "name": "RTMailAccounts",
19613 "group": "RPC_Realtime",
19614 "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>",
19615 "version": "0.0.0",
19616 "filename": "server/api/rpc/index.js",
19617 "groupTitle": "RPC_Realtime"
19621 "url": "/api/rpc/mail/queues",
19622 "title": "Gets a list of RTMailQueues",
19625 "title": "Example usage:",
19626 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19630 "name": "RTMailQueues",
19631 "group": "RPC_Realtime",
19632 "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>",
19633 "version": "0.0.0",
19634 "filename": "server/api/rpc/index.js",
19635 "groupTitle": "RPC_Realtime"
19639 "url": "/api/rpc/openchannel/queues",
19640 "title": "Gets a list of RTOpenchannelQueues",
19643 "title": "Example usage:",
19644 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19648 "name": "RTOpenchannelQueues",
19649 "group": "RPC_Realtime",
19650 "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>",
19651 "version": "0.0.0",
19652 "filename": "server/api/rpc/index.js",
19653 "groupTitle": "RPC_Realtime"
19657 "url": "/api/rpc/outbound/channels",
19658 "title": "Gets a list of RTOutboundChannels",
19661 "title": "Example usage:",
19662 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19666 "name": "RTOutboundChannels",
19667 "group": "RPC_Realtime",
19668 "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>",
19669 "version": "0.0.0",
19670 "filename": "server/api/rpc/index.js",
19671 "groupTitle": "RPC_Realtime"
19675 "url": "/api/rpc/sms/queues",
19676 "title": "Gets a list of RTSmsQueues",
19679 "title": "Example usage:",
19680 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19684 "name": "RTSmsQueues",
19685 "group": "RPC_Realtime",
19686 "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>",
19687 "version": "0.0.0",
19688 "filename": "server/api/rpc/index.js",
19689 "groupTitle": "RPC_Realtime"
19693 "url": "/api/rpc/telephones",
19694 "title": "Gets a list of RTTelephones",
19697 "title": "Example usage:",
19698 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19702 "name": "RTTelephones",
19703 "group": "RPC_Realtime",
19704 "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>",
19705 "version": "0.0.0",
19706 "filename": "server/api/rpc/index.js",
19707 "groupTitle": "RPC_Realtime"
19711 "url": "/api/rpc/trunks",
19712 "title": "Gets a list of RTTrunks",
19715 "title": "Example usage:",
19716 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19720 "name": "RTTrunks",
19721 "group": "RPC_Realtime",
19722 "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>",
19723 "version": "0.0.0",
19724 "filename": "server/api/rpc/index.js",
19725 "groupTitle": "RPC_Realtime"
19729 "url": "/api/rpc/voice/channels",
19730 "title": "Gets a list of RTVoiceChannelMixMonitor",
19733 "title": "Example usage:",
19734 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19738 "name": "RTVoiceChannelMixMonitor",
19739 "group": "RPC_Realtime",
19740 "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>",
19741 "version": "0.0.0",
19742 "filename": "server/api/rpc/index.js",
19743 "groupTitle": "RPC_Realtime"
19747 "url": "/api/rpc/voice/channels",
19748 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19751 "title": "Example usage:",
19752 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19756 "name": "RTVoiceChannelStopMixMonitor",
19757 "group": "RPC_Realtime",
19758 "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>",
19759 "version": "0.0.0",
19760 "filename": "server/api/rpc/index.js",
19761 "groupTitle": "RPC_Realtime"
19765 "url": "/api/rpc/voice/channels",
19766 "title": "Gets a list of RTVoiceChannels",
19769 "title": "Example usage:",
19770 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19774 "name": "RTVoiceChannels",
19775 "group": "RPC_Realtime",
19776 "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>",
19777 "version": "0.0.0",
19778 "filename": "server/api/rpc/index.js",
19779 "groupTitle": "RPC_Realtime"
19783 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19784 "title": "Gets a single RTVoiceQueueChannel",
19787 "title": "Example usage:",
19788 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19792 "name": "RTVoiceQueueChannel",
19793 "group": "RPC_Realtime",
19794 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19795 "version": "0.0.0",
19796 "filename": "server/api/rpc/index.js",
19797 "groupTitle": "RPC_Realtime"
19801 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19802 "title": "Hangup a single RTVoiceQueueChannel",
19805 "title": "Example usage:",
19806 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19810 "name": "RTVoiceQueueChannelHangup",
19811 "group": "RPC_Realtime",
19812 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19813 "version": "0.0.0",
19814 "filename": "server/api/rpc/index.js",
19815 "groupTitle": "RPC_Realtime"
19819 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19820 "title": "Hangup a single RTVoiceQueueChannel",
19823 "title": "Example usage:",
19824 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19828 "name": "RTVoiceQueueChannelRedirect",
19829 "group": "RPC_Realtime",
19830 "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>",
19831 "version": "0.0.0",
19832 "filename": "server/api/rpc/index.js",
19833 "groupTitle": "RPC_Realtime"
19837 "url": "/api/rpc/voice/queues/preview/{id}",
19838 "title": "Gets a single preview contact",
19841 "title": "Example usage:",
19842 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19846 "name": "RTVoiceQueuePreview",
19847 "group": "RPC_Realtime",
19848 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19849 "version": "0.0.0",
19850 "filename": "server/api/rpc/index.js",
19851 "groupTitle": "RPC_Realtime"
19855 "url": "/api/rpc/outbound",
19856 "title": "Gets a list of RTOutbound",
19859 "title": "Example usage:",
19860 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19864 "name": "RTVoiceQueues",
19865 "group": "RPC_Realtime",
19866 "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>",
19867 "version": "0.0.0",
19868 "filename": "server/api/rpc/index.js",
19869 "groupTitle": "RPC_Realtime"
19873 "url": "/api/rpc/voice/queues",
19874 "title": "Gets a list of RTVoiceQueues",
19877 "title": "Example usage:",
19878 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19882 "name": "RTVoiceQueues",
19883 "group": "RPC_Realtime",
19884 "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>",
19885 "version": "0.0.0",
19886 "filename": "server/api/rpc/index.js",
19887 "groupTitle": "RPC_Realtime"
19891 "url": "/api/rpc/voice/queues/channels",
19892 "title": "Gets a list of RTVoiceQueuesChannels",
19895 "title": "Example usage:",
19896 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19900 "name": "RTVoiceQueuesChannels",
19901 "group": "RPC_Realtime",
19902 "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>",
19903 "version": "0.0.0",
19904 "filename": "server/api/rpc/index.js",
19905 "groupTitle": "RPC_Realtime"
19909 "url": "/api/rpc/chat/queues/{id}",
19910 "title": "Gets a single RTChatQueue",
19913 "title": "Example usage:",
19914 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19918 "name": "ShowRTChatQueues",
19919 "group": "RPC_Realtime",
19920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19921 "version": "0.0.0",
19922 "filename": "server/api/rpc/index.js",
19923 "groupTitle": "RPC_Realtime"
19927 "url": "/api/rpc/fax/queues/{id}",
19928 "title": "Gets a single RTFaxQueue",
19931 "title": "Example usage:",
19932 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19936 "name": "ShowRTFaxQueues",
19937 "group": "RPC_Realtime",
19938 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19939 "version": "0.0.0",
19940 "filename": "server/api/rpc/index.js",
19941 "groupTitle": "RPC_Realtime"
19945 "url": "/api/rpc/mail/queues/{id}",
19946 "title": "Gets a single RTMailQueue",
19949 "title": "Example usage:",
19950 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19954 "name": "ShowRTMailQueues",
19955 "group": "RPC_Realtime",
19956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19957 "version": "0.0.0",
19958 "filename": "server/api/rpc/index.js",
19959 "groupTitle": "RPC_Realtime"
19963 "url": "/api/rpc/openchannel/queues/{id}",
19964 "title": "Gets a single RTOpenchannelQueue",
19967 "title": "Example usage:",
19968 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19972 "name": "ShowRTOpenchannelQueues",
19973 "group": "RPC_Realtime",
19974 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19975 "version": "0.0.0",
19976 "filename": "server/api/rpc/index.js",
19977 "groupTitle": "RPC_Realtime"
19981 "url": "/api/rpc/sms/queues/{id}",
19982 "title": "Gets a single RTSmsQueue",
19985 "title": "Example usage:",
19986 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19990 "name": "ShowRTSmsQueues",
19991 "group": "RPC_Realtime",
19992 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19993 "version": "0.0.0",
19994 "filename": "server/api/rpc/index.js",
19995 "groupTitle": "RPC_Realtime"
19999 "url": "/api/rpc/voice/queues/{id}",
20000 "title": "Gets a single RTVoiceQueue",
20003 "title": "Example usage:",
20004 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20008 "name": "ShowRTVoiceQueues",
20009 "group": "RPC_Realtime",
20010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20011 "version": "0.0.0",
20012 "filename": "server/api/rpc/index.js",
20013 "groupTitle": "RPC_Realtime"
20017 "url": "/api/rpc/voice/{id}/queues",
20018 "title": "Updates a single VoiceQueue",
20021 "title": "Example usage:",
20022 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20026 "name": "UpdateVoiceQueues",
20027 "group": "RPC_Realtime",
20028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20029 "version": "0.0.0",
20030 "filename": "server/api/rpc/index.js",
20031 "groupTitle": "RPC_Realtime"
20035 "url": "/api/rpc/agents/:id/notify",
20036 "title": "Notify message to a specific agent",
20039 "title": "Example usage:",
20040 "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",
20044 "name": "agentNotify",
20045 "group": "RPC_Realtime",
20046 "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>",
20047 "version": "0.0.0",
20048 "filename": "server/api/rpc/index.js",
20049 "groupTitle": "RPC_Realtime"
20053 "url": "/api/rpc/chat/queues/:id/notify",
20054 "title": "Notify message to a specific queue",
20057 "title": "Example usage:",
20058 "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",
20062 "name": "chatQueueNotify",
20063 "group": "RPC_Realtime",
20064 "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>",
20065 "version": "0.0.0",
20066 "filename": "server/api/rpc/index.js",
20067 "groupTitle": "RPC_Realtime"
20071 "url": "/api/rpc/chat/queues/waitinginteractions",
20072 "title": "Gets a list of chatQueuesWaitingInteractions",
20075 "title": "Example usage:",
20076 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20080 "name": "chatQueuesWaitingInteractions",
20081 "group": "RPC_Realtime",
20082 "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>",
20083 "version": "0.0.0",
20084 "filename": "server/api/rpc/index.js",
20085 "groupTitle": "RPC_Realtime"
20089 "url": "/api/rpc/fax/queues/:id/notify",
20090 "title": "Notify message to a specific queue",
20093 "title": "Example usage:",
20094 "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",
20098 "name": "faxQueueNotify",
20099 "group": "RPC_Realtime",
20100 "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>",
20101 "version": "0.0.0",
20102 "filename": "server/api/rpc/index.js",
20103 "groupTitle": "RPC_Realtime"
20107 "url": "/api/rpc/fax/queues/waitinginteractions",
20108 "title": "Gets a list of faxQueuesWaitingInteractions",
20111 "title": "Example usage:",
20112 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20116 "name": "faxQueuesWaitingInteractions",
20117 "group": "RPC_Realtime",
20118 "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>",
20119 "version": "0.0.0",
20120 "filename": "server/api/rpc/index.js",
20121 "groupTitle": "RPC_Realtime"
20125 "url": "/api/rpc/mail/queues/:id/notify",
20126 "title": "Notify message to a specific queue",
20129 "title": "Example usage:",
20130 "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",
20134 "name": "mailQueueNotify",
20135 "group": "RPC_Realtime",
20136 "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>",
20137 "version": "0.0.0",
20138 "filename": "server/api/rpc/index.js",
20139 "groupTitle": "RPC_Realtime"
20143 "url": "/api/rpc/mail/queues/waitinginteractions",
20144 "title": "Gets a list of mailQueuesWaitingInteractions",
20147 "title": "Example usage:",
20148 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20152 "name": "mailQueuesWaitingInteractions",
20153 "group": "RPC_Realtime",
20154 "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>",
20155 "version": "0.0.0",
20156 "filename": "server/api/rpc/index.js",
20157 "groupTitle": "RPC_Realtime"
20161 "url": "/api/rpc/openchannel/queues/:id/notify",
20162 "title": "Notify message to a specific queue",
20165 "title": "Example usage:",
20166 "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",
20170 "name": "openchannelQueueNotify",
20171 "group": "RPC_Realtime",
20172 "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>",
20173 "version": "0.0.0",
20174 "filename": "server/api/rpc/index.js",
20175 "groupTitle": "RPC_Realtime"
20179 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20180 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20183 "title": "Example usage:",
20184 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20188 "name": "openchannelQueuesIdWaitingInteractions",
20189 "group": "RPC_Realtime",
20190 "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>",
20191 "version": "0.0.0",
20192 "filename": "server/api/rpc/index.js",
20193 "groupTitle": "RPC_Realtime"
20197 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20198 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20201 "title": "Example usage:",
20202 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20206 "name": "openchannelQueuesWaitingInteractions",
20207 "group": "RPC_Realtime",
20208 "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>",
20209 "version": "0.0.0",
20210 "filename": "server/api/rpc/index.js",
20211 "groupTitle": "RPC_Realtime"
20215 "url": "/api/rpc/sms/queues/:id/notify",
20216 "title": "Notify message to a specific queue",
20219 "title": "Example usage:",
20220 "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",
20224 "name": "smsQueueNotify",
20225 "group": "RPC_Realtime",
20226 "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>",
20227 "version": "0.0.0",
20228 "filename": "server/api/rpc/index.js",
20229 "groupTitle": "RPC_Realtime"
20233 "url": "/api/rpc/sms/queues/waitinginteractions",
20234 "title": "Gets a list of smsQueuesWaitingInteractions",
20237 "title": "Example usage:",
20238 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20242 "name": "smsQueuesWaitingInteractions",
20243 "group": "RPC_Realtime",
20244 "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>",
20245 "version": "0.0.0",
20246 "filename": "server/api/rpc/index.js",
20247 "groupTitle": "RPC_Realtime"
20251 "url": "/api/integrations/salesforce/accounts",
20252 "title": "Creates a new Salesforce Account",
20255 "title": "Example usage:",
20256 "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",
20260 "name": "CreateSalesforce_Accounts",
20261 "group": "Salesforce_Accounts",
20276 "field": "description",
20283 "field": "username",
20290 "field": "remoteUri",
20297 "field": "password",
20304 "field": "clientId",
20311 "field": "clientSecret",
20318 "field": "securityToken",
20325 "field": "serverUrl",
20332 "\"integrationTab\"",
20342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20343 "version": "0.0.0",
20344 "filename": "server/api/intSalesforceAccount/index.js",
20345 "groupTitle": "Salesforce_Accounts"
20349 "url": "/api/integrations/salesforce/accounts/{id}",
20350 "title": "Deletes a Salesforce Account",
20353 "title": "Example usage:",
20354 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20358 "name": "DeleteSalesforce_Accounts",
20359 "group": "Salesforce_Accounts",
20360 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20361 "version": "0.0.0",
20362 "filename": "server/api/intSalesforceAccount/index.js",
20363 "groupTitle": "Salesforce_Accounts"
20367 "url": "/api/integrations/salesforce/accounts",
20368 "title": "Gets a list of Salesforce Accounts",
20371 "title": "Example usage:",
20372 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20376 "name": "GetSalesforce_Accounts",
20377 "group": "Salesforce_Accounts",
20378 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20379 "version": "0.0.0",
20380 "filename": "server/api/intSalesforceAccount/index.js",
20381 "groupTitle": "Salesforce_Accounts"
20385 "url": "/api/integrations/salesforce/accounts/{id}",
20386 "title": "Gets a single Salesforce Account",
20389 "title": "Example usage:",
20390 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20394 "name": "ShowSalesforce_Accounts",
20395 "group": "Salesforce_Accounts",
20396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20397 "version": "0.0.0",
20398 "filename": "server/api/intSalesforceAccount/index.js",
20399 "groupTitle": "Salesforce_Accounts"
20403 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20404 "title": "Creates new configuration",
20407 "title": "Example usage:",
20408 "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",
20412 "name": "addConfiguration",
20413 "group": "Salesforce_Accounts",
20414 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20415 "version": "0.0.0",
20416 "filename": "server/api/intSalesforceAccount/index.js",
20417 "groupTitle": "Salesforce_Accounts"
20421 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20422 "title": "Gets account configurations",
20425 "title": "Example usage:",
20426 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20430 "name": "getConfigurations",
20431 "group": "Salesforce_Accounts",
20432 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20433 "version": "0.0.0",
20434 "filename": "server/api/intSalesforceAccount/index.js",
20435 "groupTitle": "Salesforce_Accounts"
20439 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20440 "title": "Gets account fields",
20443 "title": "Example usage:",
20444 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20448 "name": "getFields",
20449 "group": "Salesforce_Accounts",
20450 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20451 "version": "0.0.0",
20452 "filename": "server/api/intSalesforceAccount/index.js",
20453 "groupTitle": "Salesforce_Accounts"
20457 "url": "/api/integrations/salesforce/accounts/{id}",
20458 "title": "Update an existing Salesforce Account",
20461 "title": "Example usage:",
20462 "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",
20466 "name": "updateSalesforce_Accounts",
20467 "group": "Salesforce_Accounts",
20468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20469 "version": "0.0.0",
20470 "filename": "server/api/intSalesforceAccount/index.js",
20471 "groupTitle": "Salesforce_Accounts"
20475 "url": "/api/integrations/salesforce/configurations",
20476 "title": "Creates a new Salesforce Configuration",
20479 "title": "Example usage:",
20480 "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",
20484 "name": "CreateSalesforce_Configurations",
20485 "group": "Salesforce_Configurations",
20500 "field": "description",
20511 "field": "ticketType",
20518 "\"contact_lead\"",
20521 "\"account_contact_lead\"",
20525 "field": "moduleSearch",
20538 "field": "moduleCreate",
20552 "field": "additionalSearchAccount",
20559 "field": "additionalSearchContact",
20566 "field": "additionalSearchLead",
20572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20573 "version": "0.0.0",
20574 "filename": "server/api/intSalesforceConfiguration/index.js",
20575 "groupTitle": "Salesforce_Configurations"
20579 "url": "/api/integrations/salesforce/configurations/{id}",
20580 "title": "Deletes a Salesforce Configuration",
20583 "title": "Example usage:",
20584 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20588 "name": "DeleteSalesforce_Configurations",
20589 "group": "Salesforce_Configurations",
20590 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20591 "version": "0.0.0",
20592 "filename": "server/api/intSalesforceConfiguration/index.js",
20593 "groupTitle": "Salesforce_Configurations"
20597 "url": "/api/integrations/salesforce/configurations",
20598 "title": "Gets a list of Salesforce Configurations",
20601 "title": "Example usage:",
20602 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20606 "name": "GetSalesforce_Configurations",
20607 "group": "Salesforce_Configurations",
20608 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20609 "version": "0.0.0",
20610 "filename": "server/api/intSalesforceConfiguration/index.js",
20611 "groupTitle": "Salesforce_Configurations"
20615 "url": "/api/integrations/salesforce/configurations/{id}",
20616 "title": "Gets a single Salesforce Configuration",
20619 "title": "Example usage:",
20620 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20624 "name": "ShowSalesforce_Configurations",
20625 "group": "Salesforce_Configurations",
20626 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20627 "version": "0.0.0",
20628 "filename": "server/api/intSalesforceConfiguration/index.js",
20629 "groupTitle": "Salesforce_Configurations"
20633 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20634 "title": "Gets configurations descriptions",
20637 "title": "Example usage:",
20638 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20642 "name": "getDescriptions",
20643 "group": "Salesforce_Configurations",
20644 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20645 "version": "0.0.0",
20646 "filename": "server/api/intSalesforceConfiguration/index.js",
20647 "groupTitle": "Salesforce_Configurations"
20651 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20652 "title": "Gets configurations fields",
20655 "title": "Example usage:",
20656 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20660 "name": "getFields",
20661 "group": "Salesforce_Configurations",
20662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20663 "version": "0.0.0",
20664 "filename": "server/api/intSalesforceConfiguration/index.js",
20665 "groupTitle": "Salesforce_Configurations"
20669 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20670 "title": "Gets configurations subjects",
20673 "title": "Example usage:",
20674 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20678 "name": "getSubjects",
20679 "group": "Salesforce_Configurations",
20680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20681 "version": "0.0.0",
20682 "filename": "server/api/intSalesforceConfiguration/index.js",
20683 "groupTitle": "Salesforce_Configurations"
20687 "url": "/api/integrations/salesforce/configurations/{id}",
20688 "title": "Update an existing Salesforce Configuration",
20691 "title": "Example usage:",
20692 "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",
20696 "name": "updateSalesforce_Configurations",
20697 "group": "Salesforce_Configurations",
20698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20699 "version": "0.0.0",
20700 "filename": "server/api/intSalesforceConfiguration/index.js",
20701 "groupTitle": "Salesforce_Configurations"
20705 "url": "/api/integrations/salesforce/fields",
20706 "title": "Creates a new Salesforce Field",
20709 "title": "Example usage:",
20710 "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",
20714 "name": "CreateSalesforce_Fields",
20715 "group": "Salesforce_Fields",
20725 "\"customVariable\"",
20737 "field": "content",
20753 "\"customVariable\""
20756 "field": "keyType",
20763 "field": "keyContent",
20770 "field": "idField",
20777 "field": "variableName",
20783 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20784 "version": "0.0.0",
20785 "filename": "server/api/intSalesforceField/index.js",
20786 "groupTitle": "Salesforce_Fields"
20790 "url": "/api/integrations/salesforce/fields/{id}",
20791 "title": "Deletes a Salesforce Field",
20794 "title": "Example usage:",
20795 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20799 "name": "DeleteSalesforce_Fields",
20800 "group": "Salesforce_Fields",
20801 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20802 "version": "0.0.0",
20803 "filename": "server/api/intSalesforceField/index.js",
20804 "groupTitle": "Salesforce_Fields"
20808 "url": "/api/integrations/salesforce/fields",
20809 "title": "Gets a list of Salesforce Fields",
20812 "title": "Example usage:",
20813 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20817 "name": "GetSalesforce_Fields",
20818 "group": "Salesforce_Fields",
20819 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20820 "version": "0.0.0",
20821 "filename": "server/api/intSalesforceField/index.js",
20822 "groupTitle": "Salesforce_Fields"
20826 "url": "/api/integrations/salesforce/fields/{id}",
20827 "title": "Gets a single Salesforce Field",
20830 "title": "Example usage:",
20831 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20835 "name": "ShowSalesforce_Fields",
20836 "group": "Salesforce_Fields",
20837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20838 "version": "0.0.0",
20839 "filename": "server/api/intSalesforceField/index.js",
20840 "groupTitle": "Salesforce_Fields"
20844 "url": "/api/integrations/salesforce/fields/{id}",
20845 "title": "Update an existing Salesforce Field",
20848 "title": "Example usage:",
20849 "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",
20853 "name": "updateSalesforce_Fields",
20854 "group": "Salesforce_Fields",
20855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20856 "version": "0.0.0",
20857 "filename": "server/api/intSalesforceField/index.js",
20858 "groupTitle": "Salesforce_Fields"
20862 "url": "/api/schedules",
20863 "title": "Creates a new Schedule",
20866 "title": "Example usage:",
20867 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20871 "name": "CreateSchedules",
20872 "group": "Schedules",
20887 "field": "description",
20908 "field": "startAt",
20922 "field": "subtractNumber",
20938 "field": "subtractUnit",
20968 "field": "sendMail",
20996 "field": "sendIfEmpty",
21002 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21003 "version": "0.0.0",
21004 "filename": "server/api/schedule/index.js",
21005 "groupTitle": "Schedules"
21009 "url": "/api/schedules/{id}",
21010 "title": "Deletes a Schedule",
21013 "title": "Example usage:",
21014 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21018 "name": "DeleteSchedules",
21019 "group": "Schedules",
21020 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21021 "version": "0.0.0",
21022 "filename": "server/api/schedule/index.js",
21023 "groupTitle": "Schedules"
21027 "url": "/api/schedules",
21028 "title": "Gets a list of Schedules",
21031 "title": "Example usage:",
21032 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21036 "name": "GetSchedules",
21037 "group": "Schedules",
21038 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21039 "version": "0.0.0",
21040 "filename": "server/api/schedule/index.js",
21041 "groupTitle": "Schedules"
21045 "url": "/api/schedules/{id}",
21046 "title": "Gets a single Schedule",
21049 "title": "Example usage:",
21050 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21054 "name": "ShowSchedules",
21055 "group": "Schedules",
21056 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21057 "version": "0.0.0",
21058 "filename": "server/api/schedule/index.js",
21059 "groupTitle": "Schedules"
21063 "url": "/api/schedules/{id}/run",
21064 "title": "Run Scheduler",
21067 "title": "Example usage:",
21068 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21073 "group": "Schedules",
21074 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21075 "version": "0.0.0",
21076 "filename": "server/api/schedule/index.js",
21077 "groupTitle": "Schedules"
21081 "url": "/api/schedules/{id}",
21082 "title": "Update an existing Schedule",
21085 "title": "Example usage:",
21086 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21090 "name": "updateSchedules",
21091 "group": "Schedules",
21092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21093 "version": "0.0.0",
21094 "filename": "server/api/schedule/index.js",
21095 "groupTitle": "Schedules"
21099 "url": "/api/screen/recordings",
21100 "title": "Creates a new Recording",
21103 "title": "Example usage:",
21104 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21108 "name": "CreateRecordings",
21109 "group": "Screen_Recordings",
21124 "field": "interactionid",
21131 "field": "channel",
21152 "field": "duration",
21159 "field": "startedAt",
21166 "field": "closedAt",
21173 "field": "createdAt",
21180 "field": "updatedAt",
21186 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21187 "version": "0.0.0",
21188 "filename": "server/api/screenRecording/index.js",
21189 "groupTitle": "Screen_Recordings"
21193 "url": "/api/screen/recordings/describe",
21194 "title": "Gets table info about Recordings",
21197 "title": "Example usage:",
21198 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21202 "name": "DescribeRecordings",
21203 "group": "Screen_Recordings",
21204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21205 "version": "0.0.0",
21206 "filename": "server/api/screenRecording/index.js",
21207 "groupTitle": "Screen_Recordings"
21211 "url": "/api/screen/recordings",
21212 "title": "Gets a list of Recordings",
21215 "title": "Example usage:",
21216 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21220 "name": "GetRecordings",
21221 "group": "Screen_Recordings",
21222 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21223 "version": "0.0.0",
21224 "filename": "server/api/screenRecording/index.js",
21225 "groupTitle": "Screen_Recordings"
21229 "url": "/api/screen/recordings/{id}",
21230 "title": "Gets a single Recording",
21233 "title": "Example usage:",
21234 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21238 "name": "ShowRecordings",
21239 "group": "Screen_Recordings",
21240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21241 "version": "0.0.0",
21242 "filename": "server/api/screenRecording/index.js",
21243 "groupTitle": "Screen_Recordings"
21247 "url": "/api/screen/recordings/{id}",
21248 "title": "Delete screen recording",
21251 "title": "Example usage:",
21252 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21257 "group": "Screen_Recordings",
21258 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21259 "version": "0.0.0",
21260 "filename": "server/api/screenRecording/index.js",
21261 "groupTitle": "Screen_Recordings"
21265 "url": "/api/screen/recordings/{id}/download",
21266 "title": "Download Recording",
21269 "title": "Example usage:",
21270 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21274 "name": "download",
21275 "group": "Screen_Recordings",
21276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21277 "version": "0.0.0",
21278 "filename": "server/api/screenRecording/index.js",
21279 "groupTitle": "Screen_Recordings"
21283 "url": "/api/screen/recordings/{id}",
21284 "title": "Update an existing Recording",
21287 "title": "Example usage:",
21288 "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",
21292 "name": "updateRecordings",
21293 "group": "Screen_Recordings",
21294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21295 "version": "0.0.0",
21296 "filename": "server/api/screenRecording/index.js",
21297 "groupTitle": "Screen_Recordings"
21301 "url": "/api/integrations/servicenow/accounts",
21302 "title": "Creates a new Servicenow Account",
21305 "title": "Example usage:",
21306 "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",
21310 "name": "CreateServicenow_Accounts",
21311 "group": "Servicenow_Accounts",
21326 "field": "description",
21333 "field": "username",
21340 "field": "password",
21354 "field": "remoteUri",
21361 "field": "serverUrl",
21367 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21368 "version": "0.0.0",
21369 "filename": "server/api/intServicenowAccount/index.js",
21370 "groupTitle": "Servicenow_Accounts"
21374 "url": "/api/integrations/servicenow/accounts/{id}",
21375 "title": "Deletes a Servicenow Account",
21378 "title": "Example usage:",
21379 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21383 "name": "DeleteServicenow_Accounts",
21384 "group": "Servicenow_Accounts",
21385 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21386 "version": "0.0.0",
21387 "filename": "server/api/intServicenowAccount/index.js",
21388 "groupTitle": "Servicenow_Accounts"
21392 "url": "/api/integrations/servicenow/accounts",
21393 "title": "Gets a list of Servicenow Accounts",
21396 "title": "Example usage:",
21397 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21401 "name": "GetServicenow_Accounts",
21402 "group": "Servicenow_Accounts",
21403 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21404 "version": "0.0.0",
21405 "filename": "server/api/intServicenowAccount/index.js",
21406 "groupTitle": "Servicenow_Accounts"
21410 "url": "/api/integrations/servicenow/accounts/{id}",
21411 "title": "Gets a single Servicenow Account",
21414 "title": "Example usage:",
21415 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21419 "name": "ShowServicenow_Accounts",
21420 "group": "Servicenow_Accounts",
21421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21422 "version": "0.0.0",
21423 "filename": "server/api/intServicenowAccount/index.js",
21424 "groupTitle": "Servicenow_Accounts"
21428 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21429 "title": "Creates new configuration",
21432 "title": "Example usage:",
21433 "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",
21437 "name": "addConfiguration",
21438 "group": "Servicenow_Accounts",
21439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21440 "version": "0.0.0",
21441 "filename": "server/api/intServicenowAccount/index.js",
21442 "groupTitle": "Servicenow_Accounts"
21446 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21447 "title": "Gets account configurations",
21450 "title": "Example usage:",
21451 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21455 "name": "getConfigurations",
21456 "group": "Servicenow_Accounts",
21457 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21458 "version": "0.0.0",
21459 "filename": "server/api/intServicenowAccount/index.js",
21460 "groupTitle": "Servicenow_Accounts"
21464 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21465 "title": "Gets account fields",
21468 "title": "Example usage:",
21469 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21473 "name": "getFields",
21474 "group": "Servicenow_Accounts",
21475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21476 "version": "0.0.0",
21477 "filename": "server/api/intServicenowAccount/index.js",
21478 "groupTitle": "Servicenow_Accounts"
21482 "url": "/api/integrations/servicenow/accounts/{id}",
21483 "title": "Update an existing Servicenow Account",
21486 "title": "Example usage:",
21487 "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",
21491 "name": "updateServicenow_Accounts",
21492 "group": "Servicenow_Accounts",
21493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21494 "version": "0.0.0",
21495 "filename": "server/api/intServicenowAccount/index.js",
21496 "groupTitle": "Servicenow_Accounts"
21500 "url": "/api/integrations/servicenow/configurations",
21501 "title": "Creates a new Servicenow Configuration",
21504 "title": "Example usage:",
21505 "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",
21509 "name": "CreateServicenow_Configurations",
21510 "group": "Servicenow_Configurations",
21525 "field": "description",
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/intServicenowConfiguration/index.js",
21534 "groupTitle": "Servicenow_Configurations"
21538 "url": "/api/integrations/servicenow/configurations/{id}",
21539 "title": "Deletes a Servicenow Configuration",
21542 "title": "Example usage:",
21543 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21547 "name": "DeleteServicenow_Configurations",
21548 "group": "Servicenow_Configurations",
21549 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intServicenowConfiguration/index.js",
21552 "groupTitle": "Servicenow_Configurations"
21556 "url": "/api/integrations/servicenow/configurations",
21557 "title": "Gets a list of Servicenow Configurations",
21560 "title": "Example usage:",
21561 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21565 "name": "GetServicenow_Configurations",
21566 "group": "Servicenow_Configurations",
21567 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21568 "version": "0.0.0",
21569 "filename": "server/api/intServicenowConfiguration/index.js",
21570 "groupTitle": "Servicenow_Configurations"
21574 "url": "/api/integrations/servicenow/configurations/{id}",
21575 "title": "Gets a single Servicenow Configuration",
21578 "title": "Example usage:",
21579 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21583 "name": "ShowServicenow_Configurations",
21584 "group": "Servicenow_Configurations",
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/intServicenowConfiguration/index.js",
21588 "groupTitle": "Servicenow_Configurations"
21592 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21593 "title": "Gets configurations descriptions",
21596 "title": "Example usage:",
21597 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21601 "name": "getDescriptions",
21602 "group": "Servicenow_Configurations",
21603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21604 "version": "0.0.0",
21605 "filename": "server/api/intServicenowConfiguration/index.js",
21606 "groupTitle": "Servicenow_Configurations"
21610 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21611 "title": "Gets configurations fields",
21614 "title": "Example usage:",
21615 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21619 "name": "getFields",
21620 "group": "Servicenow_Configurations",
21621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21622 "version": "0.0.0",
21623 "filename": "server/api/intServicenowConfiguration/index.js",
21624 "groupTitle": "Servicenow_Configurations"
21628 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21629 "title": "Gets configurations subjects",
21632 "title": "Example usage:",
21633 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21637 "name": "getSubjects",
21638 "group": "Servicenow_Configurations",
21639 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21640 "version": "0.0.0",
21641 "filename": "server/api/intServicenowConfiguration/index.js",
21642 "groupTitle": "Servicenow_Configurations"
21646 "url": "/api/integrations/servicenow/configurations/{id}",
21647 "title": "Update an existing Servicenow Configuration",
21650 "title": "Example usage:",
21651 "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",
21655 "name": "updateServicenow_Configurations",
21656 "group": "Servicenow_Configurations",
21657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21658 "version": "0.0.0",
21659 "filename": "server/api/intServicenowConfiguration/index.js",
21660 "groupTitle": "Servicenow_Configurations"
21664 "url": "/api/integrations/servicenow/fields",
21665 "title": "Creates a new Servicenow Field",
21668 "title": "Example usage:",
21669 "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",
21673 "name": "CreateServicenow_Fields",
21674 "group": "Servicenow_Fields",
21684 "\"customVariable\"",
21696 "field": "content",
21712 "\"customVariable\""
21715 "field": "keyType",
21722 "field": "keyContent",
21729 "field": "idField",
21736 "field": "nameField",
21743 "field": "customField",
21750 "field": "variableName",
21756 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21757 "version": "0.0.0",
21758 "filename": "server/api/intServicenowField/index.js",
21759 "groupTitle": "Servicenow_Fields"
21763 "url": "/api/integrations/servicenow/fields/{id}",
21764 "title": "Deletes a Servicenow Field",
21767 "title": "Example usage:",
21768 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21772 "name": "DeleteServicenow_Fields",
21773 "group": "Servicenow_Fields",
21774 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21775 "version": "0.0.0",
21776 "filename": "server/api/intServicenowField/index.js",
21777 "groupTitle": "Servicenow_Fields"
21781 "url": "/api/integrations/servicenow/fields",
21782 "title": "Gets a list of Servicenow Fields",
21785 "title": "Example usage:",
21786 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21790 "name": "GetServicenow_Fields",
21791 "group": "Servicenow_Fields",
21792 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21793 "version": "0.0.0",
21794 "filename": "server/api/intServicenowField/index.js",
21795 "groupTitle": "Servicenow_Fields"
21799 "url": "/api/integrations/servicenow/fields/{id}",
21800 "title": "Gets a single Servicenow Field",
21803 "title": "Example usage:",
21804 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21808 "name": "ShowServicenow_Fields",
21809 "group": "Servicenow_Fields",
21810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21811 "version": "0.0.0",
21812 "filename": "server/api/intServicenowField/index.js",
21813 "groupTitle": "Servicenow_Fields"
21817 "url": "/api/integrations/servicenow/fields/{id}",
21818 "title": "Update an existing Servicenow Field",
21821 "title": "Example usage:",
21822 "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",
21826 "name": "updateServicenow_Fields",
21827 "group": "Servicenow_Fields",
21828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21829 "version": "0.0.0",
21830 "filename": "server/api/intServicenowField/index.js",
21831 "groupTitle": "Servicenow_Fields"
21835 "url": "/api/settings",
21836 "title": "Gets a list of Settings",
21839 "title": "Example usage:",
21840 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21844 "name": "GetSettings",
21845 "group": "Settings",
21846 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21847 "version": "0.0.0",
21848 "filename": "server/api/setting/index.js",
21849 "groupTitle": "Settings"
21853 "url": "/api/settings/{id}",
21854 "title": "Gets a single Setting",
21857 "title": "Example usage:",
21858 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21862 "name": "ShowSettings",
21863 "group": "Settings",
21864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21865 "version": "0.0.0",
21866 "filename": "server/api/setting/index.js",
21867 "groupTitle": "Settings"
21871 "url": "/api/settings/{id}/favicon",
21872 "title": "Add Favicon",
21875 "title": "Example usage:",
21876 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21880 "name": "addFavicon",
21881 "group": "Settings",
21882 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21883 "version": "0.0.0",
21884 "filename": "server/api/setting/index.js",
21885 "groupTitle": "Settings"
21889 "url": "/api/settings/{id}/logo",
21890 "title": "Add logo",
21893 "title": "Example usage:",
21894 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21899 "group": "Settings",
21900 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21901 "version": "0.0.0",
21902 "filename": "server/api/setting/index.js",
21903 "groupTitle": "Settings"
21907 "url": "/api/settings/{id}/logo_login",
21908 "title": "Add logo login",
21911 "title": "Example usage:",
21912 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21916 "name": "addLogoLogin",
21917 "group": "Settings",
21918 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21919 "version": "0.0.0",
21920 "filename": "server/api/setting/index.js",
21921 "groupTitle": "Settings"
21925 "url": "/api/settings/{id}/preferred",
21926 "title": "Add Preferred",
21929 "title": "Example usage:",
21930 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21934 "name": "addPreferred",
21935 "group": "Settings",
21936 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21937 "version": "0.0.0",
21938 "filename": "server/api/setting/index.js",
21939 "groupTitle": "Settings"
21943 "url": "/api/settings/now",
21944 "title": "Get Server Current Date",
21947 "title": "Example usage:",
21948 "content": "curl https://{domain}/api/settings/now -v -X GET",
21953 "group": "Settings",
21954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21955 "version": "0.0.0",
21956 "filename": "server/api/setting/index.js",
21957 "groupTitle": "Settings"
21961 "url": "/api/settings/{id}/favicon",
21962 "title": "Get Favicon",
21965 "title": "Example usage:",
21966 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21970 "name": "getFavicon",
21971 "group": "Settings",
21972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21973 "version": "0.0.0",
21974 "filename": "server/api/setting/index.js",
21975 "groupTitle": "Settings"
21979 "url": "/api/settings/{id}/gdpr",
21980 "title": "Get gdpr settings",
21983 "title": "Example usage:",
21984 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21989 "group": "Settings",
21990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21991 "version": "0.0.0",
21992 "filename": "server/api/setting/index.js",
21993 "groupTitle": "Settings"
21997 "url": "/api/settings/{id}/logo",
21998 "title": "Get logo",
22001 "title": "Example usage:",
22002 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22007 "group": "Settings",
22008 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22009 "version": "0.0.0",
22010 "filename": "server/api/setting/index.js",
22011 "groupTitle": "Settings"
22015 "url": "/api/settings/{id}/logo_login",
22016 "title": "Get logo login",
22019 "title": "Example usage:",
22020 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22024 "name": "getLogoLogin",
22025 "group": "Settings",
22026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22027 "version": "0.0.0",
22028 "filename": "server/api/setting/index.js",
22029 "groupTitle": "Settings"
22033 "url": "/api/settings/{id}/preferred",
22034 "title": "Get Preferred",
22037 "title": "Example usage:",
22038 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22042 "name": "getPreferred",
22043 "group": "Settings",
22044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22045 "version": "0.0.0",
22046 "filename": "server/api/setting/index.js",
22047 "groupTitle": "Settings"
22051 "url": "/api/settings/{id}",
22052 "title": "Update an existing Setting",
22055 "title": "Example usage:",
22056 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22060 "name": "updateSettings",
22061 "group": "Settings",
22062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22063 "version": "0.0.0",
22064 "filename": "server/api/setting/index.js",
22065 "groupTitle": "Settings"
22069 "url": "/api/sms/accounts/{id}/users",
22070 "title": "Add agents to a sms account",
22073 "title": "Example usage:",
22074 "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",
22078 "name": "AddAgents",
22079 "group": "Sms_Accounts",
22080 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22081 "version": "0.0.0",
22082 "filename": "server/api/smsAccount/index.js",
22083 "groupTitle": "Sms_Accounts"
22087 "url": "/api/sms/accounts",
22088 "title": "Creates a new Account",
22091 "title": "Example usage:",
22092 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22096 "name": "CreateAccounts",
22097 "group": "Sms_Accounts",
22159 "field": "accountSid",
22173 "field": "authToken",
22185 "field": "smsMethod",
22192 "field": "username",
22199 "field": "password",
22213 "field": "applicationId",
22220 "field": "accountId",
22227 "field": "senderString",
22234 "field": "deliveryReport",
22241 "field": "description",
22248 "field": "notificationTemplate",
22255 "field": "notificationSound",
22262 "field": "notificationShake",
22269 "field": "waitForTheAssignedAgent",
22276 "field": "queueTransfer",
22283 "field": "queueTransferTimeout",
22290 "field": "agentTransfer",
22297 "field": "agentTransferTimeout",
22304 "field": "baseUrl",
22311 "field": "mandatoryDispositionPauseId",
22312 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22318 "field": "mandatoryDisposition",
22319 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22324 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22325 "version": "0.0.0",
22326 "filename": "server/api/smsAccount/index.js",
22327 "groupTitle": "Sms_Accounts"
22331 "url": "/api/sms/accounts/{id}",
22332 "title": "Deletes a Account",
22335 "title": "Example usage:",
22336 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22340 "name": "DeleteAccounts",
22341 "group": "Sms_Accounts",
22342 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22343 "version": "0.0.0",
22344 "filename": "server/api/smsAccount/index.js",
22345 "groupTitle": "Sms_Accounts"
22349 "url": "/api/sms/accounts/describe",
22350 "title": "Gets table info about Accounts",
22353 "title": "Example usage:",
22354 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22358 "name": "DescribeAccounts",
22359 "group": "Sms_Accounts",
22360 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22361 "version": "0.0.0",
22362 "filename": "server/api/smsAccount/index.js",
22363 "groupTitle": "Sms_Accounts"
22367 "url": "/api/sms/accounts",
22368 "title": "Gets a list of Accounts",
22371 "title": "Example usage:",
22372 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22376 "name": "GetAccounts",
22377 "group": "Sms_Accounts",
22378 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22379 "version": "0.0.0",
22380 "filename": "server/api/smsAccount/index.js",
22381 "groupTitle": "Sms_Accounts"
22385 "url": "/api/sms/accounts/{id}/users",
22386 "title": "Gets agents from sms account",
22389 "title": "Example usage:",
22390 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22394 "name": "GetAgents",
22395 "group": "Sms_Accounts",
22396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22397 "version": "0.0.0",
22398 "filename": "server/api/smsAccount/index.js",
22399 "groupTitle": "Sms_Accounts"
22403 "url": "/api/sms/accounts/{id}/users",
22404 "title": "Removes agents from a sms account",
22407 "title": "Example usage:",
22408 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22412 "name": "RemoveAgents",
22413 "group": "Sms_Accounts",
22414 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22415 "version": "0.0.0",
22416 "filename": "server/api/smsAccount/index.js",
22417 "groupTitle": "Sms_Accounts"
22421 "url": "/api/sms/accounts/{id}/canned_answers",
22422 "title": "Removes canned answers from account",
22425 "title": "Example usage:",
22426 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22430 "name": "RemoveAnswers",
22431 "group": "Sms_Accounts",
22432 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22433 "version": "0.0.0",
22434 "filename": "server/api/smsAccount/index.js",
22435 "groupTitle": "Sms_Accounts"
22439 "url": "/api/sms/accounts/{id}/dispositions",
22440 "title": "Removes dispositions from account",
22443 "title": "Example usage:",
22444 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22448 "name": "RemoveDispositions",
22449 "group": "Sms_Accounts",
22450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22451 "version": "0.0.0",
22452 "filename": "server/api/smsAccount/index.js",
22453 "groupTitle": "Sms_Accounts"
22457 "url": "/api/sms/accounts/{id}",
22458 "title": "Gets a single Account",
22461 "title": "Example usage:",
22462 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22466 "name": "ShowAccounts",
22467 "group": "Sms_Accounts",
22468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22469 "version": "0.0.0",
22470 "filename": "server/api/smsAccount/index.js",
22471 "groupTitle": "Sms_Accounts"
22475 "url": "/api/sms/messages/{id}/accept",
22476 "title": "Accepts message",
22479 "title": "Example usage:",
22480 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22484 "name": "acceptMessage",
22485 "group": "Sms_Accounts",
22486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22487 "version": "0.0.0",
22488 "filename": "server/api/smsMessage/index.js",
22489 "groupTitle": "Sms_Accounts"
22493 "url": "/api/sms/accounts/{id}/canned_answers",
22494 "title": "Creates new canned answer",
22497 "title": "Example usage:",
22498 "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",
22502 "name": "addAnswer",
22503 "group": "Sms_Accounts",
22525 "field": "description",
22538 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22539 "version": "0.0.0",
22540 "filename": "server/api/smsAccount/index.js",
22541 "groupTitle": "Sms_Accounts"
22545 "url": "/api/sms/accounts/{id}/applications",
22546 "title": "Creates new applications",
22549 "title": "Example usage:",
22550 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22554 "name": "addApplications",
22555 "group": "Sms_Accounts",
22563 "field": "priority",
22577 "field": "appdata",
22584 "field": "description",
22591 "field": "interval",
22597 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22598 "version": "0.0.0",
22599 "filename": "server/api/smsAccount/index.js",
22600 "groupTitle": "Sms_Accounts"
22604 "url": "/api/sms/accounts/{id}/dispositions",
22605 "title": "Creates new disposition",
22608 "title": "Example usage:",
22609 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22613 "name": "addDisposition",
22614 "group": "Sms_Accounts",
22641 "field": "description",
22647 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22648 "version": "0.0.0",
22649 "filename": "server/api/smsAccount/index.js",
22650 "groupTitle": "Sms_Accounts"
22654 "url": "/api/sms/accounts/{id}/canned_answers",
22655 "title": "Gets account canned answers",
22658 "title": "Example usage:",
22659 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22663 "name": "getAnswers",
22664 "group": "Sms_Accounts",
22665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22666 "version": "0.0.0",
22667 "filename": "server/api/smsAccount/index.js",
22668 "groupTitle": "Sms_Accounts"
22672 "url": "/api/sms/accounts/{id}/applications",
22673 "title": "Gets account applications",
22676 "title": "Example usage:",
22677 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22681 "name": "getApplications",
22682 "group": "Sms_Accounts",
22683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22684 "version": "0.0.0",
22685 "filename": "server/api/smsAccount/index.js",
22686 "groupTitle": "Sms_Accounts"
22690 "url": "/api/sms/accounts/{id}/dispositions",
22691 "title": "Gets account dispositions",
22694 "title": "Example usage:",
22695 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22699 "name": "getDispositions",
22700 "group": "Sms_Accounts",
22701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22702 "version": "0.0.0",
22703 "filename": "server/api/smsAccount/index.js",
22704 "groupTitle": "Sms_Accounts"
22708 "url": "/api/sms/accounts/{id}/interactions",
22709 "title": "Gets Sms Account interactions",
22712 "title": "Example usage:",
22713 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22717 "name": "getInteractions",
22718 "group": "Sms_Accounts",
22719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22720 "version": "0.0.0",
22721 "filename": "server/api/smsAccount/index.js",
22722 "groupTitle": "Sms_Accounts"
22726 "url": "/api/sms/accounts/{id}/notify",
22727 "title": "Notify new message",
22730 "title": "Example usage:",
22731 "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",
22736 "group": "Sms_Accounts",
22737 "description": "<p>Motion 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>",
22738 "version": "0.0.0",
22739 "filename": "server/api/smsAccount/index.js",
22740 "groupTitle": "Sms_Accounts"
22744 "url": "/api/sms/messages/{id}/reject",
22745 "title": "Rejects message",
22748 "title": "Example usage:",
22749 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22753 "name": "rejectMessage",
22754 "group": "Sms_Accounts",
22755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22756 "version": "0.0.0",
22757 "filename": "server/api/smsMessage/index.js",
22758 "groupTitle": "Sms_Accounts"
22762 "url": "/api/sms/accounts/{id}/send",
22763 "title": "Send new sms message",
22766 "title": "Example usage:",
22767 "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",
22772 "group": "Sms_Accounts",
22773 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22774 "version": "0.0.0",
22775 "filename": "server/api/smsAccount/index.js",
22776 "groupTitle": "Sms_Accounts"
22780 "url": "/api/sms/accounts/{id}/status",
22781 "title": "Receive message status as get request",
22784 "title": "Example usage:",
22785 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22789 "name": "statusMessage",
22790 "group": "Sms_Accounts",
22791 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22792 "version": "0.0.0",
22793 "filename": "server/api/smsAccount/index.js",
22794 "groupTitle": "Sms_Accounts"
22798 "url": "/api/sms/messages/{id}/status",
22799 "title": "Receive message status",
22802 "title": "Example usage:",
22803 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22807 "name": "statusMessage",
22808 "group": "Sms_Accounts",
22809 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22810 "version": "0.0.0",
22811 "filename": "server/api/smsMessage/index.js",
22812 "groupTitle": "Sms_Accounts"
22816 "url": "/api/sms/accounts/{id}/status",
22817 "title": "Receive message status",
22820 "title": "Example usage:",
22821 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22825 "name": "statusMessage",
22826 "group": "Sms_Accounts",
22827 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22828 "version": "0.0.0",
22829 "filename": "server/api/smsAccount/index.js",
22830 "groupTitle": "Sms_Accounts"
22834 "url": "/api/sms/accounts/{id}",
22835 "title": "Update an existing Account",
22838 "title": "Example usage:",
22839 "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",
22843 "name": "updateAccounts",
22844 "group": "Sms_Accounts",
22845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22846 "version": "0.0.0",
22847 "filename": "server/api/smsAccount/index.js",
22848 "groupTitle": "Sms_Accounts"
22852 "url": "/api/sms/applications",
22853 "title": "Creates a new Application",
22856 "title": "Example usage:",
22857 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22861 "name": "CreateApplications",
22862 "group": "Sms_Applications",
22870 "field": "priority",
22884 "field": "appdata",
22891 "field": "description",
22898 "field": "interval",
22904 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22905 "version": "0.0.0",
22906 "filename": "server/api/smsApplication/index.js",
22907 "groupTitle": "Sms_Applications"
22911 "url": "/api/sms/applications/{id}",
22912 "title": "Deletes a Application",
22915 "title": "Example usage:",
22916 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22920 "name": "DeleteApplications",
22921 "group": "Sms_Applications",
22922 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22923 "version": "0.0.0",
22924 "filename": "server/api/smsApplication/index.js",
22925 "groupTitle": "Sms_Applications"
22929 "url": "/api/sms/applications",
22930 "title": "Gets a list of Applications",
22933 "title": "Example usage:",
22934 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22938 "name": "GetApplications",
22939 "group": "Sms_Applications",
22940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
22941 "version": "0.0.0",
22942 "filename": "server/api/smsApplication/index.js",
22943 "groupTitle": "Sms_Applications"
22947 "url": "/api/sms/applications/{id}",
22948 "title": "Gets a single Application",
22951 "title": "Example usage:",
22952 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22956 "name": "ShowApplications",
22957 "group": "Sms_Applications",
22958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22959 "version": "0.0.0",
22960 "filename": "server/api/smsApplication/index.js",
22961 "groupTitle": "Sms_Applications"
22965 "url": "/api/sms/applications/{id}",
22966 "title": "Update an existing Application",
22969 "title": "Example usage:",
22970 "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",
22974 "name": "updateApplications",
22975 "group": "Sms_Applications",
22976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22977 "version": "0.0.0",
22978 "filename": "server/api/smsApplication/index.js",
22979 "groupTitle": "Sms_Applications"
22983 "url": "/api/sms/interactions/{id}/tags",
22984 "title": "Add tags to the interaction",
22987 "title": "Example usage:",
22988 "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",
22993 "group": "Sms_Interactions",
22994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22995 "version": "0.0.0",
22996 "filename": "server/api/smsInteraction/index.js",
22997 "groupTitle": "Sms_Interactions"
23001 "url": "/api/sms/interactions",
23002 "title": "Creates a new Interaction",
23005 "title": "Example usage:",
23006 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23010 "name": "CreateInteractions",
23011 "group": "Sms_Interactions",
23026 "field": "closedAt",
23033 "field": "disposition",
23040 "field": "secondDisposition",
23047 "field": "thirdDisposition",
23068 "field": "read1stAt",
23079 "field": "firstMsgDirection",
23086 "field": "lastMsgAt",
23097 "field": "lastMsgDirection",
23103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23104 "version": "0.0.0",
23105 "filename": "server/api/smsInteraction/index.js",
23106 "groupTitle": "Sms_Interactions"
23110 "url": "/api/sms/interactions/{id}",
23111 "title": "Deletes a Interaction",
23114 "title": "Example usage:",
23115 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23119 "name": "DeleteInteractions",
23120 "group": "Sms_Interactions",
23121 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23122 "version": "0.0.0",
23123 "filename": "server/api/smsInteraction/index.js",
23124 "groupTitle": "Sms_Interactions"
23128 "url": "/api/sms/interactions/describe",
23129 "title": "Gets table info about Interactions",
23132 "title": "Example usage:",
23133 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23137 "name": "DescribeInteractions",
23138 "group": "Sms_Interactions",
23139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23140 "version": "0.0.0",
23141 "filename": "server/api/smsInteraction/index.js",
23142 "groupTitle": "Sms_Interactions"
23146 "url": "/api/sms/interactions",
23147 "title": "Gets a list of Interactions",
23150 "title": "Example usage:",
23151 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23155 "name": "GetInteractions",
23156 "group": "Sms_Interactions",
23157 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23158 "version": "0.0.0",
23159 "filename": "server/api/smsInteraction/index.js",
23160 "groupTitle": "Sms_Interactions"
23164 "url": "/api/sms/interactions/{id}/tags",
23165 "title": "Removes tags from interaction",
23168 "title": "Example usage:",
23169 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23173 "name": "RemoveTags",
23174 "group": "Sms_Interactions",
23175 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23176 "version": "0.0.0",
23177 "filename": "server/api/smsInteraction/index.js",
23178 "groupTitle": "Sms_Interactions"
23182 "url": "/api/sms/interactions/{id}",
23183 "title": "Gets a single Interaction",
23186 "title": "Example usage:",
23187 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23191 "name": "ShowInteractions",
23192 "group": "Sms_Interactions",
23193 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23194 "version": "0.0.0",
23195 "filename": "server/api/smsInteraction/index.js",
23196 "groupTitle": "Sms_Interactions"
23200 "url": "/api/sms/interactions/{id}/messages",
23201 "title": "Creates new messages",
23204 "title": "Example usage:",
23205 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23209 "name": "addMessage",
23210 "group": "Sms_Interactions",
23236 "field": "direction",
23243 "field": "messageId",
23271 "field": "providerName",
23278 "field": "providerResponse",
23284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23285 "version": "0.0.0",
23286 "filename": "server/api/smsInteraction/index.js",
23287 "groupTitle": "Sms_Interactions"
23291 "url": "/api/sms/interactions/{id}/download",
23292 "title": "Gets interaction",
23295 "title": "Example usage:",
23296 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23300 "name": "download",
23301 "group": "Sms_Interactions",
23302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23303 "version": "0.0.0",
23304 "filename": "server/api/smsInteraction/index.js",
23305 "groupTitle": "Sms_Interactions"
23309 "url": "/api/sms/interactions/{id}/messages",
23310 "title": "Gets interaction messages",
23313 "title": "Example usage:",
23314 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23318 "name": "getMessages",
23319 "group": "Sms_Interactions",
23320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23321 "version": "0.0.0",
23322 "filename": "server/api/smsInteraction/index.js",
23323 "groupTitle": "Sms_Interactions"
23327 "url": "/api/sms/interactions/{id}",
23328 "title": "Update an existing Interaction",
23331 "title": "Example usage:",
23332 "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",
23336 "name": "updateInteractions",
23337 "group": "Sms_Interactions",
23338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23339 "version": "0.0.0",
23340 "filename": "server/api/smsInteraction/index.js",
23341 "groupTitle": "Sms_Interactions"
23345 "url": "/api/sms/messages",
23346 "title": "Creates a new Message",
23349 "title": "Example usage:",
23350 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23354 "name": "CreateMessages",
23355 "group": "Sms_Messages",
23381 "field": "direction",
23388 "field": "messageId",
23416 "field": "providerName",
23423 "field": "providerResponse",
23429 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23430 "version": "0.0.0",
23431 "filename": "server/api/smsMessage/index.js",
23432 "groupTitle": "Sms_Messages"
23436 "url": "/api/sms/messages/{id}",
23437 "title": "Deletes a Message",
23440 "title": "Example usage:",
23441 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23445 "name": "DeleteMessages",
23446 "group": "Sms_Messages",
23447 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23448 "version": "0.0.0",
23449 "filename": "server/api/smsMessage/index.js",
23450 "groupTitle": "Sms_Messages"
23454 "url": "/api/sms/messages/describe",
23455 "title": "Gets table info about Messages",
23458 "title": "Example usage:",
23459 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23463 "name": "DescribeMessages",
23464 "group": "Sms_Messages",
23465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23466 "version": "0.0.0",
23467 "filename": "server/api/smsMessage/index.js",
23468 "groupTitle": "Sms_Messages"
23472 "url": "/api/sms/messages",
23473 "title": "Gets a list of Messages",
23476 "title": "Example usage:",
23477 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23481 "name": "GetMessages",
23482 "group": "Sms_Messages",
23483 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23484 "version": "0.0.0",
23485 "filename": "server/api/smsMessage/index.js",
23486 "groupTitle": "Sms_Messages"
23490 "url": "/api/sms/messages/{id}",
23491 "title": "Gets a single Message",
23494 "title": "Example usage:",
23495 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23499 "name": "ShowMessages",
23500 "group": "Sms_Messages",
23501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23502 "version": "0.0.0",
23503 "filename": "server/api/smsMessage/index.js",
23504 "groupTitle": "Sms_Messages"
23508 "url": "/api/sms/messages/{id}",
23509 "title": "Update an existing Message",
23512 "title": "Example usage:",
23513 "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",
23517 "name": "updateMessages",
23518 "group": "Sms_Messages",
23519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23520 "version": "0.0.0",
23521 "filename": "server/api/smsMessage/index.js",
23522 "groupTitle": "Sms_Messages"
23526 "url": "/api/sms/reports/queue",
23527 "title": "Creates a new Sms Queue Report",
23530 "title": "Example usage:",
23531 "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",
23535 "name": "CreateSms_Queue_Reports",
23536 "group": "Sms_Queue_Reports",
23544 "field": "uniqueid",
23565 "field": "leaveAt",
23572 "field": "acceptAt",
23592 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23593 "version": "0.0.0",
23594 "filename": "server/api/smsQueueReport/index.js",
23595 "groupTitle": "Sms_Queue_Reports"
23599 "url": "/api/sms/reports/queue/{id}",
23600 "title": "Deletes a Sms Queue Report",
23603 "title": "Example usage:",
23604 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23608 "name": "DeleteSms_Queue_Reports",
23609 "group": "Sms_Queue_Reports",
23610 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23611 "version": "0.0.0",
23612 "filename": "server/api/smsQueueReport/index.js",
23613 "groupTitle": "Sms_Queue_Reports"
23617 "url": "/api/sms/reports/queue/describe",
23618 "title": "Gets table info about Sms Queue Reports",
23621 "title": "Example usage:",
23622 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23626 "name": "DescribeSms_Queue_Reports",
23627 "group": "Sms_Queue_Reports",
23628 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23629 "version": "0.0.0",
23630 "filename": "server/api/smsQueueReport/index.js",
23631 "groupTitle": "Sms_Queue_Reports"
23635 "url": "/api/sms/reports/queue",
23636 "title": "Gets a list of Sms Queue Reports",
23639 "title": "Example usage:",
23640 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23644 "name": "GetSms_Queue_Reports",
23645 "group": "Sms_Queue_Reports",
23646 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23647 "version": "0.0.0",
23648 "filename": "server/api/smsQueueReport/index.js",
23649 "groupTitle": "Sms_Queue_Reports"
23653 "url": "/api/sms/reports/queue/{id}",
23654 "title": "Gets a single Sms Queue Report",
23657 "title": "Example usage:",
23658 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23662 "name": "ShowSms_Queue_Reports",
23663 "group": "Sms_Queue_Reports",
23664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23665 "version": "0.0.0",
23666 "filename": "server/api/smsQueueReport/index.js",
23667 "groupTitle": "Sms_Queue_Reports"
23671 "url": "/api/sms/reports/queue/{id}",
23672 "title": "Update an existing Sms Queue Report",
23675 "title": "Example usage:",
23676 "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",
23680 "name": "updateSms_Queue_Reports",
23681 "group": "Sms_Queue_Reports",
23682 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23683 "version": "0.0.0",
23684 "filename": "server/api/smsQueueReport/index.js",
23685 "groupTitle": "Sms_Queue_Reports"
23689 "url": "/api/sms/queues/{id}/users",
23690 "title": "Add agents to a queue",
23693 "title": "Example usage:",
23694 "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",
23698 "name": "AddAgents",
23699 "group": "Sms_Queues",
23700 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23701 "version": "0.0.0",
23702 "filename": "server/api/smsQueue/index.js",
23703 "groupTitle": "Sms_Queues"
23707 "url": "/api/sms/queues/{id}/teams",
23708 "title": "Add teams to a queue",
23711 "title": "Example usage:",
23712 "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",
23716 "name": "AddTeams",
23717 "group": "Sms_Queues",
23718 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23719 "version": "0.0.0",
23720 "filename": "server/api/smsQueue/index.js",
23721 "groupTitle": "Sms_Queues"
23725 "url": "/api/sms/queues",
23726 "title": "Creates a new Queue",
23729 "title": "Example usage:",
23730 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23734 "name": "CreateQueues",
23735 "group": "Sms_Queues",
23750 "field": "description",
23757 "field": "timeout",
23769 "field": "strategy",
23775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23776 "version": "0.0.0",
23777 "filename": "server/api/smsQueue/index.js",
23778 "groupTitle": "Sms_Queues"
23782 "url": "/api/sms/queues/{id}",
23783 "title": "Deletes a Queue",
23786 "title": "Example usage:",
23787 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23791 "name": "DeleteQueues",
23792 "group": "Sms_Queues",
23793 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23794 "version": "0.0.0",
23795 "filename": "server/api/smsQueue/index.js",
23796 "groupTitle": "Sms_Queues"
23800 "url": "/api/sms/queues/describe",
23801 "title": "Gets table info about Queues",
23804 "title": "Example usage:",
23805 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23809 "name": "DescribeQueues",
23810 "group": "Sms_Queues",
23811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23812 "version": "0.0.0",
23813 "filename": "server/api/smsQueue/index.js",
23814 "groupTitle": "Sms_Queues"
23818 "url": "/api/sms/queues/{id}/users",
23819 "title": "Gets queue agents",
23822 "title": "Example usage:",
23823 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23827 "name": "GetAgents",
23828 "group": "Sms_Queues",
23829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23830 "version": "0.0.0",
23831 "filename": "server/api/smsQueue/index.js",
23832 "groupTitle": "Sms_Queues"
23836 "url": "/api/sms/queues/{id}/members",
23837 "title": "GetMembers",
23840 "title": "Example usage:",
23841 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23845 "name": "GetMembers",
23846 "group": "Sms_Queues",
23847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23848 "version": "0.0.0",
23849 "filename": "server/api/smsQueue/index.js",
23850 "groupTitle": "Sms_Queues"
23854 "url": "/api/sms/queues",
23855 "title": "Gets a list of Queues",
23858 "title": "Example usage:",
23859 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23863 "name": "GetQueues",
23864 "group": "Sms_Queues",
23865 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23866 "version": "0.0.0",
23867 "filename": "server/api/smsQueue/index.js",
23868 "groupTitle": "Sms_Queues"
23872 "url": "/api/sms/queues/{id}/teams",
23873 "title": "Gets queues list",
23876 "title": "Example usage:",
23877 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23881 "name": "GetTeams",
23882 "group": "Sms_Queues",
23883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23884 "version": "0.0.0",
23885 "filename": "server/api/smsQueue/index.js",
23886 "groupTitle": "Sms_Queues"
23890 "url": "/api/sms/queues/{id}/users",
23891 "title": "Removes agents from a queue",
23894 "title": "Example usage:",
23895 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23899 "name": "RemoveAgents",
23900 "group": "Sms_Queues",
23901 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23902 "version": "0.0.0",
23903 "filename": "server/api/smsQueue/index.js",
23904 "groupTitle": "Sms_Queues"
23908 "url": "/api/sms/queues/{id}",
23909 "title": "Gets a single Queue",
23912 "title": "Example usage:",
23913 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23917 "name": "ShowQueues",
23918 "group": "Sms_Queues",
23919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23920 "version": "0.0.0",
23921 "filename": "server/api/smsQueue/index.js",
23922 "groupTitle": "Sms_Queues"
23926 "url": "/api/sms/queues/{id}",
23927 "title": "Update an existing Queue",
23930 "title": "Example usage:",
23931 "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",
23935 "name": "updateQueues",
23936 "group": "Sms_Queues",
23937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23938 "version": "0.0.0",
23939 "filename": "server/api/smsQueue/index.js",
23940 "groupTitle": "Sms_Queues"
23944 "url": "/api/sms/reports/transfer",
23945 "title": "Creates a new Sms Transfer Report",
23948 "title": "Example usage:",
23949 "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",
23953 "name": "CreateSms_Transfer_Reports",
23954 "group": "Sms_Transfer_Reports",
23962 "field": "uniqueid",
23981 "field": "transferredAt",
23987 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23988 "version": "0.0.0",
23989 "filename": "server/api/smsTransferReport/index.js",
23990 "groupTitle": "Sms_Transfer_Reports"
23994 "url": "/api/sms/reports/transfer/{id}",
23995 "title": "Deletes a Sms Transfer Report",
23998 "title": "Example usage:",
23999 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24003 "name": "DeleteSms_Transfer_Reports",
24004 "group": "Sms_Transfer_Reports",
24005 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24006 "version": "0.0.0",
24007 "filename": "server/api/smsTransferReport/index.js",
24008 "groupTitle": "Sms_Transfer_Reports"
24012 "url": "/api/sms/reports/transfer/describe",
24013 "title": "Gets table info about Sms Transfer Reports",
24016 "title": "Example usage:",
24017 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24021 "name": "DescribeSms_Transfer_Reports",
24022 "group": "Sms_Transfer_Reports",
24023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24024 "version": "0.0.0",
24025 "filename": "server/api/smsTransferReport/index.js",
24026 "groupTitle": "Sms_Transfer_Reports"
24030 "url": "/api/sms/reports/transfer",
24031 "title": "Gets a list of Sms Transfer Reports",
24034 "title": "Example usage:",
24035 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24039 "name": "GetSms_Transfer_Reports",
24040 "group": "Sms_Transfer_Reports",
24041 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24042 "version": "0.0.0",
24043 "filename": "server/api/smsTransferReport/index.js",
24044 "groupTitle": "Sms_Transfer_Reports"
24048 "url": "/api/sms/reports/transfer/{id}",
24049 "title": "Gets a single Sms Transfer Report",
24052 "title": "Example usage:",
24053 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24057 "name": "ShowSms_Transfer_Reports",
24058 "group": "Sms_Transfer_Reports",
24059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24060 "version": "0.0.0",
24061 "filename": "server/api/smsTransferReport/index.js",
24062 "groupTitle": "Sms_Transfer_Reports"
24066 "url": "/api/sms/reports/transfer/{id}",
24067 "title": "Update an existing Sms Transfer Report",
24070 "title": "Example usage:",
24071 "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",
24075 "name": "updateSms_Transfer_Reports",
24076 "group": "Sms_Transfer_Reports",
24077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24078 "version": "0.0.0",
24079 "filename": "server/api/smsTransferReport/index.js",
24080 "groupTitle": "Sms_Transfer_Reports"
24084 "url": "/api/sounds",
24085 "title": "Gets a list of Sounds",
24088 "title": "Example usage:",
24089 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24093 "name": "GetSounds",
24095 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24096 "version": "0.0.0",
24097 "filename": "server/api/sound/index.js",
24098 "groupTitle": "Sounds"
24102 "url": "/api/sounds/{id}",
24103 "title": "Gets a single Sound",
24106 "title": "Example usage:",
24107 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24111 "name": "ShowSounds",
24113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24114 "version": "0.0.0",
24115 "filename": "server/api/sound/index.js",
24116 "groupTitle": "Sounds"
24120 "url": "/api/sounds",
24121 "title": "Create a new sound",
24124 "title": "Example usage:",
24125 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24129 "name": "addSound",
24131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24132 "version": "0.0.0",
24133 "filename": "server/api/sound/index.js",
24134 "groupTitle": "Sounds"
24138 "url": "/api/sounds/{id}",
24139 "title": "Deletes a sound",
24142 "title": "Example usage:",
24143 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24147 "name": "destroySound",
24149 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24150 "version": "0.0.0",
24151 "filename": "server/api/sound/index.js",
24152 "groupTitle": "Sounds"
24156 "url": "/api/sounds/{id}/download",
24157 "title": "Download Sound",
24160 "title": "Example usage:",
24161 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24165 "name": "download",
24167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24168 "version": "0.0.0",
24169 "filename": "server/api/sound/index.js",
24170 "groupTitle": "Sounds"
24174 "url": "/api/sounds",
24175 "title": "Update an existing new sound",
24178 "title": "Example usage:",
24179 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24183 "name": "updateSound",
24185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24186 "version": "0.0.0",
24187 "filename": "server/api/sound/index.js",
24188 "groupTitle": "Sounds"
24192 "url": "/api/square/details/reports",
24193 "title": "Creates a new Square Detail Report",
24196 "title": "Example usage:",
24197 "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",
24201 "name": "CreateSquare_Detail_Reports",
24202 "group": "Square_Details_Reports",
24210 "field": "uniqueid",
24224 "field": "application",
24238 "field": "project_name",
24245 "field": "callerid",
24251 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24252 "version": "0.0.0",
24253 "filename": "server/api/squareReportDetail/index.js",
24254 "groupTitle": "Square_Details_Reports"
24258 "url": "/api/square/details/reports/{id}",
24259 "title": "Deletes a Square Detail Report",
24262 "title": "Example usage:",
24263 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24267 "name": "DeleteSquare_Detail_Reports",
24268 "group": "Square_Details_Reports",
24269 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24270 "version": "0.0.0",
24271 "filename": "server/api/squareReportDetail/index.js",
24272 "groupTitle": "Square_Details_Reports"
24276 "url": "/api/square/details/reports/describe",
24277 "title": "Gets table info about Square Detail Reports",
24280 "title": "Example usage:",
24281 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24285 "name": "DescribeSquare_Detail_Reports",
24286 "group": "Square_Details_Reports",
24287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24288 "version": "0.0.0",
24289 "filename": "server/api/squareReportDetail/index.js",
24290 "groupTitle": "Square_Details_Reports"
24294 "url": "/api/square/details/reports",
24295 "title": "Gets a list of Square Detail Reports",
24298 "title": "Example usage:",
24299 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24303 "name": "GetSquare_Detail_Reports",
24304 "group": "Square_Details_Reports",
24305 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24306 "version": "0.0.0",
24307 "filename": "server/api/squareReportDetail/index.js",
24308 "groupTitle": "Square_Details_Reports"
24312 "url": "/api/square/details/reports/{id}",
24313 "title": "Gets a single Square Detail Report",
24316 "title": "Example usage:",
24317 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24321 "name": "ShowSquare_Detail_Reports",
24322 "group": "Square_Details_Reports",
24323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24324 "version": "0.0.0",
24325 "filename": "server/api/squareReportDetail/index.js",
24326 "groupTitle": "Square_Details_Reports"
24330 "url": "/api/square/details/reports/{id}",
24331 "title": "Update an existing Square Detail Report",
24334 "title": "Example usage:",
24335 "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",
24339 "name": "updateSquare_Detail_Reports",
24340 "group": "Square_Details_Reports",
24341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24342 "version": "0.0.0",
24343 "filename": "server/api/squareReportDetail/index.js",
24344 "groupTitle": "Square_Details_Reports"
24348 "url": "/api/square/messages",
24349 "title": "Creates a new Message",
24352 "title": "Example usage:",
24353 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24357 "name": "CreateMessages",
24358 "group": "Square_Messages",
24366 "field": "uniqueid",
24384 "field": "direction",
24391 "field": "providerName",
24398 "field": "providerResponse",
24404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24405 "version": "0.0.0",
24406 "filename": "server/api/squareMessage/index.js",
24407 "groupTitle": "Square_Messages"
24411 "url": "/api/square/messages/{id}",
24412 "title": "Deletes a Message",
24415 "title": "Example usage:",
24416 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24420 "name": "DeleteMessages",
24421 "group": "Square_Messages",
24422 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/squareMessage/index.js",
24425 "groupTitle": "Square_Messages"
24429 "url": "/api/square/messages",
24430 "title": "Gets a list of Messages",
24433 "title": "Example usage:",
24434 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24438 "name": "GetMessages",
24439 "group": "Square_Messages",
24440 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24441 "version": "0.0.0",
24442 "filename": "server/api/squareMessage/index.js",
24443 "groupTitle": "Square_Messages"
24447 "url": "/api/square/messages/{id}",
24448 "title": "Gets a single Message",
24451 "title": "Example usage:",
24452 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24456 "name": "ShowMessages",
24457 "group": "Square_Messages",
24458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24459 "version": "0.0.0",
24460 "filename": "server/api/squareMessage/index.js",
24461 "groupTitle": "Square_Messages"
24465 "url": "/api/square/messages/{id}",
24466 "title": "Update an existing Message",
24469 "title": "Example usage:",
24470 "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",
24474 "name": "updateMessages",
24475 "group": "Square_Messages",
24476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24477 "version": "0.0.0",
24478 "filename": "server/api/squareMessage/index.js",
24479 "groupTitle": "Square_Messages"
24483 "url": "/api/square/odbc",
24484 "title": "Creates a new ODBC",
24487 "title": "Example usage:",
24488 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24492 "name": "CreateODBCs",
24493 "group": "Square_ODBC",
24515 "field": "description",
24521 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24522 "version": "0.0.0",
24523 "filename": "server/api/squareOdbc/index.js",
24524 "groupTitle": "Square_ODBC"
24528 "url": "/api/square/odbc/{id}",
24529 "title": "Deletes a ODBC",
24532 "title": "Example usage:",
24533 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24537 "name": "DeleteODBCs",
24538 "group": "Square_ODBC",
24539 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24540 "version": "0.0.0",
24541 "filename": "server/api/squareOdbc/index.js",
24542 "groupTitle": "Square_ODBC"
24546 "url": "/api/square/odbc",
24547 "title": "Gets a list of ODBCs",
24550 "title": "Example usage:",
24551 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24555 "name": "GetODBCs",
24556 "group": "Square_ODBC",
24557 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24558 "version": "0.0.0",
24559 "filename": "server/api/squareOdbc/index.js",
24560 "groupTitle": "Square_ODBC"
24564 "url": "/api/square/odbc/{id}",
24565 "title": "Gets a single ODBC",
24568 "title": "Example usage:",
24569 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24573 "name": "ShowODBCs",
24574 "group": "Square_ODBC",
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/squareOdbc/index.js",
24578 "groupTitle": "Square_ODBC"
24582 "url": "/api/square/odbc/{id}/test",
24583 "title": "Test Odbc",
24586 "title": "Example usage:",
24587 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24592 "group": "Square_ODBC",
24593 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24594 "version": "0.0.0",
24595 "filename": "server/api/squareOdbc/index.js",
24596 "groupTitle": "Square_ODBC"
24600 "url": "/api/square/odbc/{id}",
24601 "title": "Update an existing ODBC",
24604 "title": "Example usage:",
24605 "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",
24609 "name": "updateODBCs",
24610 "group": "Square_ODBC",
24611 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24612 "version": "0.0.0",
24613 "filename": "server/api/squareOdbc/index.js",
24614 "groupTitle": "Square_ODBC"
24618 "url": "/api/square/projects",
24619 "title": "Creates a new Project",
24622 "title": "Example usage:",
24623 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24627 "name": "CreateProjects",
24628 "group": "Square_Projects",
24643 "field": "description",
24657 "field": "preproduction",
24664 "field": "production",
24671 "field": "savedAt",
24678 "field": "publishedAt",
24684 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24685 "version": "0.0.0",
24686 "filename": "server/api/squareProject/index.js",
24687 "groupTitle": "Square_Projects"
24691 "url": "/api/square/projects/{id}",
24692 "title": "Deletes a Project",
24695 "title": "Example usage:",
24696 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24700 "name": "DeleteProjects",
24701 "group": "Square_Projects",
24702 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24703 "version": "0.0.0",
24704 "filename": "server/api/squareProject/index.js",
24705 "groupTitle": "Square_Projects"
24709 "url": "/api/square/projects",
24710 "title": "Gets a list of Projects",
24713 "title": "Example usage:",
24714 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24718 "name": "GetProjects",
24719 "group": "Square_Projects",
24720 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24721 "version": "0.0.0",
24722 "filename": "server/api/squareProject/index.js",
24723 "groupTitle": "Square_Projects"
24727 "url": "/api/square/projects/{id}",
24728 "title": "Gets a single Project",
24731 "title": "Example usage:",
24732 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24736 "name": "ShowProjects",
24737 "group": "Square_Projects",
24738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24739 "version": "0.0.0",
24740 "filename": "server/api/squareProject/index.js",
24741 "groupTitle": "Square_Projects"
24745 "url": "/api/square/projects/{id}/users",
24746 "title": "Adds user permissions to a Project",
24749 "title": "Example usage:",
24750 "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",
24754 "name": "addUsers",
24755 "group": "Square_Projects",
24756 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24757 "version": "0.0.0",
24758 "filename": "server/api/squareProject/index.js",
24759 "groupTitle": "Square_Projects"
24763 "url": "/api/square/projects/{id}/users",
24764 "title": "Gets users permissions from Project",
24767 "title": "Example usage:",
24768 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24772 "name": "getUsers",
24773 "group": "Square_Projects",
24774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24775 "version": "0.0.0",
24776 "filename": "server/api/squareProject/index.js",
24777 "groupTitle": "Square_Projects"
24781 "url": "/api/square/projects/{id}/users",
24782 "title": "Removes user permissions from a Project",
24785 "title": "Example usage:",
24786 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24790 "name": "removeUsers",
24791 "group": "Square_Projects",
24792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24793 "version": "0.0.0",
24794 "filename": "server/api/squareProject/index.js",
24795 "groupTitle": "Square_Projects"
24799 "url": "/api/square/projects/{id}",
24800 "title": "Update an existing Project",
24803 "title": "Example usage:",
24804 "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",
24808 "name": "updateProjects",
24809 "group": "Square_Projects",
24810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24811 "version": "0.0.0",
24812 "filename": "server/api/squareProject/index.js",
24813 "groupTitle": "Square_Projects"
24817 "url": "/api/square/recordings",
24818 "title": "Creates a new Recording",
24821 "title": "Example usage:",
24822 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24826 "name": "CreateRecordings",
24827 "group": "Square_Recordings",
24835 "field": "uniqueid",
24842 "field": "callerid",
24849 "field": "calleridname",
24856 "field": "context",
24863 "field": "extension",
24870 "field": "priority",
24877 "field": "accountcode",
24891 "field": "projectName",
24898 "field": "saveName",
24905 "field": "filename",
24912 "field": "savePath",
24925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24926 "version": "0.0.0",
24927 "filename": "server/api/squareRecording/index.js",
24928 "groupTitle": "Square_Recordings"
24932 "url": "/api/square/recordings",
24933 "title": "Gets a list of Recordings",
24936 "title": "Example usage:",
24937 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24941 "name": "GetRecordings",
24942 "group": "Square_Recordings",
24943 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24944 "version": "0.0.0",
24945 "filename": "server/api/squareRecording/index.js",
24946 "groupTitle": "Square_Recordings"
24950 "url": "/api/square/recordings/{id}",
24951 "title": "Gets a single Recording",
24954 "title": "Example usage:",
24955 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24959 "name": "ShowRecordings",
24960 "group": "Square_Recordings",
24961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24962 "version": "0.0.0",
24963 "filename": "server/api/squareRecording/index.js",
24964 "groupTitle": "Square_Recordings"
24968 "url": "/api/square/recordings/{id}",
24969 "title": "Delete recording",
24972 "title": "Example usage:",
24973 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
24978 "group": "Square_Recordings",
24979 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24980 "version": "0.0.0",
24981 "filename": "server/api/squareRecording/index.js",
24982 "groupTitle": "Square_Recordings"
24986 "url": "/api/square/recordings/{id}/download",
24987 "title": "Download Recording",
24990 "title": "Example usage:",
24991 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24995 "name": "download",
24996 "group": "Square_Recordings",
24997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24998 "version": "0.0.0",
24999 "filename": "server/api/squareRecording/index.js",
25000 "groupTitle": "Square_Recordings"
25004 "url": "/api/square/recordings/{id}",
25005 "title": "Update an existing Recording",
25008 "title": "Example usage:",
25009 "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",
25013 "name": "updateRecordings",
25014 "group": "Square_Recordings",
25015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25016 "version": "0.0.0",
25017 "filename": "server/api/squareRecording/index.js",
25018 "groupTitle": "Square_Recordings"
25022 "url": "/api/square/reports",
25023 "title": "Creates a new Square Report",
25026 "title": "Example usage:",
25027 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25031 "name": "CreateSquare_Reports",
25032 "group": "Square_Reports",
25040 "field": "network",
25047 "field": "network_script",
25054 "field": "request",
25061 "field": "channel",
25068 "field": "language",
25082 "field": "uniqueid",
25089 "field": "version",
25096 "field": "callerid",
25103 "field": "calleridname",
25110 "field": "callingpres",
25117 "field": "callingani2",
25124 "field": "callington",
25131 "field": "callingtns",
25152 "field": "context",
25159 "field": "extension",
25166 "field": "priority",
25173 "field": "enhanced",
25180 "field": "accountcode",
25187 "field": "threadid",
25194 "field": "project_name",
25208 "field": "leaveAt",
25221 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25222 "version": "0.0.0",
25223 "filename": "server/api/squareReport/index.js",
25224 "groupTitle": "Square_Reports"
25228 "url": "/api/square/reports/{id}",
25229 "title": "Deletes a Square Report",
25232 "title": "Example usage:",
25233 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25237 "name": "DeleteSquare_Reports",
25238 "group": "Square_Reports",
25239 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25240 "version": "0.0.0",
25241 "filename": "server/api/squareReport/index.js",
25242 "groupTitle": "Square_Reports"
25246 "url": "/api/square/reports/describe",
25247 "title": "Gets table info about Square Reports",
25250 "title": "Example usage:",
25251 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25255 "name": "DescribeSquare_Reports",
25256 "group": "Square_Reports",
25257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25258 "version": "0.0.0",
25259 "filename": "server/api/squareReport/index.js",
25260 "groupTitle": "Square_Reports"
25264 "url": "/api/square/reports",
25265 "title": "Gets a list of Square Reports",
25268 "title": "Example usage:",
25269 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25273 "name": "GetSquare_Reports",
25274 "group": "Square_Reports",
25275 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25276 "version": "0.0.0",
25277 "filename": "server/api/squareReport/index.js",
25278 "groupTitle": "Square_Reports"
25282 "url": "/api/square/reports/{id}",
25283 "title": "Gets a single Square Report",
25286 "title": "Example usage:",
25287 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25291 "name": "ShowSquare_Reports",
25292 "group": "Square_Reports",
25293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25294 "version": "0.0.0",
25295 "filename": "server/api/squareReport/index.js",
25296 "groupTitle": "Square_Reports"
25300 "url": "/api/square/reports/{id}",
25301 "title": "Update an existing Square Report",
25304 "title": "Example usage:",
25305 "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",
25309 "name": "updateSquare_Reports",
25310 "group": "Square_Reports",
25311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25312 "version": "0.0.0",
25313 "filename": "server/api/squareReport/index.js",
25314 "groupTitle": "Square_Reports"
25318 "url": "/api/integrations/sugarcrm/configurations",
25319 "title": "Creates a new SugarCRM Configuration",
25322 "title": "Example usage:",
25323 "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",
25327 "name": "CreateSugarCRM_Configurations",
25328 "group": "SugarCRM_Configurations",
25343 "field": "description",
25349 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25350 "version": "0.0.0",
25351 "filename": "server/api/intSugarcrmConfiguration/index.js",
25352 "groupTitle": "SugarCRM_Configurations"
25356 "url": "/api/integrations/sugarcrm/configurations/{id}",
25357 "title": "Deletes a SugarCRM Configuration",
25360 "title": "Example usage:",
25361 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25365 "name": "DeleteSugarCRM_Configurations",
25366 "group": "SugarCRM_Configurations",
25367 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25368 "version": "0.0.0",
25369 "filename": "server/api/intSugarcrmConfiguration/index.js",
25370 "groupTitle": "SugarCRM_Configurations"
25374 "url": "/api/integrations/sugarcrm/configurations",
25375 "title": "Gets a list of SugarCRM Configurations",
25378 "title": "Example usage:",
25379 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25383 "name": "GetSugarCRM_Configurations",
25384 "group": "SugarCRM_Configurations",
25385 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25386 "version": "0.0.0",
25387 "filename": "server/api/intSugarcrmConfiguration/index.js",
25388 "groupTitle": "SugarCRM_Configurations"
25392 "url": "/api/integrations/sugarcrm/configurations/{id}",
25393 "title": "Gets a single SugarCRM Configuration",
25396 "title": "Example usage:",
25397 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25401 "name": "ShowSugarCRM_Configurations",
25402 "group": "SugarCRM_Configurations",
25403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25404 "version": "0.0.0",
25405 "filename": "server/api/intSugarcrmConfiguration/index.js",
25406 "groupTitle": "SugarCRM_Configurations"
25410 "url": "/api/integrations/sugarcrm/configurations/{id}",
25411 "title": "Update an existing SugarCRM Configuration",
25414 "title": "Example usage:",
25415 "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",
25419 "name": "updateSugarCRM_Configurations",
25420 "group": "SugarCRM_Configurations",
25421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25422 "version": "0.0.0",
25423 "filename": "server/api/intSugarcrmConfiguration/index.js",
25424 "groupTitle": "SugarCRM_Configurations"
25428 "url": "/api/integrations/sugarcrm/accounts",
25429 "title": "Creates a new Sugarcrm Account",
25432 "title": "Example usage:",
25433 "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",
25437 "name": "CreateSugarcrm_Accounts",
25438 "group": "Sugarcrm_Accounts",
25453 "field": "description",
25460 "field": "username",
25467 "field": "password",
25474 "field": "remoteUri",
25481 "field": "serverUrl",
25487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25488 "version": "0.0.0",
25489 "filename": "server/api/intSugarcrmAccount/index.js",
25490 "groupTitle": "Sugarcrm_Accounts"
25494 "url": "/api/integrations/sugarcrm/accounts/{id}",
25495 "title": "Deletes a Sugarcrm Account",
25498 "title": "Example usage:",
25499 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25503 "name": "DeleteSugarcrm_Accounts",
25504 "group": "Sugarcrm_Accounts",
25505 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25506 "version": "0.0.0",
25507 "filename": "server/api/intSugarcrmAccount/index.js",
25508 "groupTitle": "Sugarcrm_Accounts"
25512 "url": "/api/integrations/sugarcrm/accounts",
25513 "title": "Gets a list of Sugarcrm Accounts",
25516 "title": "Example usage:",
25517 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25521 "name": "GetSugarcrm_Accounts",
25522 "group": "Sugarcrm_Accounts",
25523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25524 "version": "0.0.0",
25525 "filename": "server/api/intSugarcrmAccount/index.js",
25526 "groupTitle": "Sugarcrm_Accounts"
25530 "url": "/api/integrations/sugarcrm/accounts/{id}",
25531 "title": "Gets a single Sugarcrm Account",
25534 "title": "Example usage:",
25535 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25539 "name": "ShowSugarcrm_Accounts",
25540 "group": "Sugarcrm_Accounts",
25541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25542 "version": "0.0.0",
25543 "filename": "server/api/intSugarcrmAccount/index.js",
25544 "groupTitle": "Sugarcrm_Accounts"
25548 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25549 "title": "Creates new configuration",
25552 "title": "Example usage:",
25553 "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",
25557 "name": "addConfiguration",
25558 "group": "Sugarcrm_Accounts",
25559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25560 "version": "0.0.0",
25561 "filename": "server/api/intSugarcrmAccount/index.js",
25562 "groupTitle": "Sugarcrm_Accounts"
25566 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25567 "title": "Gets account configurations",
25570 "title": "Example usage:",
25571 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25575 "name": "getConfigurations",
25576 "group": "Sugarcrm_Accounts",
25577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25578 "version": "0.0.0",
25579 "filename": "server/api/intSugarcrmAccount/index.js",
25580 "groupTitle": "Sugarcrm_Accounts"
25584 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25585 "title": "Gets account fields",
25588 "title": "Example usage:",
25589 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25593 "name": "getFields",
25594 "group": "Sugarcrm_Accounts",
25595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25596 "version": "0.0.0",
25597 "filename": "server/api/intSugarcrmAccount/index.js",
25598 "groupTitle": "Sugarcrm_Accounts"
25602 "url": "/api/integrations/sugarcrm/accounts/{id}",
25603 "title": "Update an existing Sugarcrm Account",
25606 "title": "Example usage:",
25607 "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",
25611 "name": "updateSugarcrm_Accounts",
25612 "group": "Sugarcrm_Accounts",
25613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25614 "version": "0.0.0",
25615 "filename": "server/api/intSugarcrmAccount/index.js",
25616 "groupTitle": "Sugarcrm_Accounts"
25620 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25621 "title": "Gets configurations descriptions",
25624 "title": "Example usage:",
25625 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25629 "name": "getDescriptions",
25630 "group": "Sugarcrm_Configurations",
25631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25632 "version": "0.0.0",
25633 "filename": "server/api/intSugarcrmConfiguration/index.js",
25634 "groupTitle": "Sugarcrm_Configurations"
25638 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25639 "title": "Gets configurations fields",
25642 "title": "Example usage:",
25643 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25647 "name": "getFields",
25648 "group": "Sugarcrm_Configurations",
25649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25650 "version": "0.0.0",
25651 "filename": "server/api/intSugarcrmConfiguration/index.js",
25652 "groupTitle": "Sugarcrm_Configurations"
25656 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25657 "title": "Gets configurations subjects",
25660 "title": "Example usage:",
25661 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25665 "name": "getSubjects",
25666 "group": "Sugarcrm_Configurations",
25667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25668 "version": "0.0.0",
25669 "filename": "server/api/intSugarcrmConfiguration/index.js",
25670 "groupTitle": "Sugarcrm_Configurations"
25674 "url": "/api/integrations/sugarcrm/fields",
25675 "title": "Creates a new Sugarcrm Field",
25678 "title": "Example usage:",
25679 "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",
25683 "name": "CreateSugarcrm_Fields",
25684 "group": "Sugarcrm_Fields",
25694 "\"customVariable\"",
25706 "field": "content",
25722 "\"customVariable\""
25725 "field": "keyType",
25732 "field": "keyContent",
25739 "field": "idField",
25746 "field": "nameField",
25753 "field": "customField",
25760 "field": "variableName",
25766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25767 "version": "0.0.0",
25768 "filename": "server/api/intSugarcrmField/index.js",
25769 "groupTitle": "Sugarcrm_Fields"
25773 "url": "/api/integrations/sugarcrm/fields/{id}",
25774 "title": "Deletes a Sugarcrm Field",
25777 "title": "Example usage:",
25778 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25782 "name": "DeleteSugarcrm_Fields",
25783 "group": "Sugarcrm_Fields",
25784 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25785 "version": "0.0.0",
25786 "filename": "server/api/intSugarcrmField/index.js",
25787 "groupTitle": "Sugarcrm_Fields"
25791 "url": "/api/integrations/sugarcrm/fields",
25792 "title": "Gets a list of Sugarcrm Fields",
25795 "title": "Example usage:",
25796 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25800 "name": "GetSugarcrm_Fields",
25801 "group": "Sugarcrm_Fields",
25802 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25803 "version": "0.0.0",
25804 "filename": "server/api/intSugarcrmField/index.js",
25805 "groupTitle": "Sugarcrm_Fields"
25809 "url": "/api/integrations/sugarcrm/fields/{id}",
25810 "title": "Gets a single Sugarcrm Field",
25813 "title": "Example usage:",
25814 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25818 "name": "ShowSugarcrm_Fields",
25819 "group": "Sugarcrm_Fields",
25820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25821 "version": "0.0.0",
25822 "filename": "server/api/intSugarcrmField/index.js",
25823 "groupTitle": "Sugarcrm_Fields"
25827 "url": "/api/integrations/sugarcrm/fields/{id}",
25828 "title": "Update an existing Sugarcrm Field",
25831 "title": "Example usage:",
25832 "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",
25836 "name": "updateSugarcrm_Fields",
25837 "group": "Sugarcrm_Fields",
25838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25839 "version": "0.0.0",
25840 "filename": "server/api/intSugarcrmField/index.js",
25841 "groupTitle": "Sugarcrm_Fields"
25845 "url": "/api/system",
25846 "title": "Gets system information",
25849 "title": "Example usage:",
25850 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25854 "name": "GetSystemInformation",
25855 "group": "System_Information",
25856 "description": "<p>Motion returns the system information.</p>",
25857 "version": "0.0.0",
25858 "filename": "server/api/system/index.js",
25859 "groupTitle": "System_Information"
25863 "url": "/api/system/process",
25864 "title": "Gets system information",
25867 "title": "Example usage:",
25868 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25872 "name": "GetSystemInformation",
25873 "group": "System_Information",
25874 "description": "<p>Motion returns the system information.</p>",
25875 "version": "0.0.0",
25876 "filename": "server/api/system/index.js",
25877 "groupTitle": "System_Information"
25881 "url": "/api/tags",
25882 "title": "Creates a new Tag",
25885 "title": "Example usage:",
25886 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25890 "name": "CreateTags",
25913 "field": "description",
25919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25920 "version": "0.0.0",
25921 "filename": "server/api/tag/index.js",
25922 "groupTitle": "Tags"
25926 "url": "/api/tags/{id}",
25927 "title": "Deletes a Tag",
25930 "title": "Example usage:",
25931 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25935 "name": "DeleteTags",
25937 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25938 "version": "0.0.0",
25939 "filename": "server/api/tag/index.js",
25940 "groupTitle": "Tags"
25944 "url": "/api/tags",
25945 "title": "Gets a list of Tags",
25948 "title": "Example usage:",
25949 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25955 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
25956 "version": "0.0.0",
25957 "filename": "server/api/tag/index.js",
25958 "groupTitle": "Tags"
25962 "url": "/api/tags/{id}",
25963 "title": "Gets a single Tag",
25966 "title": "Example usage:",
25967 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25971 "name": "ShowTags",
25973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25974 "version": "0.0.0",
25975 "filename": "server/api/tag/index.js",
25976 "groupTitle": "Tags"
25980 "url": "/api/tags/{id}",
25981 "title": "Update an existing Tag",
25984 "title": "Example usage:",
25985 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25989 "name": "updateTags",
25991 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25992 "version": "0.0.0",
25993 "filename": "server/api/tag/index.js",
25994 "groupTitle": "Tags"
25998 "url": "/api/teams/{id}/queues",
25999 "title": "Add queues to a team",
26002 "title": "Example usage:",
26003 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26007 "name": "AddQueues",
26009 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26010 "version": "0.0.0",
26011 "filename": "server/api/team/index.js",
26012 "groupTitle": "Teams"
26016 "url": "/api/teams",
26017 "title": "Creates a new Team",
26020 "title": "Example usage:",
26021 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26025 "name": "CreateTeams",
26041 "field": "description",
26047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26048 "version": "0.0.0",
26049 "filename": "server/api/team/index.js",
26050 "groupTitle": "Teams"
26054 "url": "/api/teams/{id}",
26055 "title": "Deletes a Team",
26058 "title": "Example usage:",
26059 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26063 "name": "DeleteTeams",
26065 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066 "version": "0.0.0",
26067 "filename": "server/api/team/index.js",
26068 "groupTitle": "Teams"
26072 "url": "/api/teams/{id}/users",
26073 "title": "Gets agents from team",
26076 "title": "Example usage:",
26077 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26081 "name": "GetAgents",
26083 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26084 "version": "0.0.0",
26085 "filename": "server/api/team/index.js",
26086 "groupTitle": "Teams"
26090 "url": "/api/teams/{id}/queues?channel={channel}",
26091 "title": "Gets Queues list",
26094 "title": "Example usage:",
26095 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26099 "name": "GetQueues",
26101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26102 "version": "0.0.0",
26103 "filename": "server/api/team/index.js",
26104 "groupTitle": "Teams"
26108 "url": "/api/teams",
26109 "title": "Gets a list of Teams",
26112 "title": "Example usage:",
26113 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26117 "name": "GetTeams",
26119 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26120 "version": "0.0.0",
26121 "filename": "server/api/team/index.js",
26122 "groupTitle": "Teams"
26126 "url": "/api/teams/{id}/users",
26127 "title": "Removes agents from a team",
26130 "title": "Example usage:",
26131 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26135 "name": "RemoveAgents",
26137 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26138 "version": "0.0.0",
26139 "filename": "server/api/team/index.js",
26140 "groupTitle": "Teams"
26144 "url": "/api/teams/{id}/queues",
26145 "title": "Remove queues to a team",
26148 "title": "Example usage:",
26149 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26153 "name": "RemoveQueues",
26155 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26156 "version": "0.0.0",
26157 "filename": "server/api/team/index.js",
26158 "groupTitle": "Teams"
26162 "url": "/api/chat/queues/{id}/teams",
26163 "title": "Remove teams from a queue",
26166 "title": "Example usage:",
26167 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26171 "name": "RemoveTeams",
26173 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26174 "version": "0.0.0",
26175 "filename": "server/api/chatQueue/index.js",
26176 "groupTitle": "Teams"
26180 "url": "/api/fax/queues/{id}/teams",
26181 "title": "Remove teams from a queue",
26184 "title": "Example usage:",
26185 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26189 "name": "RemoveTeams",
26191 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26192 "version": "0.0.0",
26193 "filename": "server/api/faxQueue/index.js",
26194 "groupTitle": "Teams"
26198 "url": "/api/mail/queues/{id}/teams",
26199 "title": "Remove teams from a queue",
26202 "title": "Example usage:",
26203 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26207 "name": "RemoveTeams",
26209 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26210 "version": "0.0.0",
26211 "filename": "server/api/mailQueue/index.js",
26212 "groupTitle": "Teams"
26216 "url": "/api/sms/queues/{id}/teams",
26217 "title": "Remove teams from a queue",
26220 "title": "Example usage:",
26221 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26225 "name": "RemoveTeams",
26227 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26228 "version": "0.0.0",
26229 "filename": "server/api/smsQueue/index.js",
26230 "groupTitle": "Teams"
26234 "url": "/api/whatsapp/queues/{id}/teams",
26235 "title": "Remove teams from a queue",
26238 "title": "Example usage:",
26239 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26243 "name": "RemoveTeams",
26245 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26246 "version": "0.0.0",
26247 "filename": "server/api/whatsappQueue/index.js",
26248 "groupTitle": "Teams"
26252 "url": "/api/openchannel/queues/{id}/teams",
26253 "title": "Remove teams from a queue",
26256 "title": "Example usage:",
26257 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26261 "name": "RemoveTeams",
26263 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26264 "version": "0.0.0",
26265 "filename": "server/api/openchannelQueue/index.js",
26266 "groupTitle": "Teams"
26270 "url": "/api/voice/queues/{id}/teams",
26271 "title": "Remove teams from a queue",
26274 "title": "Example usage:",
26275 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26279 "name": "RemoveTeams",
26281 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26282 "version": "0.0.0",
26283 "filename": "server/api/voiceQueue/index.js",
26284 "groupTitle": "Teams"
26288 "url": "/api/teams/{id}",
26289 "title": "Gets a single Team",
26292 "title": "Example usage:",
26293 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26297 "name": "ShowTeams",
26299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26300 "version": "0.0.0",
26301 "filename": "server/api/team/index.js",
26302 "groupTitle": "Teams"
26306 "url": "/api/teams/{id}/users",
26307 "title": "Adds agents to a team",
26310 "title": "Example usage:",
26311 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26315 "name": "addAgents",
26317 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26318 "version": "0.0.0",
26319 "filename": "server/api/team/index.js",
26320 "groupTitle": "Teams"
26324 "url": "/api/teams/{id}",
26325 "title": "Update an existing Team",
26328 "title": "Example usage:",
26329 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26333 "name": "updateTeams",
26335 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26336 "version": "0.0.0",
26337 "filename": "server/api/team/index.js",
26338 "groupTitle": "Teams"
26342 "url": "/api/templates",
26343 "title": "Creates a new Template",
26346 "title": "Example usage:",
26347 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26351 "name": "CreateTemplates",
26352 "group": "Templates",
26367 "field": "description",
26380 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26381 "version": "0.0.0",
26382 "filename": "server/api/template/index.js",
26383 "groupTitle": "Templates"
26387 "url": "/api/templates/{id}",
26388 "title": "Deletes a Template",
26391 "title": "Example usage:",
26392 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26396 "name": "DeleteTemplates",
26397 "group": "Templates",
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/template/index.js",
26401 "groupTitle": "Templates"
26405 "url": "/api/templates",
26406 "title": "Gets a list of Templates",
26409 "title": "Example usage:",
26410 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26414 "name": "GetTemplates",
26415 "group": "Templates",
26416 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26417 "version": "0.0.0",
26418 "filename": "server/api/template/index.js",
26419 "groupTitle": "Templates"
26423 "url": "/api/templates/{id}",
26424 "title": "Gets a single Template",
26427 "title": "Example usage:",
26428 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26432 "name": "ShowTemplates",
26433 "group": "Templates",
26434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26435 "version": "0.0.0",
26436 "filename": "server/api/template/index.js",
26437 "groupTitle": "Templates"
26441 "url": "/api/templates/{id}",
26442 "title": "Update an existing Template",
26445 "title": "Example usage:",
26446 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26450 "name": "updateTemplates",
26451 "group": "Templates",
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/template/index.js",
26455 "groupTitle": "Templates"
26459 "url": "/api/triggers",
26460 "title": "Creates a new Trigger",
26463 "title": "Example usage:",
26464 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26468 "name": "CreateTriggers",
26469 "group": "Triggers",
26484 "field": "channel",
26491 "field": "description",
26504 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26505 "version": "0.0.0",
26506 "filename": "server/api/trigger/index.js",
26507 "groupTitle": "Triggers"
26511 "url": "/api/triggers/{id}",
26512 "title": "Deletes a Trigger",
26515 "title": "Example usage:",
26516 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26520 "name": "DeleteTriggers",
26521 "group": "Triggers",
26522 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26523 "version": "0.0.0",
26524 "filename": "server/api/trigger/index.js",
26525 "groupTitle": "Triggers"
26529 "url": "/api/triggers",
26530 "title": "Gets a list of Triggers",
26533 "title": "Example usage:",
26534 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26538 "name": "GetTriggers",
26539 "group": "Triggers",
26540 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26541 "version": "0.0.0",
26542 "filename": "server/api/trigger/index.js",
26543 "groupTitle": "Triggers"
26547 "url": "/api/triggers/{id}",
26548 "title": "Gets a single Trigger",
26551 "title": "Example usage:",
26552 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26556 "name": "ShowTriggers",
26557 "group": "Triggers",
26558 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26559 "version": "0.0.0",
26560 "filename": "server/api/trigger/index.js",
26561 "groupTitle": "Triggers"
26565 "url": "/api/triggers/{id}/actions",
26566 "title": "Creates new actions",
26569 "title": "Example usage:",
26570 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26574 "name": "addAction",
26575 "group": "Triggers",
26591 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26598 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26605 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26612 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26645 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26646 "version": "0.0.0",
26647 "filename": "server/api/trigger/index.js",
26648 "groupTitle": "Triggers"
26652 "url": "/api/triggers/{id}/all_conditions",
26653 "title": "Creates a new \"AND\"condition",
26656 "title": "Example usage:",
26657 "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",
26661 "name": "addAllCondition",
26662 "group": "Triggers",
26684 "field": "operator",
26697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26698 "version": "0.0.0",
26699 "filename": "server/api/trigger/index.js",
26700 "groupTitle": "Triggers"
26704 "url": "/api/triggers/{id}/any_conditions",
26705 "title": "Creates a new \"OR\"condition",
26708 "title": "Example usage:",
26709 "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",
26713 "name": "addAnyCondition",
26714 "group": "Triggers",
26736 "field": "operator",
26749 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26750 "version": "0.0.0",
26751 "filename": "server/api/trigger/index.js",
26752 "groupTitle": "Triggers"
26756 "url": "/api/triggers/{id}/actions",
26757 "title": "Gets Trigger Actions",
26760 "title": "Example usage:",
26761 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26765 "name": "getActions",
26766 "group": "Triggers",
26767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26768 "version": "0.0.0",
26769 "filename": "server/api/trigger/index.js",
26770 "groupTitle": "Triggers"
26774 "url": "/api/triggers/{id}/all_conditions",
26775 "title": "Gets \"AND\" Trigger Conditions",
26778 "title": "Example usage:",
26779 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26783 "name": "getAllConditions",
26784 "group": "Triggers",
26785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26786 "version": "0.0.0",
26787 "filename": "server/api/trigger/index.js",
26788 "groupTitle": "Triggers"
26792 "url": "/api/triggers/{id}/any_conditions",
26793 "title": "Gets \"OR\" Trigger Conditions",
26796 "title": "Example usage:",
26797 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26801 "name": "getAnyConditions",
26802 "group": "Triggers",
26803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26804 "version": "0.0.0",
26805 "filename": "server/api/trigger/index.js",
26806 "groupTitle": "Triggers"
26810 "url": "/api/triggers/{id}",
26811 "title": "Update an existing Trigger",
26814 "title": "Example usage:",
26815 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26819 "name": "updateTriggers",
26820 "group": "Triggers",
26821 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26822 "version": "0.0.0",
26823 "filename": "server/api/trigger/index.js",
26824 "groupTitle": "Triggers"
26828 "url": "/api/trunks/clone",
26829 "title": "Clone an existing Trunk",
26832 "title": "Example usage:",
26833 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26837 "name": "CloneTrunks",
26839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26840 "version": "0.0.0",
26841 "filename": "server/api/trunk/index.js",
26842 "groupTitle": "Trunks"
26846 "url": "/api/trunks",
26847 "title": "Create a new trunk",
26850 "title": "Example usage:",
26851 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26883 "field": "context",
26890 "\"ALLOWED_NOT_SCREENED\"",
26891 "\"ALLOWED_PASSED_SCREEN\"",
26892 "\"ALLOWED_FAILED_SCREEN\"",
26894 "\"PROHIB_NOT_SCREENED\"",
26895 "\"PROHIB_PASSED_SCREEN\"",
26896 "\"PROHIB_FAILED_SCREEN\"",
26900 "field": "callingpres",
26928 "field": "md5secret",
26935 "field": "remotesecret",
26942 "field": "transport",
26943 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26956 "field": "dtmfmode",
26970 "field": "directmedia",
26981 "field": "directrtpsetup",
26988 "field": "directmediapermit",
26995 "field": "directmediadeny",
27003 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27009 "field": "callgroup",
27016 "field": "namedcallgroup",
27023 "field": "pickupgroup",
27030 "field": "namedpickupgroup",
27037 "field": "language",
27044 "field": "tonezone",
27051 "field": "disallow",
27059 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27069 "field": "autoframing",
27076 "field": "insecure",
27077 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27087 "field": "trustrpid",
27098 "field": "trust_id_outbound",
27110 "field": "progressinband",
27121 "field": "promiscredir",
27132 "field": "useclientcode",
27139 "field": "accountcode",
27153 "field": "callerid",
27160 "field": "amaflags",
27171 "field": "callcounter",
27178 "field": "busylevel",
27189 "field": "allowoverlap",
27200 "field": "allowsubscribe",
27211 "field": "allowtransfer",
27222 "field": "ignoresdpversion",
27229 "field": "subscribecontext",
27236 "field": "template",
27248 "field": "videosupport",
27255 "field": "maxcallbitrate",
27266 "field": "rfc2833compensate",
27273 "field": "mailbox",
27285 "field": "session_timers",
27292 "field": "session_expires",
27299 "field": "session_minse",
27310 "field": "session_refresher",
27317 "field": "t38pt_usertpsource",
27324 "field": "regexten",
27331 "field": "fromdomain",
27338 "field": "fromuser",
27356 "field": "qualify",
27363 "field": "keepalive",
27370 "field": "defaultip",
27377 "field": "defaultuser",
27384 "field": "rtptimeout",
27391 "field": "rtpholdtimeout",
27398 "field": "rtpkeepalive",
27410 "field": "sendrpid",
27417 "field": "outboundproxy",
27424 "field": "callbackextension",
27431 "field": "timert1",
27445 "field": "qualifyfreq",
27452 "field": "contactpermit",
27459 "field": "contactdeny",
27466 "field": "contactacl",
27473 "field": "unsolicited_mailbox",
27480 "field": "use_q850_reason",
27487 "field": "maxforwards",
27498 "field": "encryption",
27520 "field": "force_avp",
27531 "field": "icesupport",
27542 "field": "dtlsenable",
27555 "field": "dtlsverify",
27562 "field": "dtlsrekey",
27569 "field": "dtlscertfile",
27576 "field": "dtlsprivatekey",
27583 "field": "dtlscipher",
27590 "field": "dtlscafile",
27597 "field": "dtlscapath",
27609 "field": "dtlssetup",
27616 "field": "dtlsfingerprint",
27627 "field": "usereqphone",
27634 "field": "recordonfeature",
27641 "field": "recordofffeature",
27648 "field": "call_limit",
27659 "field": "registertrying",
27670 "field": "subscribemwi",
27677 "field": "vmexten",
27684 "field": "mohinterpret",
27691 "field": "mohsuggest",
27698 "field": "parkinglot",
27705 "field": "description",
27726 "field": "canreinvite",
27733 "field": "registry",
27740 "field": "otherFields",
27754 "field": "t38pt_udptl",
27760 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27761 "version": "0.0.0",
27762 "filename": "server/api/trunk/index.js",
27763 "groupTitle": "Trunks"
27767 "url": "/api/trunks/{id}",
27768 "title": "Deletes a trunk",
27771 "title": "Example usage:",
27772 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27778 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27779 "version": "0.0.0",
27780 "filename": "server/api/trunk/index.js",
27781 "groupTitle": "Trunks"
27785 "url": "/api/trunks",
27786 "title": "Gets a list of Trunks",
27789 "title": "Example usage:",
27790 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27794 "name": "GetTrunks",
27796 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27797 "version": "0.0.0",
27798 "filename": "server/api/trunk/index.js",
27799 "groupTitle": "Trunks"
27803 "url": "/api/trunks/{id}",
27804 "title": "Gets a single Trunk",
27807 "title": "Example usage:",
27808 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27812 "name": "ShowTrunks",
27814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27815 "version": "0.0.0",
27816 "filename": "server/api/trunk/index.js",
27817 "groupTitle": "Trunks"
27821 "url": "/api/trunks/{id}",
27822 "title": "Update an existing trunk",
27825 "title": "Example usage:",
27826 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27833 "version": "0.0.0",
27834 "filename": "server/api/trunk/index.js",
27835 "groupTitle": "Trunks"
27839 "url": "/api/userNotifications",
27840 "title": "Send notification to user",
27843 "title": "Example usage:",
27844 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27849 "group": "UserNotifications",
27850 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27851 "version": "0.0.0",
27852 "filename": "server/api/userNotification/index.js",
27853 "groupTitle": "UserNotifications"
27857 "url": "/api/userProfile/resources",
27858 "title": "Creates a new User Profile Resource",
27861 "title": "Example usage:",
27862 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27866 "name": "CreateUser_Profile_Resources",
27867 "group": "User_Profile_Resources",
27882 "field": "resourceId",
27895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27896 "version": "0.0.0",
27897 "filename": "server/api/userProfileResource/index.js",
27898 "groupTitle": "User_Profile_Resources"
27902 "url": "/api/userProfile/resources/{id}",
27903 "title": "Deletes a User Profile Resource",
27906 "title": "Example usage:",
27907 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27911 "name": "DeleteUser_Profile_Resources",
27912 "group": "User_Profile_Resources",
27913 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27914 "version": "0.0.0",
27915 "filename": "server/api/userProfileResource/index.js",
27916 "groupTitle": "User_Profile_Resources"
27920 "url": "/api/userProfile/resources/describe",
27921 "title": "Gets table info about User Profile Resources",
27924 "title": "Example usage:",
27925 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27929 "name": "DescribeUser_Profile_Resources",
27930 "group": "User_Profile_Resources",
27931 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27932 "version": "0.0.0",
27933 "filename": "server/api/userProfileResource/index.js",
27934 "groupTitle": "User_Profile_Resources"
27938 "url": "/api/userProfile/resources",
27939 "title": "Gets a list of User Profile Resources",
27942 "title": "Example usage:",
27943 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27947 "name": "GetUser_Profile_Resources",
27948 "group": "User_Profile_Resources",
27949 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27950 "version": "0.0.0",
27951 "filename": "server/api/userProfileResource/index.js",
27952 "groupTitle": "User_Profile_Resources"
27956 "url": "/api/userProfile/resources/{id}",
27957 "title": "Gets a single User Profile Resource",
27960 "title": "Example usage:",
27961 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27965 "name": "ShowUser_Profile_Resources",
27966 "group": "User_Profile_Resources",
27967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27968 "version": "0.0.0",
27969 "filename": "server/api/userProfileResource/index.js",
27970 "groupTitle": "User_Profile_Resources"
27974 "url": "/api/userProfile/resources/{id}",
27975 "title": "Update an existing User Profile Resource",
27978 "title": "Example usage:",
27979 "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",
27983 "name": "updateUser_Profile_Resources",
27984 "group": "User_Profile_Resources",
27985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27986 "version": "0.0.0",
27987 "filename": "server/api/userProfileResource/index.js",
27988 "groupTitle": "User_Profile_Resources"
27992 "url": "/api/userProfile/sections",
27993 "title": "Creates a new User Profile Section",
27996 "title": "Example usage:",
27997 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28001 "name": "CreateUser_Profile_Sections",
28002 "group": "User_Profile_Sections",
28017 "field": "category",
28024 "field": "sectionId",
28031 "field": "enabled",
28038 "field": "autoAssociation",
28045 "field": "crudPermissions",
28051 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28052 "version": "0.0.0",
28053 "filename": "server/api/userProfileSection/index.js",
28054 "groupTitle": "User_Profile_Sections"
28058 "url": "/api/userProfile/sections/{id}",
28059 "title": "Deletes a User Profile Section",
28062 "title": "Example usage:",
28063 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28067 "name": "DeleteUser_Profile_Sections",
28068 "group": "User_Profile_Sections",
28069 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28070 "version": "0.0.0",
28071 "filename": "server/api/userProfileSection/index.js",
28072 "groupTitle": "User_Profile_Sections"
28076 "url": "/api/userProfile/sections/describe",
28077 "title": "Gets table info about User Profile Sections",
28080 "title": "Example usage:",
28081 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28085 "name": "DescribeUser_Profile_Sections",
28086 "group": "User_Profile_Sections",
28087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28088 "version": "0.0.0",
28089 "filename": "server/api/userProfileSection/index.js",
28090 "groupTitle": "User_Profile_Sections"
28094 "url": "/api/userProfile/sections",
28095 "title": "Gets a list of User Profile Sections",
28098 "title": "Example usage:",
28099 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28103 "name": "GetUser_Profile_Sections",
28104 "group": "User_Profile_Sections",
28105 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28106 "version": "0.0.0",
28107 "filename": "server/api/userProfileSection/index.js",
28108 "groupTitle": "User_Profile_Sections"
28112 "url": "/api/userProfile/sections/{id}",
28113 "title": "Gets a single User Profile Section",
28116 "title": "Example usage:",
28117 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28121 "name": "ShowUser_Profile_Sections",
28122 "group": "User_Profile_Sections",
28123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28124 "version": "0.0.0",
28125 "filename": "server/api/userProfileSection/index.js",
28126 "groupTitle": "User_Profile_Sections"
28130 "url": "/api/userProfile/sections/{id}",
28131 "title": "Update an existing User Profile Section",
28134 "title": "Example usage:",
28135 "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",
28139 "name": "updateUser_Profile_Sections",
28140 "group": "User_Profile_Sections",
28141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28142 "version": "0.0.0",
28143 "filename": "server/api/userProfileSection/index.js",
28144 "groupTitle": "User_Profile_Sections"
28148 "url": "/api/userProfiles/{id}/resources",
28149 "title": "Add resources' permissions to User Profile",
28152 "title": "Example usage:",
28153 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28157 "name": "AddResources",
28158 "group": "User_Profiles",
28159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28160 "version": "0.0.0",
28161 "filename": "server/api/userProfile/index.js",
28162 "groupTitle": "User_Profiles"
28166 "url": "/api/userProfiles/{id}/sections",
28167 "title": "Add sections' permissions to User Profile",
28170 "title": "Example usage:",
28171 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28175 "name": "AddSections",
28176 "group": "User_Profiles",
28177 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28178 "version": "0.0.0",
28179 "filename": "server/api/userProfile/index.js",
28180 "groupTitle": "User_Profiles"
28184 "url": "/api/userProfiles/clone",
28185 "title": "Clone an existing User Profile",
28188 "title": "Example usage:",
28189 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28193 "name": "CloneUser_Profiles",
28194 "group": "User_Profiles",
28195 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28196 "version": "0.0.0",
28197 "filename": "server/api/userProfile/index.js",
28198 "groupTitle": "User_Profiles"
28202 "url": "/api/userProfiles",
28203 "title": "Creates a new User Profile",
28206 "title": "Example usage:",
28207 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28211 "name": "CreateUser_Profiles",
28212 "group": "User_Profiles",
28227 "field": "crudPermissions",
28234 "field": "description",
28241 "field": "privacyEnabled",
28248 "field": "downloadAttachments",
28255 "field": "downloadCallySquareRecordings",
28262 "field": "downloadContactManagerLists",
28269 "field": "downloadJscriptySessions",
28276 "field": "downloadOmnichannelInteractions",
28283 "field": "downloadScreenRecordings",
28290 "field": "downloadVoiceRecordings",
28296 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28297 "version": "0.0.0",
28298 "filename": "server/api/userProfile/index.js",
28299 "groupTitle": "User_Profiles"
28303 "url": "/api/userProfiles/{id}",
28304 "title": "Deletes a User Profile",
28307 "title": "Example usage:",
28308 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28312 "name": "DeleteUser_Profiles",
28313 "group": "User_Profiles",
28314 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28315 "version": "0.0.0",
28316 "filename": "server/api/userProfile/index.js",
28317 "groupTitle": "User_Profiles"
28321 "url": "/api/userProfiles/describe",
28322 "title": "Gets table info about User Profiles",
28325 "title": "Example usage:",
28326 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28330 "name": "DescribeUser_Profiles",
28331 "group": "User_Profiles",
28332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28333 "version": "0.0.0",
28334 "filename": "server/api/userProfile/index.js",
28335 "groupTitle": "User_Profiles"
28339 "url": "/api/userProfiles/{id}/resources?section={section}",
28340 "title": "Get Resources assigned to a Section",
28343 "title": "Example usage:",
28344 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28348 "name": "GetResources",
28349 "group": "User_Profiles",
28350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28351 "version": "0.0.0",
28352 "filename": "server/api/userProfile/index.js",
28353 "groupTitle": "User_Profiles"
28357 "url": "/api/userProfiles/{id}/sections",
28358 "title": "Get sections associated to a User Profile",
28361 "title": "Example usage:",
28362 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28366 "name": "GetSections",
28367 "group": "User_Profiles",
28368 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28369 "version": "0.0.0",
28370 "filename": "server/api/userProfile/index.js",
28371 "groupTitle": "User_Profiles"
28375 "url": "/api/userProfiles",
28376 "title": "Gets a list of User Profiles",
28379 "title": "Example usage:",
28380 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28384 "name": "GetUser_Profiles",
28385 "group": "User_Profiles",
28386 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28387 "version": "0.0.0",
28388 "filename": "server/api/userProfile/index.js",
28389 "groupTitle": "User_Profiles"
28393 "url": "/api/userProfiles/{id}/resources",
28394 "title": "Removes resources' permissions from User Profile",
28397 "title": "Example usage:",
28398 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28402 "name": "RemoveResources",
28403 "group": "User_Profiles",
28404 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28405 "version": "0.0.0",
28406 "filename": "server/api/userProfile/index.js",
28407 "groupTitle": "User_Profiles"
28411 "url": "/api/userProfiles/{id}/sections",
28412 "title": "Removes sections' permissions from User Profile",
28415 "title": "Example usage:",
28416 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28420 "name": "RemoveSections",
28421 "group": "User_Profiles",
28422 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28423 "version": "0.0.0",
28424 "filename": "server/api/userProfile/index.js",
28425 "groupTitle": "User_Profiles"
28429 "url": "/api/userProfiles/{id}",
28430 "title": "Gets a single User Profile",
28433 "title": "Example usage:",
28434 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28438 "name": "ShowUser_Profiles",
28439 "group": "User_Profiles",
28440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28441 "version": "0.0.0",
28442 "filename": "server/api/userProfile/index.js",
28443 "groupTitle": "User_Profiles"
28447 "url": "/api/userProfiles/{id}",
28448 "title": "Update an existing User Profile",
28451 "title": "Example usage:",
28452 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28456 "name": "updateUser_Profiles",
28457 "group": "User_Profiles",
28458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28459 "version": "0.0.0",
28460 "filename": "server/api/userProfile/index.js",
28461 "groupTitle": "User_Profiles"
28465 "url": "/api/users/{id}/chat_interactions",
28466 "title": "Add chat interaction tabs to an agent",
28469 "title": "Example usage:",
28470 "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",
28474 "name": "AddChatInteractions",
28476 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28477 "version": "0.0.0",
28478 "filename": "server/api/user/index.js",
28479 "groupTitle": "Users"
28483 "url": "/api/users/{id}/chat_websites",
28484 "title": "Add a Chat Website to a user",
28487 "title": "Example usage:",
28488 "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",
28492 "name": "AddChatWebsites",
28494 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28495 "version": "0.0.0",
28496 "filename": "server/api/user/index.js",
28497 "groupTitle": "Users"
28501 "url": "/api/users/{id}/contacts",
28502 "title": "Add contacts to a user",
28505 "title": "Example usage:",
28506 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28510 "name": "AddContacts",
28512 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28513 "version": "0.0.0",
28514 "filename": "server/api/user/index.js",
28515 "groupTitle": "Users"
28519 "url": "/api/users/{id}/fax_accounts",
28520 "title": "Add a Fax Account to a user",
28523 "title": "Example usage:",
28524 "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",
28528 "name": "AddFaxAccounts",
28530 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28531 "version": "0.0.0",
28532 "filename": "server/api/user/index.js",
28533 "groupTitle": "Users"
28537 "url": "/api/users/{id}/fax_interactions",
28538 "title": "Add fax interaction tabs to an agent",
28541 "title": "Example usage:",
28542 "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",
28546 "name": "AddFaxInteractions",
28548 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28549 "version": "0.0.0",
28550 "filename": "server/api/user/index.js",
28551 "groupTitle": "Users"
28555 "url": "/api/users/{id}/mail_accounts",
28556 "title": "Add a Mail Account to a user",
28559 "title": "Example usage:",
28560 "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",
28564 "name": "AddMailAccounts",
28566 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28567 "version": "0.0.0",
28568 "filename": "server/api/user/index.js",
28569 "groupTitle": "Users"
28573 "url": "/api/users/{id}/mail_interactions",
28574 "title": "Add mail interaction tabs to an agent",
28577 "title": "Example usage:",
28578 "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",
28582 "name": "AddMailInteractions",
28584 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28585 "version": "0.0.0",
28586 "filename": "server/api/user/index.js",
28587 "groupTitle": "Users"
28591 "url": "/api/users/{id}/openchannel_accounts",
28592 "title": "Add a Open Channel Account to a user",
28595 "title": "Example usage:",
28596 "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",
28600 "name": "AddOpenchannelAccounts",
28602 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28603 "version": "0.0.0",
28604 "filename": "server/api/user/index.js",
28605 "groupTitle": "Users"
28609 "url": "/api/users/{id}/openchannel_interactions",
28610 "title": "Add openchannel interaction tabs to an agent",
28613 "title": "Example usage:",
28614 "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",
28618 "name": "AddOpenchannelInteractions",
28620 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28621 "version": "0.0.0",
28622 "filename": "server/api/user/index.js",
28623 "groupTitle": "Users"
28627 "url": "/api/users/{id}/queues",
28628 "title": "Add queues to an agent",
28631 "title": "Example usage:",
28632 "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",
28636 "name": "AddQueues",
28638 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28639 "version": "0.0.0",
28640 "filename": "server/api/user/index.js",
28641 "groupTitle": "Users"
28645 "url": "/api/users/{id}/sms_accounts",
28646 "title": "Add a Sms Account to a user",
28649 "title": "Example usage:",
28650 "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",
28654 "name": "AddSmsAccounts",
28656 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28657 "version": "0.0.0",
28658 "filename": "server/api/user/index.js",
28659 "groupTitle": "Users"
28663 "url": "/api/users/{id}/sms_interactions",
28664 "title": "Add sms interaction tabs to an agent",
28667 "title": "Example usage:",
28668 "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",
28672 "name": "AddSmsInteractions",
28674 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28675 "version": "0.0.0",
28676 "filename": "server/api/user/index.js",
28677 "groupTitle": "Users"
28681 "url": "/api/users/{id}/square_projects",
28682 "title": "Add a Square Project to a user",
28685 "title": "Example usage:",
28686 "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",
28690 "name": "AddSquareProjects",
28692 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28693 "version": "0.0.0",
28694 "filename": "server/api/user/index.js",
28695 "groupTitle": "Users"
28699 "url": "/api/users/{id}/teams",
28700 "title": "Add teams to an agent",
28703 "title": "Example usage:",
28704 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28708 "name": "AddTeams",
28710 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28711 "version": "0.0.0",
28712 "filename": "server/api/user/index.js",
28713 "groupTitle": "Users"
28717 "url": "/api/users/{id}/whatsapp_accounts",
28718 "title": "Add a Whatsapp Account to a user",
28721 "title": "Example usage:",
28722 "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",
28726 "name": "AddWhatsappAccounts",
28728 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28729 "version": "0.0.0",
28730 "filename": "server/api/user/index.js",
28731 "groupTitle": "Users"
28735 "url": "/api/users/{id}/whatsapp_interactions",
28736 "title": "Add Whatsapp interaction tabs to an agent",
28739 "title": "Example usage:",
28740 "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",
28744 "name": "AddWhatsappInteractions",
28746 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28747 "version": "0.0.0",
28748 "filename": "server/api/user/index.js",
28749 "groupTitle": "Users"
28753 "url": "/api/users/{id}/password",
28754 "title": "Change user password",
28757 "title": "Example usage:",
28758 "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",
28762 "name": "ChangePwd",
28764 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28765 "version": "0.0.0",
28766 "filename": "server/api/user/index.js",
28767 "groupTitle": "Users"
28771 "url": "/api/users",
28772 "title": "Create a new user",
28775 "title": "Example usage:",
28776 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28783 "version": "0.0.0",
28784 "filename": "server/api/user/index.js",
28785 "groupTitle": "Users"
28789 "url": "/api/users/{id}/api_key",
28790 "title": "Create a new API access key for the user",
28793 "title": "Example usage:",
28794 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28798 "name": "CreateApiKey",
28800 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28801 "version": "0.0.0",
28802 "filename": "server/api/user/index.js",
28803 "groupTitle": "Users"
28807 "url": "/api/users/{id}",
28808 "title": "Deletes a user",
28811 "title": "Example usage:",
28812 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28818 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28819 "version": "0.0.0",
28820 "filename": "server/api/user/index.js",
28821 "groupTitle": "Users"
28825 "url": "/api/users/describe",
28826 "title": "Gets table info about Users",
28829 "title": "Example usage:",
28830 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28834 "name": "DescribeUsers",
28836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28837 "version": "0.0.0",
28838 "filename": "server/api/user/index.js",
28839 "groupTitle": "Users"
28843 "url": "/api/users/{id}/agents",
28844 "title": "GetAgents",
28847 "title": "Example usage:",
28848 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28852 "name": "GetAgents",
28854 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28855 "version": "0.0.0",
28856 "filename": "server/api/user/index.js",
28857 "groupTitle": "Users"
28861 "url": "/api/users/{id}/api_key",
28862 "title": "Get the API access key for the user",
28865 "title": "Example usage:",
28866 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28870 "name": "GetApiKey",
28872 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28873 "version": "0.0.0",
28874 "filename": "server/api/user/index.js",
28875 "groupTitle": "Users"
28879 "url": "/api/users/{id}/groups",
28880 "title": "GetChatGroups",
28883 "title": "Example usage:",
28884 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28888 "name": "GetChatGroups",
28890 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28891 "version": "0.0.0",
28892 "filename": "server/api/user/index.js",
28893 "groupTitle": "Users"
28897 "url": "/api/users/{id}/chat/interactions",
28898 "title": "GetChatInteractions",
28901 "title": "Example usage:",
28902 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28906 "name": "GetChatInteractions",
28908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28909 "version": "0.0.0",
28910 "filename": "server/api/user/index.js",
28911 "groupTitle": "Users"
28915 "url": "/api/users/{id}/chat_websites",
28916 "title": "GetChatWebsites",
28919 "title": "Example usage:",
28920 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28924 "name": "GetChatWebsites",
28926 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28927 "version": "0.0.0",
28928 "filename": "server/api/user/index.js",
28929 "groupTitle": "Users"
28933 "url": "/api/users/{id}/contacts",
28934 "title": "GetContacts",
28937 "title": "Example usage:",
28938 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28942 "name": "GetContacts",
28944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28945 "version": "0.0.0",
28946 "filename": "server/api/user/index.js",
28947 "groupTitle": "Users"
28951 "url": "/api/users/{id}/fax_accounts",
28952 "title": "GetFaxAccounts",
28955 "title": "Example usage:",
28956 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28960 "name": "GetFaxAccounts",
28962 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28963 "version": "0.0.0",
28964 "filename": "server/api/user/index.js",
28965 "groupTitle": "Users"
28969 "url": "/api/users/{id}/fax/interactions",
28970 "title": "GetFaxInteractions",
28973 "title": "Example usage:",
28974 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28978 "name": "GetFaxInteractions",
28980 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28981 "version": "0.0.0",
28982 "filename": "server/api/user/index.js",
28983 "groupTitle": "Users"
28987 "url": "/api/users/{id}/lists",
28988 "title": "GetLists",
28991 "title": "Example usage:",
28992 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28996 "name": "GetLists",
28998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28999 "version": "0.0.0",
29000 "filename": "server/api/user/index.js",
29001 "groupTitle": "Users"
29005 "url": "/api/users/{id}/mail_accounts",
29006 "title": "GetMailAccounts",
29009 "title": "Example usage:",
29010 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29014 "name": "GetMailAccounts",
29016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29017 "version": "0.0.0",
29018 "filename": "server/api/user/index.js",
29019 "groupTitle": "Users"
29023 "url": "/api/users/{id}/mail/interactions",
29024 "title": "GetMailInteractions",
29027 "title": "Example usage:",
29028 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29032 "name": "GetMailInteractions",
29034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29035 "version": "0.0.0",
29036 "filename": "server/api/user/index.js",
29037 "groupTitle": "Users"
29041 "url": "/api/users/{id}/openchannel_accounts",
29042 "title": "GetOpenchannelAccounts",
29045 "title": "Example usage:",
29046 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29050 "name": "GetOpenchannelAccounts",
29052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29053 "version": "0.0.0",
29054 "filename": "server/api/user/index.js",
29055 "groupTitle": "Users"
29059 "url": "/api/users/{id}/openchannel/interactions",
29060 "title": "GetOpenchannelInteractions",
29063 "title": "Example usage:",
29064 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29068 "name": "GetOpenchannelInteractions",
29070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29071 "version": "0.0.0",
29072 "filename": "server/api/user/index.js",
29073 "groupTitle": "Users"
29077 "url": "/api/users/{id}/prefixes",
29078 "title": "GetPrefixes",
29081 "title": "Example usage:",
29082 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29086 "name": "GetPrefixes",
29088 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29089 "version": "0.0.0",
29090 "filename": "server/api/user/index.js",
29091 "groupTitle": "Users"
29095 "url": "/api/users/{id}/queues?channel={channel}",
29096 "title": "Gets Queues list",
29099 "title": "Example usage:",
29100 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29104 "name": "GetQueues",
29106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29107 "version": "0.0.0",
29108 "filename": "server/api/user/index.js",
29109 "groupTitle": "Users"
29113 "url": "/api/users/{id}/recordings",
29114 "title": "GetRecordings",
29117 "title": "Example usage:",
29118 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29122 "name": "GetRecordings",
29124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29125 "version": "0.0.0",
29126 "filename": "server/api/user/index.js",
29127 "groupTitle": "Users"
29131 "url": "/api/users/{id}/scheduled_calls",
29132 "title": "GetScheduledCalls",
29135 "title": "Example usage:",
29136 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29140 "name": "GetScheduledCalls",
29142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29143 "version": "0.0.0",
29144 "filename": "server/api/user/index.js",
29145 "groupTitle": "Users"
29149 "url": "/api/users/{id}/screen_recordings",
29150 "title": "GetScreenRecordings",
29153 "title": "Example usage:",
29154 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29158 "name": "GetScreenRecordings",
29160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29161 "version": "0.0.0",
29162 "filename": "server/api/user/index.js",
29163 "groupTitle": "Users"
29167 "url": "/api/users/{id}/sms_accounts",
29168 "title": "GetSmsAccounts",
29171 "title": "Example usage:",
29172 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29176 "name": "GetSmsAccounts",
29178 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29179 "version": "0.0.0",
29180 "filename": "server/api/user/index.js",
29181 "groupTitle": "Users"
29185 "url": "/api/users/{id}/sms/interactions",
29186 "title": "GetSmsInteractions",
29189 "title": "Example usage:",
29190 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29194 "name": "GetSmsInteractions",
29196 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29197 "version": "0.0.0",
29198 "filename": "server/api/user/index.js",
29199 "groupTitle": "Users"
29203 "url": "/api/users/{id}/square_projects",
29204 "title": "GetSquareProjects",
29207 "title": "Example usage:",
29208 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29212 "name": "GetSquareProjects",
29214 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29215 "version": "0.0.0",
29216 "filename": "server/api/user/index.js",
29217 "groupTitle": "Users"
29221 "url": "/api/users/{id}/teams",
29222 "title": "GetTeams",
29225 "title": "Example usage:",
29226 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29230 "name": "GetTeams",
29232 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29233 "version": "0.0.0",
29234 "filename": "server/api/user/index.js",
29235 "groupTitle": "Users"
29239 "url": "/api/users",
29240 "title": "Gets a list of Users",
29243 "title": "Example usage:",
29244 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29248 "name": "GetUsers",
29250 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29251 "version": "0.0.0",
29252 "filename": "server/api/user/index.js",
29253 "groupTitle": "Users"
29257 "url": "/api/users/{id}/queues_rt",
29258 "title": "GetVoiceQueuesRt",
29261 "title": "Example usage:",
29262 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29266 "name": "GetVoiceQueuesRt",
29268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29269 "version": "0.0.0",
29270 "filename": "server/api/user/index.js",
29271 "groupTitle": "Users"
29275 "url": "/api/users/{id}/whatsapp_accounts",
29276 "title": "GetWhatsappAccounts",
29279 "title": "Example usage:",
29280 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29284 "name": "GetWhatsappAccounts",
29286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29287 "version": "0.0.0",
29288 "filename": "server/api/user/index.js",
29289 "groupTitle": "Users"
29293 "url": "/api/users/{id}/whatsapp/interactions",
29294 "title": "GetWhatsappInteractions",
29297 "title": "Example usage:",
29298 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29302 "name": "GetWhatsappInteractions",
29304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29305 "version": "0.0.0",
29306 "filename": "server/api/user/index.js",
29307 "groupTitle": "Users"
29311 "url": "/api/users/{id}/login",
29315 "title": "Example usage:",
29316 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29322 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29323 "version": "0.0.0",
29324 "filename": "server/api/user/index.js",
29325 "groupTitle": "Users"
29329 "url": "/api/users/{id}/logout",
29333 "title": "Example usage:",
29334 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29340 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29341 "version": "0.0.0",
29342 "filename": "server/api/user/index.js",
29343 "groupTitle": "Users"
29347 "url": "/api/users/{id}/pause",
29351 "title": "Example usage:",
29352 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29358 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29359 "version": "0.0.0",
29360 "filename": "server/api/user/index.js",
29361 "groupTitle": "Users"
29365 "url": "/api/users/{id}/api_key",
29366 "title": "Remove API access key for the user",
29369 "title": "Example usage:",
29370 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29374 "name": "RemoveApiKey",
29376 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29377 "version": "0.0.0",
29378 "filename": "server/api/user/index.js",
29379 "groupTitle": "Users"
29383 "url": "/api/users/{id}/chat_interactions",
29384 "title": "Removes interactions from an agent",
29387 "title": "Example usage:",
29388 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29392 "name": "RemoveChatInteractions",
29394 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29395 "version": "0.0.0",
29396 "filename": "server/api/user/index.js",
29397 "groupTitle": "Users"
29401 "url": "/api/users/{id}/chat_websites",
29402 "title": "Removes a Chat Website from a user",
29405 "title": "Example usage:",
29406 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29410 "name": "RemoveChatWebsites",
29412 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29413 "version": "0.0.0",
29414 "filename": "server/api/user/index.js",
29415 "groupTitle": "Users"
29419 "url": "/api/users/{id}/fax_accounts",
29420 "title": "Removes a Fax Account from a user",
29423 "title": "Example usage:",
29424 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29428 "name": "RemoveFaxAccounts",
29430 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29431 "version": "0.0.0",
29432 "filename": "server/api/user/index.js",
29433 "groupTitle": "Users"
29437 "url": "/api/users/{id}/fax_interactions",
29438 "title": "Removes interactions from an agent",
29441 "title": "Example usage:",
29442 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29446 "name": "RemoveFaxInteractions",
29448 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29449 "version": "0.0.0",
29450 "filename": "server/api/user/index.js",
29451 "groupTitle": "Users"
29455 "url": "/api/users/{id}/mail_accounts",
29456 "title": "Removes a Mail Account from a user",
29459 "title": "Example usage:",
29460 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29464 "name": "RemoveMailAccounts",
29466 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29467 "version": "0.0.0",
29468 "filename": "server/api/user/index.js",
29469 "groupTitle": "Users"
29473 "url": "/api/users/{id}/mail_interactions",
29474 "title": "Removes interactions from an agent",
29477 "title": "Example usage:",
29478 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29482 "name": "RemoveMailInteractions",
29484 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29485 "version": "0.0.0",
29486 "filename": "server/api/user/index.js",
29487 "groupTitle": "Users"
29491 "url": "/api/users/{id}/openchannel_accounts",
29492 "title": "Removes a Open Channel Account from a user",
29495 "title": "Example usage:",
29496 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29500 "name": "RemoveOpenchannelAccounts",
29502 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29503 "version": "0.0.0",
29504 "filename": "server/api/user/index.js",
29505 "groupTitle": "Users"
29509 "url": "/api/users/{id}/openchannel_interactions",
29510 "title": "Removes openchannel interactions from an agent",
29513 "title": "Example usage:",
29514 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29518 "name": "RemoveOpenchannelInteractions",
29520 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29521 "version": "0.0.0",
29522 "filename": "server/api/user/index.js",
29523 "groupTitle": "Users"
29527 "url": "/api/users/{id}/queues",
29528 "title": "Remove queues to an agent",
29531 "title": "Example usage:",
29532 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29536 "name": "RemoveQueues",
29538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29539 "version": "0.0.0",
29540 "filename": "server/api/user/index.js",
29541 "groupTitle": "Users"
29545 "url": "/api/users/{id}/sms_accounts",
29546 "title": "Removes a Sms Account from a user",
29549 "title": "Example usage:",
29550 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29554 "name": "RemoveSmsAccounts",
29556 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29557 "version": "0.0.0",
29558 "filename": "server/api/user/index.js",
29559 "groupTitle": "Users"
29563 "url": "/api/users/{id}/sms_interactions",
29564 "title": "Removes interactions from an agent",
29567 "title": "Example usage:",
29568 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29572 "name": "RemoveSmsInteractions",
29574 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29575 "version": "0.0.0",
29576 "filename": "server/api/user/index.js",
29577 "groupTitle": "Users"
29581 "url": "/api/users/{id}/square_projects",
29582 "title": "Removes a Square Project from a user",
29585 "title": "Example usage:",
29586 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29590 "name": "RemoveSquareProjects",
29592 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29593 "version": "0.0.0",
29594 "filename": "server/api/user/index.js",
29595 "groupTitle": "Users"
29599 "url": "/api/users/{id}/teams",
29600 "title": "Removes teams from an agent",
29603 "title": "Example usage:",
29604 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29608 "name": "RemoveTeams",
29610 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29611 "version": "0.0.0",
29612 "filename": "server/api/user/index.js",
29613 "groupTitle": "Users"
29617 "url": "/api/users/{id}/whatsapp_accounts",
29618 "title": "Removes a Whatsapp Account from a user",
29621 "title": "Example usage:",
29622 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29626 "name": "RemoveWhatsappAccounts",
29628 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29629 "version": "0.0.0",
29630 "filename": "server/api/user/index.js",
29631 "groupTitle": "Users"
29635 "url": "/api/users/{id}/whatsapp_interactions",
29636 "title": "Removes Whatsapp interactions from an agent",
29639 "title": "Example usage:",
29640 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29644 "name": "RemoveWhatsappInteractions",
29646 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29647 "version": "0.0.0",
29648 "filename": "server/api/user/index.js",
29649 "groupTitle": "Users"
29653 "url": "/api/users/{id}",
29654 "title": "Gets a single User",
29657 "title": "Example usage:",
29658 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29662 "name": "ShowUsers",
29664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29665 "version": "0.0.0",
29666 "filename": "server/api/user/index.js",
29667 "groupTitle": "Users"
29671 "url": "/api/users/{id}/unpause",
29672 "title": "Unpause",
29675 "title": "Example usage:",
29676 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29682 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29683 "version": "0.0.0",
29684 "filename": "server/api/user/index.js",
29685 "groupTitle": "Users"
29689 "url": "/api/users/whoami",
29693 "title": "Example usage:",
29694 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29700 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29701 "version": "0.0.0",
29702 "filename": "server/api/user/index.js",
29703 "groupTitle": "Users"
29707 "url": "/api/users/{id}/avatar",
29708 "title": "Add avatar",
29711 "title": "Example usage:",
29712 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29716 "name": "addAvatar",
29718 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29719 "version": "0.0.0",
29720 "filename": "server/api/user/index.js",
29721 "groupTitle": "Users"
29725 "url": "/api/users/create_many",
29726 "title": "Create Users",
29729 "title": "Example usage:",
29730 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29734 "name": "bulkCreate",
29736 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29737 "version": "0.0.0",
29738 "filename": "server/api/user/index.js",
29739 "groupTitle": "Users"
29743 "url": "/api/users/{id}/avatar",
29744 "title": "Get avatar",
29747 "title": "Example usage:",
29748 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29752 "name": "getAvatar",
29754 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29755 "version": "0.0.0",
29756 "filename": "server/api/user/index.js",
29757 "groupTitle": "Users"
29761 "url": "/api/users/{id}/open_tabs",
29762 "title": "Get interactions opened tabs",
29765 "title": "Example usage:",
29766 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29770 "name": "getOpenTabs",
29772 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29773 "version": "0.0.0",
29774 "filename": "server/api/user/index.js",
29775 "groupTitle": "Users"
29779 "url": "/api/users/presence",
29780 "title": "Gets agent presence",
29783 "title": "Example usage:",
29784 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
29788 "name": "getPresence",
29790 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29791 "version": "0.0.0",
29792 "filename": "server/api/user/index.js",
29793 "groupTitle": "Users"
29797 "url": "/api/users/{id}",
29798 "title": "Update an existing User",
29801 "title": "Example usage:",
29802 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29806 "name": "updateUsers",
29808 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29809 "version": "0.0.0",
29810 "filename": "server/api/user/index.js",
29811 "groupTitle": "Users"
29815 "url": "/api/variables",
29816 "title": "Creates a new Variable",
29819 "title": "Example usage:",
29820 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29824 "name": "CreateVariables",
29825 "group": "Variables",
29840 "field": "description",
29846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29847 "version": "0.0.0",
29848 "filename": "server/api/variable/index.js",
29849 "groupTitle": "Variables"
29853 "url": "/api/variables/{id}",
29854 "title": "Deletes a Variable",
29857 "title": "Example usage:",
29858 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29862 "name": "DeleteVariables",
29863 "group": "Variables",
29864 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29865 "version": "0.0.0",
29866 "filename": "server/api/variable/index.js",
29867 "groupTitle": "Variables"
29871 "url": "/api/variables",
29872 "title": "Gets a list of Variables",
29875 "title": "Example usage:",
29876 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29880 "name": "GetVariables",
29881 "group": "Variables",
29882 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29883 "version": "0.0.0",
29884 "filename": "server/api/variable/index.js",
29885 "groupTitle": "Variables"
29889 "url": "/api/variables/{id}",
29890 "title": "Gets a single Variable",
29893 "title": "Example usage:",
29894 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29898 "name": "ShowVariables",
29899 "group": "Variables",
29900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29901 "version": "0.0.0",
29902 "filename": "server/api/variable/index.js",
29903 "groupTitle": "Variables"
29907 "url": "/api/variables/{id}",
29908 "title": "Update an existing Variable",
29911 "title": "Example usage:",
29912 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29916 "name": "updateVariables",
29917 "group": "Variables",
29918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29919 "version": "0.0.0",
29920 "filename": "server/api/variable/index.js",
29921 "groupTitle": "Variables"
29925 "url": "/api/version/fetch",
29926 "title": "Fetch git version",
29929 "title": "Example usage:",
29930 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29934 "name": "FetchVersion",
29935 "group": "Version",
29936 "description": "<p>Motion run the following command: git fetch origin master</p>",
29937 "version": "0.0.0",
29938 "filename": "server/api/version/index.js",
29939 "groupTitle": "Version"
29943 "url": "/api/version",
29944 "title": "Gets version",
29947 "title": "Example usage:",
29948 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29952 "name": "GetVersion",
29953 "group": "Version",
29954 "description": "<p>Motion returns the current and latest motion version.</p>",
29955 "version": "0.0.0",
29956 "filename": "server/api/version/index.js",
29957 "groupTitle": "Version"
29961 "url": "/api/version/migrations",
29962 "title": "Launch database migrations",
29965 "title": "Example usage:",
29966 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29970 "name": "MigrateVersion",
29971 "group": "Version",
29972 "description": "<p>Motion launch the database migrations, according to the application version</p>",
29973 "version": "0.0.0",
29974 "filename": "server/api/version/index.js",
29975 "groupTitle": "Version"
29979 "url": "/api/version/pull",
29980 "title": "Pull git version",
29983 "title": "Example usage:",
29984 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29988 "name": "PullVersion",
29989 "group": "Version",
29990 "description": "<p>Motion run the following command: git pull</p>",
29991 "version": "0.0.0",
29992 "filename": "server/api/version/index.js",
29993 "groupTitle": "Version"
29997 "url": "/api/version/reset",
29998 "title": "Reset git version",
30001 "title": "Example usage:",
30002 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30006 "name": "ResetVersion",
30007 "group": "Version",
30008 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30009 "version": "0.0.0",
30010 "filename": "server/api/version/index.js",
30011 "groupTitle": "Version"
30015 "url": "/api/version/restart",
30016 "title": "Restart motion2 after update",
30019 "title": "Example usage:",
30020 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30024 "name": "RestartVersion",
30025 "group": "Version",
30026 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30027 "version": "0.0.0",
30028 "filename": "server/api/version/index.js",
30029 "groupTitle": "Version"
30033 "url": "/api/voice/agents/reports/describe",
30034 "title": "Gets table info about Agent Reports",
30037 "title": "Example usage:",
30038 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30042 "name": "DescribeAgent_Reports",
30043 "group": "Voice_Agent_Reports",
30044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30045 "version": "0.0.0",
30046 "filename": "server/api/voiceAgentReport/index.js",
30047 "groupTitle": "Voice_Agent_Reports"
30051 "url": "/api/voice/agents/reports",
30052 "title": "Gets a list of Agent Reports",
30055 "title": "Example usage:",
30056 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30060 "name": "GetAgent_Reports",
30061 "group": "Voice_Agent_Reports",
30062 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30063 "version": "0.0.0",
30064 "filename": "server/api/voiceAgentReport/index.js",
30065 "groupTitle": "Voice_Agent_Reports"
30069 "url": "/api/voice/agents/reports/{id}",
30070 "title": "Gets a single Agent Report",
30073 "title": "Example usage:",
30074 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30078 "name": "ShowAgent_Reports",
30079 "group": "Voice_Agent_Reports",
30080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30081 "version": "0.0.0",
30082 "filename": "server/api/voiceAgentReport/index.js",
30083 "groupTitle": "Voice_Agent_Reports"
30087 "url": "/api/voice/calls/reports/describe",
30088 "title": "Gets table info about Call Reports",
30091 "title": "Example usage:",
30092 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30096 "name": "DescribeCall_Reports",
30097 "group": "Voice_Call_Reports",
30098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30099 "version": "0.0.0",
30100 "filename": "server/api/voiceCallReport/index.js",
30101 "groupTitle": "Voice_Call_Reports"
30105 "url": "/api/voice/calls/reports",
30106 "title": "Gets a list of Call Reports",
30109 "title": "Example usage:",
30110 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30114 "name": "GetCall_Reports",
30115 "group": "Voice_Call_Reports",
30116 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30117 "version": "0.0.0",
30118 "filename": "server/api/voiceCallReport/index.js",
30119 "groupTitle": "Voice_Call_Reports"
30123 "url": "/api/voice/calls/reports/{id}",
30124 "title": "Gets a single Call Report",
30127 "title": "Example usage:",
30128 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30132 "name": "ShowCall_Reports",
30133 "group": "Voice_Call_Reports",
30134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30135 "version": "0.0.0",
30136 "filename": "server/api/voiceCallReport/index.js",
30137 "groupTitle": "Voice_Call_Reports"
30141 "url": "/api/voice/calls/reports/{id}",
30142 "title": "Update a single cdr",
30145 "title": "Example usage:",
30146 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30151 "group": "Voice_Call_Reports",
30152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30153 "version": "0.0.0",
30154 "filename": "server/api/voiceCallReport/index.js",
30155 "groupTitle": "Voice_Call_Reports"
30159 "url": "/api/voice/chanspy",
30160 "title": "Creates a new ChanSpy",
30163 "title": "Example usage:",
30164 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30168 "name": "CreateChanSpy",
30169 "group": "Voice_ChanSpy",
30191 "field": "options",
30205 "field": "password",
30219 "field": "recordingFormat",
30226 "field": "description",
30232 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30233 "version": "0.0.0",
30234 "filename": "server/api/voiceChanSpy/index.js",
30235 "groupTitle": "Voice_ChanSpy"
30239 "url": "/api/voice/chanspy/{id}",
30240 "title": "Deletes a ChanSpy",
30243 "title": "Example usage:",
30244 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30248 "name": "DeleteChanSpy",
30249 "group": "Voice_ChanSpy",
30250 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30251 "version": "0.0.0",
30252 "filename": "server/api/voiceChanSpy/index.js",
30253 "groupTitle": "Voice_ChanSpy"
30257 "url": "/api/voice/chanspy",
30258 "title": "Gets a list of ChanSpy",
30261 "title": "Example usage:",
30262 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30266 "name": "GetChanSpy",
30267 "group": "Voice_ChanSpy",
30268 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30269 "version": "0.0.0",
30270 "filename": "server/api/voiceChanSpy/index.js",
30271 "groupTitle": "Voice_ChanSpy"
30275 "url": "/api/voice/chanspy/{id}",
30276 "title": "Gets a single ChanSpy",
30279 "title": "Example usage:",
30280 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30284 "name": "ShowChanSpy",
30285 "group": "Voice_ChanSpy",
30286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30287 "version": "0.0.0",
30288 "filename": "server/api/voiceChanSpy/index.js",
30289 "groupTitle": "Voice_ChanSpy"
30293 "url": "/api/voice/chanspy/{id}",
30294 "title": "Update an existing ChanSpy",
30297 "title": "Example usage:",
30298 "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",
30302 "name": "updateChanSpy",
30303 "group": "Voice_ChanSpy",
30304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30305 "version": "0.0.0",
30306 "filename": "server/api/voiceChanSpy/index.js",
30307 "groupTitle": "Voice_ChanSpy"
30311 "url": "/api/voice/contexts",
30312 "title": "Create a new context",
30315 "title": "Example usage:",
30316 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30321 "group": "Voice_Contexts",
30336 "field": "description",
30343 "field": "defaultEntry",
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/voiceContext/index.js",
30352 "groupTitle": "Voice_Contexts"
30356 "url": "/api/voice/contexts/{id}",
30357 "title": "Deletes a context",
30360 "title": "Example usage:",
30361 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30366 "group": "Voice_Contexts",
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/voiceContext/index.js",
30370 "groupTitle": "Voice_Contexts"
30374 "url": "/api/voice/contexts",
30375 "title": "Gets a list of Contexts",
30378 "title": "Example usage:",
30379 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30383 "name": "GetContexts",
30384 "group": "Voice_Contexts",
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/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>",
30386 "version": "0.0.0",
30387 "filename": "server/api/voiceContext/index.js",
30388 "groupTitle": "Voice_Contexts"
30392 "url": "/api/voice/contexts/{id}",
30393 "title": "Gets a single Context",
30396 "title": "Example usage:",
30397 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30401 "name": "ShowContexts",
30402 "group": "Voice_Contexts",
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/voiceContext/index.js",
30406 "groupTitle": "Voice_Contexts"
30410 "url": "/api/voice/contexts/{id}",
30411 "title": "Update an existing context",
30414 "title": "Example usage:",
30415 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30420 "group": "Voice_Contexts",
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/voiceContext/index.js",
30424 "groupTitle": "Voice_Contexts"
30428 "url": "/api/voice/dials/reports/describe",
30429 "title": "Gets table info about Dial Reports",
30432 "title": "Example usage:",
30433 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30437 "name": "DescribeDial_Reports",
30438 "group": "Voice_Dial_Reports",
30439 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30440 "version": "0.0.0",
30441 "filename": "server/api/voiceDialReport/index.js",
30442 "groupTitle": "Voice_Dial_Reports"
30446 "url": "/api/voice/dials/reports",
30447 "title": "Gets a list of Dial Reports",
30450 "title": "Example usage:",
30451 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30455 "name": "GetDial_Reports",
30456 "group": "Voice_Dial_Reports",
30457 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30458 "version": "0.0.0",
30459 "filename": "server/api/voiceDialReport/index.js",
30460 "groupTitle": "Voice_Dial_Reports"
30464 "url": "/api/voice/dials/reports/{id}",
30465 "title": "Gets a single Dial Report",
30468 "title": "Example usage:",
30469 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30473 "name": "ShowDial_Reports",
30474 "group": "Voice_Dial_Reports",
30475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30476 "version": "0.0.0",
30477 "filename": "server/api/voiceDialReport/index.js",
30478 "groupTitle": "Voice_Dial_Reports"
30482 "url": "/api/voice/extensions/{id}",
30483 "title": "Deletes a Extension",
30486 "title": "Example usage:",
30487 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30491 "name": "DeleteExtensions",
30492 "group": "Voice_Extensions",
30493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30494 "version": "0.0.0",
30495 "filename": "server/api/voiceExtension/index.js",
30496 "groupTitle": "Voice_Extensions"
30500 "url": "/api/voice/extensions",
30501 "title": "Gets a list of Extensions",
30504 "title": "Example usage:",
30505 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30509 "name": "GetExtensions",
30510 "group": "Voice_Extensions",
30511 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30512 "version": "0.0.0",
30513 "filename": "server/api/voiceExtension/index.js",
30514 "groupTitle": "Voice_Extensions"
30518 "url": "/api/voice/extensions/{id}",
30519 "title": "Gets a single Extension",
30522 "title": "Example usage:",
30523 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30527 "name": "ShowExtensions",
30528 "group": "Voice_Extensions",
30529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30530 "version": "0.0.0",
30531 "filename": "server/api/voiceExtension/index.js",
30532 "groupTitle": "Voice_Extensions"
30536 "url": "/api/voice/extensions",
30537 "title": "Create new applications",
30540 "title": "Example usage:",
30541 "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",
30545 "name": "addApplications",
30546 "group": "Voice_Extensions",
30547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30548 "version": "0.0.0",
30549 "filename": "server/api/voiceExtension/index.js",
30550 "groupTitle": "Voice_Extensions"
30554 "url": "/api/voice/extensions",
30555 "title": "Create an extension",
30558 "title": "Example usage:",
30559 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30564 "group": "Voice_Extensions",
30565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30566 "version": "0.0.0",
30567 "filename": "server/api/voiceExtension/index.js",
30568 "groupTitle": "Voice_Extensions"
30572 "url": "/api/voice/extensions/{id}",
30573 "title": "Update an extension",
30576 "title": "Example usage:",
30577 "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",
30582 "group": "Voice_Extensions",
30583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30584 "version": "0.0.0",
30585 "filename": "server/api/voiceExtension/index.js",
30586 "groupTitle": "Voice_Extensions"
30590 "url": "/api/voice/mohs",
30591 "title": "Create a new a new MOH",
30594 "title": "Example usage:",
30595 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30600 "group": "Voice_MOHs",
30601 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30602 "version": "0.0.0",
30603 "filename": "server/api/voiceMusicOnHold/index.js",
30604 "groupTitle": "Voice_MOHs"
30608 "url": "/api/voice/mohs/{id}/sounds",
30609 "title": "Add sound to MOH",
30612 "title": "Example usage:",
30613 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30617 "name": "AddSound",
30618 "group": "Voice_MOHs",
30619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30620 "version": "0.0.0",
30621 "filename": "server/api/voiceMusicOnHold/index.js",
30622 "groupTitle": "Voice_MOHs"
30626 "url": "/api/voice/mohs/{id}",
30627 "title": "Deletes an MOH",
30630 "title": "Example usage:",
30631 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30635 "name": "DestroyMoh",
30636 "group": "Voice_MOHs",
30637 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30638 "version": "0.0.0",
30639 "filename": "server/api/voiceMusicOnHold/index.js",
30640 "groupTitle": "Voice_MOHs"
30644 "url": "/api/voice/mohs",
30645 "title": "Gets a list of Music On Holds",
30648 "title": "Example usage:",
30649 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30653 "name": "GetMusic_On_Holds",
30654 "group": "Voice_MOHs",
30655 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30656 "version": "0.0.0",
30657 "filename": "server/api/voiceMusicOnHold/index.js",
30658 "groupTitle": "Voice_MOHs"
30662 "url": "/api/voice/mohs/{id}/sounds",
30663 "title": "Gets sounds from MOH",
30666 "title": "Example usage:",
30667 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30671 "name": "GetSounds",
30672 "group": "Voice_MOHs",
30673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30674 "version": "0.0.0",
30675 "filename": "server/api/voiceMusicOnHold/index.js",
30676 "groupTitle": "Voice_MOHs"
30680 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30681 "title": "Remove sound from MOH",
30684 "title": "Example usage:",
30685 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30689 "name": "RemoveSound",
30690 "group": "Voice_MOHs",
30691 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30692 "version": "0.0.0",
30693 "filename": "server/api/voiceMusicOnHold/index.js",
30694 "groupTitle": "Voice_MOHs"
30698 "url": "/api/voice/mohs/{id}",
30699 "title": "Gets a single Music On Hold",
30702 "title": "Example usage:",
30703 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30707 "name": "ShowMusic_On_Holds",
30708 "group": "Voice_MOHs",
30709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30710 "version": "0.0.0",
30711 "filename": "server/api/voiceMusicOnHold/index.js",
30712 "groupTitle": "Voice_MOHs"
30716 "url": "/api/voice/mohs/{id}",
30717 "title": "Update an existing Music On Hold",
30720 "title": "Example usage:",
30721 "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",
30725 "name": "updateMusic_On_Holds",
30726 "group": "Voice_MOHs",
30727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30728 "version": "0.0.0",
30729 "filename": "server/api/voiceMusicOnHold/index.js",
30730 "groupTitle": "Voice_MOHs"
30734 "url": "/api/voice/mails",
30735 "title": "Creates a new Mail",
30738 "title": "Example usage:",
30739 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30743 "name": "CreateMails",
30744 "group": "Voice_Mails",
30752 "field": "customer_id",
30759 "field": "context",
30766 "field": "mailbox",
30773 "field": "password",
30780 "field": "fullname",
30830 "field": "dialout",
30837 "field": "callback",
30859 "field": "operator",
30870 "field": "envelope",
30881 "field": "sayduration",
30888 "field": "saydurationm",
30899 "field": "sendvoicemail",
30921 "field": "nextaftercmd",
30932 "field": "forcename",
30943 "field": "forcegreetings",
30954 "field": "hidefromdir",
30968 "field": "emailsubject",
30975 "field": "emailbody",
30982 "field": "maxsecs",
31002 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31003 "version": "0.0.0",
31004 "filename": "server/api/voiceMail/index.js",
31005 "groupTitle": "Voice_Mails"
31009 "url": "/api/voice/mails/{id}",
31010 "title": "Deletes a Mail",
31013 "title": "Example usage:",
31014 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31018 "name": "DeleteMails",
31019 "group": "Voice_Mails",
31020 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31021 "version": "0.0.0",
31022 "filename": "server/api/voiceMail/index.js",
31023 "groupTitle": "Voice_Mails"
31027 "url": "/api/voice/mails",
31028 "title": "Gets a list of Mails",
31031 "title": "Example usage:",
31032 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31036 "name": "GetMails",
31037 "group": "Voice_Mails",
31038 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31039 "version": "0.0.0",
31040 "filename": "server/api/voiceMail/index.js",
31041 "groupTitle": "Voice_Mails"
31045 "url": "/api/voice/mails/{id}",
31046 "title": "Gets a single Mail",
31049 "title": "Example usage:",
31050 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31054 "name": "ShowMails",
31055 "group": "Voice_Mails",
31056 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31057 "version": "0.0.0",
31058 "filename": "server/api/voiceMail/index.js",
31059 "groupTitle": "Voice_Mails"
31063 "url": "/api/voice/mails/{id}/messages",
31064 "title": "Gets voice mail messages",
31067 "title": "Example usage:",
31068 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31072 "name": "getMessages",
31073 "group": "Voice_Mails",
31074 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31075 "version": "0.0.0",
31076 "filename": "server/api/voiceMail/index.js",
31077 "groupTitle": "Voice_Mails"
31081 "url": "/api/voice/mails/{id}",
31082 "title": "Update an existing Mail",
31085 "title": "Example usage:",
31086 "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",
31090 "name": "updateMails",
31091 "group": "Voice_Mails",
31092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31093 "version": "0.0.0",
31094 "filename": "server/api/voiceMail/index.js",
31095 "groupTitle": "Voice_Mails"
31099 "url": "/api/voice/mails/messages",
31100 "title": "Creates a new Message",
31103 "title": "Example usage:",
31104 "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",
31108 "name": "CreateMessages",
31109 "group": "Voice_Messages",
31138 "field": "context",
31145 "field": "macrocontext",
31152 "field": "callerid",
31159 "field": "origtime",
31166 "field": "duration",
31173 "field": "mailboxuser",
31180 "field": "mailboxcontext",
31187 "field": "recording",
31214 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31215 "version": "0.0.0",
31216 "filename": "server/api/voiceMailMessage/index.js",
31217 "groupTitle": "Voice_Messages"
31221 "url": "/api/voice/mails/messages/{id}",
31222 "title": "Deletes a Message",
31225 "title": "Example usage:",
31226 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31230 "name": "DeleteMessages",
31231 "group": "Voice_Messages",
31232 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31233 "version": "0.0.0",
31234 "filename": "server/api/voiceMailMessage/index.js",
31235 "groupTitle": "Voice_Messages"
31239 "url": "/api/voice/mails/messages",
31240 "title": "Gets a list of Messages",
31243 "title": "Example usage:",
31244 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31248 "name": "GetMessages",
31249 "group": "Voice_Messages",
31250 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31251 "version": "0.0.0",
31252 "filename": "server/api/voiceMailMessage/index.js",
31253 "groupTitle": "Voice_Messages"
31257 "url": "/api/voice/mails/messages/{id}",
31258 "title": "Gets a single Message",
31261 "title": "Example usage:",
31262 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31266 "name": "ShowMessages",
31267 "group": "Voice_Messages",
31268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31269 "version": "0.0.0",
31270 "filename": "server/api/voiceMailMessage/index.js",
31271 "groupTitle": "Voice_Messages"
31275 "url": "voice/mails/messages/{id}/download",
31276 "title": "Download Voice Message",
31279 "title": "Example usage:",
31280 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31284 "name": "download",
31285 "group": "Voice_Messages",
31286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31287 "version": "0.0.0",
31288 "filename": "server/api/voiceMailMessage/index.js",
31289 "groupTitle": "Voice_Messages"
31293 "url": "/api/voice/mails/messages/{id}",
31294 "title": "Update an existing Message",
31297 "title": "Example usage:",
31298 "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",
31302 "name": "updateMessages",
31303 "group": "Voice_Messages",
31304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31305 "version": "0.0.0",
31306 "filename": "server/api/voiceMailMessage/index.js",
31307 "groupTitle": "Voice_Messages"
31311 "url": "/api/voice/prefixes/{id}/users",
31312 "title": "Add agents to a prefix",
31315 "title": "Example usage:",
31316 "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",
31320 "name": "AddAgents",
31321 "group": "Voice_Prefixes",
31322 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31323 "version": "0.0.0",
31324 "filename": "server/api/voicePrefix/index.js",
31325 "groupTitle": "Voice_Prefixes"
31329 "url": "/api/voice/prefixes/{id}",
31330 "title": "Deletes a Prefix",
31333 "title": "Example usage:",
31334 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31338 "name": "DeletePrefixes",
31339 "group": "Voice_Prefixes",
31340 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31341 "version": "0.0.0",
31342 "filename": "server/api/voicePrefix/index.js",
31343 "groupTitle": "Voice_Prefixes"
31347 "url": "/api/voice/prefixes/describe",
31348 "title": "Gets table info about Prefixes",
31351 "title": "Example usage:",
31352 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31356 "name": "DescribePrefixes",
31357 "group": "Voice_Prefixes",
31358 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31359 "version": "0.0.0",
31360 "filename": "server/api/voicePrefix/index.js",
31361 "groupTitle": "Voice_Prefixes"
31365 "url": "/api/voice/prefixes/{id}/users",
31366 "title": "Gets agents from prefix",
31369 "title": "Example usage:",
31370 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31374 "name": "GetAgents",
31375 "group": "Voice_Prefixes",
31376 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31377 "version": "0.0.0",
31378 "filename": "server/api/voicePrefix/index.js",
31379 "groupTitle": "Voice_Prefixes"
31383 "url": "/api/voice/prefixes",
31384 "title": "Gets a list of Prefixes",
31387 "title": "Example usage:",
31388 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31392 "name": "GetPrefixes",
31393 "group": "Voice_Prefixes",
31394 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31395 "version": "0.0.0",
31396 "filename": "server/api/voicePrefix/index.js",
31397 "groupTitle": "Voice_Prefixes"
31401 "url": "/api/voice/prefixes/{id}/users",
31402 "title": "Removes agents from a prefix",
31405 "title": "Example usage:",
31406 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31410 "name": "RemoveAgents",
31411 "group": "Voice_Prefixes",
31412 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31413 "version": "0.0.0",
31414 "filename": "server/api/voicePrefix/index.js",
31415 "groupTitle": "Voice_Prefixes"
31419 "url": "/api/voice/prefixes/{id}",
31420 "title": "Gets a single Prefix",
31423 "title": "Example usage:",
31424 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31428 "name": "ShowPrefixes",
31429 "group": "Voice_Prefixes",
31430 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31431 "version": "0.0.0",
31432 "filename": "server/api/voicePrefix/index.js",
31433 "groupTitle": "Voice_Prefixes"
31437 "url": "/api/voice/prefixes/{id}",
31438 "title": "Update an existing prefix",
31441 "title": "Example usage:",
31442 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31447 "group": "Voice_Prefixes",
31448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31449 "version": "0.0.0",
31450 "filename": "server/api/voicePrefix/index.js",
31451 "groupTitle": "Voice_Prefixes"
31455 "url": "/api/voice/prefixes",
31456 "title": "Create a prefix",
31459 "title": "Example usage:",
31460 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31465 "group": "Voice_Prefixes",
31466 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31467 "version": "0.0.0",
31468 "filename": "server/api/voicePrefix/index.js",
31469 "groupTitle": "Voice_Prefixes"
31473 "url": "/api/voice/queues/reports/describe",
31474 "title": "Gets table info about Queue Reports",
31477 "title": "Example usage:",
31478 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31482 "name": "DescribeQueue_Reports",
31483 "group": "Voice_Queue_Reports",
31484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31485 "version": "0.0.0",
31486 "filename": "server/api/voiceQueueReport/index.js",
31487 "groupTitle": "Voice_Queue_Reports"
31491 "url": "/api/voice/queues/reports",
31492 "title": "Gets a list of Queue Reports",
31495 "title": "Example usage:",
31496 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31500 "name": "GetQueue_Reports",
31501 "group": "Voice_Queue_Reports",
31502 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31503 "version": "0.0.0",
31504 "filename": "server/api/voiceQueueReport/index.js",
31505 "groupTitle": "Voice_Queue_Reports"
31509 "url": "/api/voice/queues/reports/{id}",
31510 "title": "Gets a single Queue Report",
31513 "title": "Example usage:",
31514 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31518 "name": "ShowQueue_Reports",
31519 "group": "Voice_Queue_Reports",
31520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31521 "version": "0.0.0",
31522 "filename": "server/api/voiceQueueReport/index.js",
31523 "groupTitle": "Voice_Queue_Reports"
31527 "url": "/api/voice/queues/reports/index",
31528 "title": "Get Voice Queues Report",
31531 "title": "Example usage:",
31532 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31536 "name": "getVoiceQueuesReport",
31537 "group": "Voice_Queue_Reports",
31538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31539 "version": "0.0.0",
31540 "filename": "server/api/voiceQueueReport/index.js",
31541 "groupTitle": "Voice_Queue_Reports"
31545 "url": "/api/voice/queues/{id}/users",
31546 "title": "Add agents to queue",
31549 "title": "Example usage:",
31550 "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",
31554 "name": "AddAgents",
31555 "group": "Voice_Queues",
31556 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31557 "version": "0.0.0",
31558 "filename": "server/api/voiceQueue/index.js",
31559 "groupTitle": "Voice_Queues"
31563 "url": "/api/voice/queues/{id}/blacklists",
31564 "title": "Add blacklists to a queue",
31567 "title": "Example usage:",
31568 "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",
31572 "name": "AddBlackLists",
31573 "group": "Voice_Queues",
31574 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31575 "version": "0.0.0",
31576 "filename": "server/api/voiceQueue/index.js",
31577 "groupTitle": "Voice_Queues"
31581 "url": "/api/voice/queues/{id}/lists",
31582 "title": "Add lists to a queue",
31585 "title": "Example usage:",
31586 "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",
31590 "name": "AddLists",
31591 "group": "Voice_Queues",
31592 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31593 "version": "0.0.0",
31594 "filename": "server/api/voiceQueue/index.js",
31595 "groupTitle": "Voice_Queues"
31599 "url": "/api/voice/queues/{id}/teams",
31600 "title": "Add teams to queue",
31603 "title": "Example usage:",
31604 "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",
31608 "name": "AddTeams",
31609 "group": "Voice_Queues",
31610 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31611 "version": "0.0.0",
31612 "filename": "server/api/voiceQueue/index.js",
31613 "groupTitle": "Voice_Queues"
31617 "url": "/api/voice/queues/clone",
31618 "title": "Clone an existing Queue",
31621 "title": "Example usage:",
31622 "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",
31626 "name": "CloneQueues",
31627 "group": "Voice_Queues",
31628 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31629 "version": "0.0.0",
31630 "filename": "server/api/voiceQueue/index.js",
31631 "groupTitle": "Voice_Queues"
31635 "url": "/api/voice/queues",
31636 "title": "Creates a new Queue",
31639 "title": "Example usage:",
31640 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31644 "name": "CreateQueues",
31645 "group": "Voice_Queues",
31671 "field": "musiconhold",
31678 "field": "announce",
31696 "field": "strategy",
31703 "field": "servicelevel",
31710 "field": "context",
31717 "field": "penaltymemberslimit",
31724 "field": "timeout",
31738 "field": "timeoutpriority",
31752 "field": "wrapuptime",
31763 "field": "autofill",
31775 "field": "autopause",
31782 "field": "autopausedelay",
31793 "field": "autopausebusy",
31804 "field": "autopauseunavail",
31822 "field": "setinterfacevar",
31833 "field": "setqueueentryvar",
31844 "field": "setqueuevar",
31855 "field": "eventmemberstatus",
31862 "field": "membermacro",
31869 "field": "membergosub",
31876 "field": "announce_frequency",
31883 "field": "min_announce_frequency",
31890 "field": "periodic_announce_frequency",
31901 "field": "random_periodic_announce",
31912 "field": "relative_periodic_announce",
31924 "field": "announce_holdtime",
31931 "field": "announce_position",
31942 "field": "announce_to_first_user",
31949 "field": "announce_position_limit",
31964 "field": "announce_round_seconds",
31971 "field": "monitor_format",
31978 "field": "monitor_type",
31985 "field": "queue_youarenext",
31992 "field": "queue_thereare",
31999 "field": "queue_callswaiting",
32006 "field": "queue_holdtime",
32013 "field": "queue_minute",
32020 "field": "queue_minutes",
32027 "field": "queue_seconds",
32034 "field": "queue_thankyou",
32041 "field": "queue_reporthold",
32048 "field": "queue_quantity1",
32055 "field": "queue_quantity2",
32062 "field": "queue_periodic_announce",
32069 "field": "queue_less_than",
32076 "field": "periodic_announce",
32083 "field": "joinempty",
32090 "field": "leavewhenempty",
32101 "field": "reportholdtime",
32112 "field": "ringinuse",
32119 "field": "memberdelay",
32130 "field": "timeoutrestart",
32137 "field": "defaultrule",
32144 "field": "description",
32158 "field": "acwTimeout",
32165 "field": "dialActive",
32166 "description": "<p>Active/Disactive Campaign</p>"
32179 "field": "dialMethod",
32180 "description": "<p>Dial Method.</p>"
32186 "field": "dialLimitChannel",
32187 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32193 "field": "dialLimitQueue",
32194 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32200 "field": "dialPowerLevel",
32201 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32207 "\"agentBusyFactor\"",
32211 "field": "dialPredictiveOptimization",
32212 "description": "<p>Only for predictive method.</p>"
32218 "field": "dialPredictiveOptimizationPercentage",
32219 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32225 "field": "dialPredictiveInterval",
32226 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32232 "field": "dialOriginateCallerIdName",
32239 "field": "dialOriginateCallerIdNumber",
32246 "field": "dialOriginateTimeout",
32247 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32253 "field": "dialQueueOptions",
32254 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32260 "field": "dialQueueTimeout",
32261 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32267 "field": "dialQueueProject",
32268 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32274 "field": "dialCongestionMaxRetry",
32275 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32281 "field": "dialCongestionRetryFrequency",
32282 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32288 "field": "dialBusyMaxRetry",
32289 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32295 "field": "dialBusyRetryFrequency",
32296 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32302 "field": "dialNoAnswerMaxRetry",
32303 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32309 "field": "dialNoAnswerRetryFrequency",
32310 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32316 "field": "dialGlobalMaxRetry",
32317 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32323 "field": "dialTimezone",
32330 "field": "dialGlobalInterval",
32337 "field": "dialPrefix",
32349 "field": "dialCheckDuplicateType",
32356 "field": "dialAMDActive",
32357 "description": "<p>Active/Disactive AMD</p>"
32363 "field": "dialAMDInitialSilence",
32364 "description": "<p>#AMD Initial Silence</p>"
32370 "field": "dialAMDGreeting",
32371 "description": "<p>#AMD Greeting</p>"
32377 "field": "dialAMDAfterGreetingSilence",
32378 "description": "<p>#AMD After Greeting Silence</p>"
32384 "field": "dialAMDTotalAnalysisTime",
32385 "description": "<p>#AMD Total Analysis Time</p>"
32391 "field": "dialAMDMinWordLength",
32392 "description": "<p>#AMD Min Word Length</p>"
32398 "field": "dialAMDBetweenWordsSilence",
32399 "description": "<p>#AMD Between Words Silence</p>"
32405 "field": "dialAMDMaximumNumberOfWords",
32406 "description": "<p>#AMD Maximum Number Of Words</p>"
32412 "field": "dialAMDSilenceThreshold",
32413 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32419 "field": "dialAMDMaximumWordLength",
32420 "description": "<p>#AMD Maximum Word Length</p>"
32426 "field": "dialRecallMeTimeout",
32427 "description": "<p>#RecallMe Timeout (min:1)</p>"
32433 "field": "dialRecallInQueue",
32434 "description": "<p>Active/Disactive Recall In Queue</p>"
32444 "field": "dialOrderByScheduledAt",
32451 "field": "dialQueueProject2",
32452 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32458 "field": "dialAgiAfterHangupClient",
32465 "field": "dialAgiAfterHangupAgent",
32472 "field": "dialRandomLastDigitCallerIdNumber",
32473 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32479 "field": "dialCutDigit",
32480 "description": "<p>Cut Digit (min:1, max:15)</p>"
32486 "field": "dialNoSuchNumberMaxRetry",
32487 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32493 "field": "dialNoSuchNumberRetryFrequency",
32494 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32500 "field": "dialDropMaxRetry",
32501 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32507 "field": "dialDropRetryFrequency",
32508 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32514 "field": "dialAbandonedMaxRetry",
32515 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32521 "field": "dialAbandonedRetryFrequency",
32522 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32528 "field": "dialMachineMaxRetry",
32529 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32535 "field": "dialMachineRetryFrequency",
32536 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32542 "field": "dialAgentRejectMaxRetry",
32543 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32549 "field": "dialAgentRejectRetryFrequency",
32550 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32556 "field": "mandatoryDispositionPauseId",
32557 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32563 "field": "mandatoryDisposition",
32564 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32570 "field": "dialPredictiveIntervalMaxThreshold",
32577 "field": "dialPredictiveIntervalMinThreshold",
32583 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32584 "version": "0.0.0",
32585 "filename": "server/api/voiceQueue/index.js",
32586 "groupTitle": "Voice_Queues"
32590 "url": "/api/voice/queues/{id}",
32591 "title": "Deletes a Queue",
32594 "title": "Example usage:",
32595 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32599 "name": "DeleteQueues",
32600 "group": "Voice_Queues",
32601 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32602 "version": "0.0.0",
32603 "filename": "server/api/voiceQueue/index.js",
32604 "groupTitle": "Voice_Queues"
32608 "url": "/api/voice/queues/{id}/users",
32609 "title": "Gets queue agents",
32612 "title": "Example usage:",
32613 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32617 "name": "GetAgents",
32618 "group": "Voice_Queues",
32619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32620 "version": "0.0.0",
32621 "filename": "server/api/voiceQueue/index.js",
32622 "groupTitle": "Voice_Queues"
32626 "url": "/api/voice/queues/{id}/blacklists",
32627 "title": "Get queue blacklists",
32630 "title": "Example usage:",
32631 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32635 "name": "GetBlackLists",
32636 "group": "Voice_Queues",
32637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32638 "version": "0.0.0",
32639 "filename": "server/api/voiceQueue/index.js",
32640 "groupTitle": "Voice_Queues"
32644 "url": "/api/voice/queues/{id}/finals",
32645 "title": "Gets queue hopper finals",
32648 "title": "Example usage:",
32649 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32653 "name": "GetHopperFinals",
32654 "group": "Voice_Queues",
32655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32656 "version": "0.0.0",
32657 "filename": "server/api/voiceQueue/index.js",
32658 "groupTitle": "Voice_Queues"
32662 "url": "/api/voice/queues/{id}/hopper_histories",
32663 "title": "Gets queue hopper histories",
32666 "title": "Example usage:",
32667 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32671 "name": "GetHopperHistories",
32672 "group": "Voice_Queues",
32673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32674 "version": "0.0.0",
32675 "filename": "server/api/voiceQueue/index.js",
32676 "groupTitle": "Voice_Queues"
32680 "url": "/api/voice/queues/{id}/hoppers",
32681 "title": "Gets queue hoppers",
32684 "title": "Example usage:",
32685 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32689 "name": "GetHoppers",
32690 "group": "Voice_Queues",
32691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32692 "version": "0.0.0",
32693 "filename": "server/api/voiceQueue/index.js",
32694 "groupTitle": "Voice_Queues"
32698 "url": "/api/voice/queues/{id}/lists",
32699 "title": "Get queue lists",
32702 "title": "Example usage:",
32703 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32707 "name": "GetLists",
32708 "group": "Voice_Queues",
32709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32710 "version": "0.0.0",
32711 "filename": "server/api/voiceQueue/index.js",
32712 "groupTitle": "Voice_Queues"
32716 "url": "/api/voice/queues/{id}/members",
32717 "title": "Gets queue members",
32720 "title": "Example usage:",
32721 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32725 "name": "GetMembers",
32726 "group": "Voice_Queues",
32727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32728 "version": "0.0.0",
32729 "filename": "server/api/voiceQueue/index.js",
32730 "groupTitle": "Voice_Queues"
32734 "url": "/api/voice/queues",
32735 "title": "Gets a list of Queues",
32738 "title": "Example usage:",
32739 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32743 "name": "GetQueues",
32744 "group": "Voice_Queues",
32745 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32746 "version": "0.0.0",
32747 "filename": "server/api/voiceQueue/index.js",
32748 "groupTitle": "Voice_Queues"
32752 "url": "/api/voice/queues/{id}/teams",
32753 "title": "Gets queue team",
32756 "title": "Example usage:",
32757 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32761 "name": "GetTeams",
32762 "group": "Voice_Queues",
32763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32764 "version": "0.0.0",
32765 "filename": "server/api/voiceQueue/index.js",
32766 "groupTitle": "Voice_Queues"
32770 "url": "/api/voice/queues/{id}/users",
32771 "title": "Removes agents from a queue",
32774 "title": "Example usage:",
32775 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32779 "name": "RemoveAgents",
32780 "group": "Voice_Queues",
32781 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32782 "version": "0.0.0",
32783 "filename": "server/api/voiceQueue/index.js",
32784 "groupTitle": "Voice_Queues"
32788 "url": "/api/voice/queues/{id}/blacklists",
32789 "title": "Remove blacklists from a queue",
32792 "title": "Example usage:",
32793 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32797 "name": "RemoveBlackLists",
32798 "group": "Voice_Queues",
32799 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32800 "version": "0.0.0",
32801 "filename": "server/api/voiceQueue/index.js",
32802 "groupTitle": "Voice_Queues"
32806 "url": "/api/voice/queues/{id}/lists",
32807 "title": "Remove lists from a queue",
32810 "title": "Example usage:",
32811 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32815 "name": "RemoveLists",
32816 "group": "Voice_Queues",
32817 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32818 "version": "0.0.0",
32819 "filename": "server/api/voiceQueue/index.js",
32820 "groupTitle": "Voice_Queues"
32824 "url": "/api/voice/queues/{id}",
32825 "title": "Gets a single Queue",
32828 "title": "Example usage:",
32829 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32833 "name": "ShowQueues",
32834 "group": "Voice_Queues",
32835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32836 "version": "0.0.0",
32837 "filename": "server/api/voiceQueue/index.js",
32838 "groupTitle": "Voice_Queues"
32842 "url": "/api/voice/queues/{id}/blacks",
32843 "title": "Gets queue hopper blacks",
32846 "title": "Example usage:",
32847 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
32851 "name": "getHopperBlacks",
32852 "group": "Voice_Queues",
32853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32854 "version": "0.0.0",
32855 "filename": "server/api/voiceQueue/index.js",
32856 "groupTitle": "Voice_Queues"
32860 "url": "/api/voice/queues/{id}",
32861 "title": "Update an existing Queue",
32864 "title": "Example usage:",
32865 "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",
32869 "name": "updateQueues",
32870 "group": "Voice_Queues",
32871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32872 "version": "0.0.0",
32873 "filename": "server/api/voiceQueue/index.js",
32874 "groupTitle": "Voice_Queues"
32878 "url": "/api/voice/recordings",
32879 "title": "Creates a new Recording",
32882 "title": "Example usage:",
32883 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32887 "name": "CreateRecordings",
32888 "group": "Voice_Recordings",
32903 "field": "uniqueid",
32910 "field": "channel",
32917 "field": "membername",
32924 "field": "calleridnum",
32931 "field": "calleridname",
32938 "field": "connectedlinenum",
32945 "field": "connectedlinename",
32952 "field": "accountcode",
32959 "field": "context",
33001 "field": "userDisposition",
33008 "field": "userSecondDisposition",
33015 "field": "userThirdDisposition",
33022 "field": "location",
33029 "field": "transcribeName",
33036 "field": "transcribeStatus",
33043 "field": "fileUri",
33050 "field": "fileText",
33057 "field": "failureReason",
33064 "field": "sentiment",
33071 "field": "sPositive",
33078 "field": "sNegative",
33085 "field": "sNeutral",
33099 "field": "tempSentiment",
33106 "field": "createdAt",
33113 "field": "updatedAt",
33119 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33120 "version": "0.0.0",
33121 "filename": "server/api/voiceRecording/index.js",
33122 "groupTitle": "Voice_Recordings"
33126 "url": "/api/voice/recordings/describe",
33127 "title": "Gets table info about Recordings",
33130 "title": "Example usage:",
33131 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33135 "name": "DescribeRecordings",
33136 "group": "Voice_Recordings",
33137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33138 "version": "0.0.0",
33139 "filename": "server/api/voiceRecording/index.js",
33140 "groupTitle": "Voice_Recordings"
33144 "url": "/api/voice/recordings",
33145 "title": "Gets a list of Recordings",
33148 "title": "Example usage:",
33149 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33153 "name": "GetRecordings",
33154 "group": "Voice_Recordings",
33155 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33156 "version": "0.0.0",
33157 "filename": "server/api/voiceRecording/index.js",
33158 "groupTitle": "Voice_Recordings"
33162 "url": "/api/voice/recordings/{id}",
33163 "title": "Gets a single Recording",
33166 "title": "Example usage:",
33167 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33171 "name": "ShowRecordings",
33172 "group": "Voice_Recordings",
33173 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33174 "version": "0.0.0",
33175 "filename": "server/api/voiceRecording/index.js",
33176 "groupTitle": "Voice_Recordings"
33180 "url": "/api/voice/recordings/{id}",
33181 "title": "Delete voice recording",
33184 "title": "Example usage:",
33185 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33190 "group": "Voice_Recordings",
33191 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33192 "version": "0.0.0",
33193 "filename": "server/api/voiceRecording/index.js",
33194 "groupTitle": "Voice_Recordings"
33198 "url": "/api/voice/recordings/{id}/download",
33199 "title": "Download Recording",
33202 "title": "Example usage:",
33203 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33207 "name": "download",
33208 "group": "Voice_Recordings",
33209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33210 "version": "0.0.0",
33211 "filename": "server/api/voiceRecording/index.js",
33212 "groupTitle": "Voice_Recordings"
33216 "url": "/api/voice/recordings/{id}/downloads",
33217 "title": "Download Recording",
33220 "title": "Example usage:",
33221 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33225 "name": "downloads",
33226 "group": "Voice_Recordings",
33227 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33228 "version": "0.0.0",
33229 "filename": "server/api/voiceRecording/index.js",
33230 "groupTitle": "Voice_Recordings"
33234 "url": "/api/voice/recordings/{id}/transcribe",
33235 "title": "Run Transcribe Recording",
33238 "title": "Example usage:",
33239 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33243 "name": "transcribe",
33244 "group": "Voice_Recordings",
33245 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33246 "version": "0.0.0",
33247 "filename": "server/api/voiceRecording/index.js",
33248 "groupTitle": "Voice_Recordings"
33252 "url": "/api/voice/recordings/{id}/transcribe",
33253 "title": "Run Transcribe Recording",
33256 "title": "Example usage:",
33257 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33261 "name": "transcribe",
33262 "group": "Voice_Recordings",
33263 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33264 "version": "0.0.0",
33265 "filename": "server/api/voiceRecording/index.js",
33266 "groupTitle": "Voice_Recordings"
33270 "url": "/api/voice/recordings/{id}",
33271 "title": "Update an existing Recording",
33274 "title": "Example usage:",
33275 "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",
33279 "name": "updateRecordings",
33280 "group": "Voice_Recordings",
33281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33282 "version": "0.0.0",
33283 "filename": "server/api/voiceRecording/index.js",
33284 "groupTitle": "Voice_Recordings"
33288 "url": "/api/voice/transfers/reports",
33289 "title": "Creates a new Transfer Report",
33292 "title": "Example usage:",
33293 "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",
33297 "name": "CreateTransfer_Reports",
33298 "group": "Voice_Transfer_Reports",
33324 "field": "transfererchannel",
33331 "field": "transferercalleridnum",
33338 "field": "transferercalleridname",
33345 "field": "transfererconnectedlinenum",
33352 "field": "transfererconnectedlinename",
33359 "field": "transfereraccountcode",
33366 "field": "transferercontext",
33373 "field": "transfererexten",
33380 "field": "transfererlinkedid",
33387 "field": "transfereechannel",
33394 "field": "transfereecalleridnum",
33401 "field": "transfereecalleridname",
33408 "field": "transfereeconnectedlinenum",
33415 "field": "transfereeconnectedlinename",
33422 "field": "transfereeaccountcode",
33429 "field": "transfereecontext",
33436 "field": "transfereeexten",
33443 "field": "transfereelinkedid",
33454 "field": "isexternal",
33461 "field": "context",
33468 "field": "extension",
33474 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33475 "version": "0.0.0",
33476 "filename": "server/api/voiceTransferReport/index.js",
33477 "groupTitle": "Voice_Transfer_Reports"
33481 "url": "/api/voice/transfers/reports/{id}",
33482 "title": "Deletes a Transfer Report",
33485 "title": "Example usage:",
33486 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33490 "name": "DeleteTransfer_Reports",
33491 "group": "Voice_Transfer_Reports",
33492 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33493 "version": "0.0.0",
33494 "filename": "server/api/voiceTransferReport/index.js",
33495 "groupTitle": "Voice_Transfer_Reports"
33499 "url": "/api/voice/transfers/reports/describe",
33500 "title": "Gets table info about Transfer Reports",
33503 "title": "Example usage:",
33504 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33508 "name": "DescribeTransfer_Reports",
33509 "group": "Voice_Transfer_Reports",
33510 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33511 "version": "0.0.0",
33512 "filename": "server/api/voiceTransferReport/index.js",
33513 "groupTitle": "Voice_Transfer_Reports"
33517 "url": "/api/voice/transfers/reports",
33518 "title": "Gets a list of Transfer Reports",
33521 "title": "Example usage:",
33522 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33526 "name": "GetTransfer_Reports",
33527 "group": "Voice_Transfer_Reports",
33528 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33529 "version": "0.0.0",
33530 "filename": "server/api/voiceTransferReport/index.js",
33531 "groupTitle": "Voice_Transfer_Reports"
33535 "url": "/api/voice/transfers/reports/{id}",
33536 "title": "Gets a single Transfer Report",
33539 "title": "Example usage:",
33540 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33544 "name": "ShowTransfer_Reports",
33545 "group": "Voice_Transfer_Reports",
33546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33547 "version": "0.0.0",
33548 "filename": "server/api/voiceTransferReport/index.js",
33549 "groupTitle": "Voice_Transfer_Reports"
33553 "url": "/api/voice/transfers/reports/{id}",
33554 "title": "Update an existing Transfer Report",
33557 "title": "Example usage:",
33558 "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",
33562 "name": "updateTransfer_Reports",
33563 "group": "Voice_Transfer_Reports",
33564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33565 "version": "0.0.0",
33566 "filename": "server/api/voiceTransferReport/index.js",
33567 "groupTitle": "Voice_Transfer_Reports"
33571 "url": "/api/integrations/vtiger/accounts",
33572 "title": "Creates a new Vtiger Account",
33575 "title": "Example usage:",
33576 "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",
33580 "name": "CreateVtiger_Accounts",
33581 "group": "Vtiger_Accounts",
33596 "field": "description",
33603 "field": "username",
33610 "field": "moduleName",
33617 "field": "remoteUri",
33624 "field": "serverUrl",
33631 "field": "accessKey",
33637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33638 "version": "0.0.0",
33639 "filename": "server/api/intVtigerAccount/index.js",
33640 "groupTitle": "Vtiger_Accounts"
33644 "url": "/api/integrations/vtiger/accounts/{id}",
33645 "title": "Deletes a Vtiger Account",
33648 "title": "Example usage:",
33649 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33653 "name": "DeleteVtiger_Accounts",
33654 "group": "Vtiger_Accounts",
33655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33656 "version": "0.0.0",
33657 "filename": "server/api/intVtigerAccount/index.js",
33658 "groupTitle": "Vtiger_Accounts"
33662 "url": "/api/integrations/vtiger/accounts",
33663 "title": "Gets a list of Vtiger Accounts",
33666 "title": "Example usage:",
33667 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33671 "name": "GetVtiger_Accounts",
33672 "group": "Vtiger_Accounts",
33673 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33674 "version": "0.0.0",
33675 "filename": "server/api/intVtigerAccount/index.js",
33676 "groupTitle": "Vtiger_Accounts"
33680 "url": "/api/integrations/vtiger/accounts/{id}",
33681 "title": "Gets a single Vtiger Account",
33684 "title": "Example usage:",
33685 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33689 "name": "ShowVtiger_Accounts",
33690 "group": "Vtiger_Accounts",
33691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33692 "version": "0.0.0",
33693 "filename": "server/api/intVtigerAccount/index.js",
33694 "groupTitle": "Vtiger_Accounts"
33698 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33699 "title": "Creates new configuration",
33702 "title": "Example usage:",
33703 "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",
33707 "name": "addConfiguration",
33708 "group": "Vtiger_Accounts",
33709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33710 "version": "0.0.0",
33711 "filename": "server/api/intVtigerAccount/index.js",
33712 "groupTitle": "Vtiger_Accounts"
33716 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33717 "title": "Gets account configurations",
33720 "title": "Example usage:",
33721 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33725 "name": "getConfigurations",
33726 "group": "Vtiger_Accounts",
33727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33728 "version": "0.0.0",
33729 "filename": "server/api/intVtigerAccount/index.js",
33730 "groupTitle": "Vtiger_Accounts"
33734 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33735 "title": "Gets account fields",
33738 "title": "Example usage:",
33739 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33743 "name": "getFields",
33744 "group": "Vtiger_Accounts",
33745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33746 "version": "0.0.0",
33747 "filename": "server/api/intVtigerAccount/index.js",
33748 "groupTitle": "Vtiger_Accounts"
33752 "url": "/api/integrations/vtiger/accounts/{id}",
33753 "title": "Update an existing Vtiger Account",
33756 "title": "Example usage:",
33757 "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",
33761 "name": "updateVtiger_Accounts",
33762 "group": "Vtiger_Accounts",
33763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33764 "version": "0.0.0",
33765 "filename": "server/api/intVtigerAccount/index.js",
33766 "groupTitle": "Vtiger_Accounts"
33770 "url": "/api/integrations/vtiger/configurations",
33771 "title": "Creates a new Vtiger Configuration",
33774 "title": "Example usage:",
33775 "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",
33779 "name": "CreateVtiger_Configurations",
33780 "group": "Vtiger_Configurations",
33795 "field": "description",
33801 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33802 "version": "0.0.0",
33803 "filename": "server/api/intVtigerConfiguration/index.js",
33804 "groupTitle": "Vtiger_Configurations"
33808 "url": "/api/integrations/vtiger/configurations/{id}",
33809 "title": "Deletes a Vtiger Configuration",
33812 "title": "Example usage:",
33813 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33817 "name": "DeleteVtiger_Configurations",
33818 "group": "Vtiger_Configurations",
33819 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33820 "version": "0.0.0",
33821 "filename": "server/api/intVtigerConfiguration/index.js",
33822 "groupTitle": "Vtiger_Configurations"
33826 "url": "/api/integrations/vtiger/configurations",
33827 "title": "Gets a list of Vtiger Configurations",
33830 "title": "Example usage:",
33831 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33835 "name": "GetVtiger_Configurations",
33836 "group": "Vtiger_Configurations",
33837 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33838 "version": "0.0.0",
33839 "filename": "server/api/intVtigerConfiguration/index.js",
33840 "groupTitle": "Vtiger_Configurations"
33844 "url": "/api/integrations/vtiger/configurations/{id}",
33845 "title": "Gets a single Vtiger Configuration",
33848 "title": "Example usage:",
33849 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33853 "name": "ShowVtiger_Configurations",
33854 "group": "Vtiger_Configurations",
33855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33856 "version": "0.0.0",
33857 "filename": "server/api/intVtigerConfiguration/index.js",
33858 "groupTitle": "Vtiger_Configurations"
33862 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33863 "title": "Gets configurations descriptions",
33866 "title": "Example usage:",
33867 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33871 "name": "getDescriptions",
33872 "group": "Vtiger_Configurations",
33873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33874 "version": "0.0.0",
33875 "filename": "server/api/intVtigerConfiguration/index.js",
33876 "groupTitle": "Vtiger_Configurations"
33880 "url": "/api/integrations/vtiger/configurations/{id}/fields",
33881 "title": "Gets configurations fields",
33884 "title": "Example usage:",
33885 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33889 "name": "getFields",
33890 "group": "Vtiger_Configurations",
33891 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33892 "version": "0.0.0",
33893 "filename": "server/api/intVtigerConfiguration/index.js",
33894 "groupTitle": "Vtiger_Configurations"
33898 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33899 "title": "Gets configurations subjects",
33902 "title": "Example usage:",
33903 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33907 "name": "getSubjects",
33908 "group": "Vtiger_Configurations",
33909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33910 "version": "0.0.0",
33911 "filename": "server/api/intVtigerConfiguration/index.js",
33912 "groupTitle": "Vtiger_Configurations"
33916 "url": "/api/integrations/vtiger/configurations/{id}",
33917 "title": "Update an existing Vtiger Configuration",
33920 "title": "Example usage:",
33921 "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",
33925 "name": "updateVtiger_Configurations",
33926 "group": "Vtiger_Configurations",
33927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33928 "version": "0.0.0",
33929 "filename": "server/api/intVtigerConfiguration/index.js",
33930 "groupTitle": "Vtiger_Configurations"
33934 "url": "/api/integrations/vtiger/fields",
33935 "title": "Creates a new Vtiger Field",
33938 "title": "Example usage:",
33939 "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",
33943 "name": "CreateVtiger_Fields",
33944 "group": "Vtiger_Fields",
33954 "\"customVariable\"",
33966 "field": "content",
33982 "\"customVariable\""
33985 "field": "keyType",
33992 "field": "keyContent",
33999 "field": "idField",
34006 "field": "nameField",
34013 "field": "customField",
34020 "field": "variableName",
34026 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34027 "version": "0.0.0",
34028 "filename": "server/api/intVtigerField/index.js",
34029 "groupTitle": "Vtiger_Fields"
34033 "url": "/api/integrations/vtiger/fields/{id}",
34034 "title": "Deletes a Vtiger Field",
34037 "title": "Example usage:",
34038 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34042 "name": "DeleteVtiger_Fields",
34043 "group": "Vtiger_Fields",
34044 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34045 "version": "0.0.0",
34046 "filename": "server/api/intVtigerField/index.js",
34047 "groupTitle": "Vtiger_Fields"
34051 "url": "/api/integrations/vtiger/fields",
34052 "title": "Gets a list of Vtiger Fields",
34055 "title": "Example usage:",
34056 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34060 "name": "GetVtiger_Fields",
34061 "group": "Vtiger_Fields",
34062 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34063 "version": "0.0.0",
34064 "filename": "server/api/intVtigerField/index.js",
34065 "groupTitle": "Vtiger_Fields"
34069 "url": "/api/integrations/vtiger/fields/{id}",
34070 "title": "Gets a single Vtiger Field",
34073 "title": "Example usage:",
34074 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34078 "name": "ShowVtiger_Fields",
34079 "group": "Vtiger_Fields",
34080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34081 "version": "0.0.0",
34082 "filename": "server/api/intVtigerField/index.js",
34083 "groupTitle": "Vtiger_Fields"
34087 "url": "/api/integrations/vtiger/fields/{id}",
34088 "title": "Update an existing Vtiger Field",
34091 "title": "Example usage:",
34092 "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",
34096 "name": "updateVtiger_Fields",
34097 "group": "Vtiger_Fields",
34098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34099 "version": "0.0.0",
34100 "filename": "server/api/intVtigerField/index.js",
34101 "groupTitle": "Vtiger_Fields"
34105 "url": "/api/webbar/answer",
34106 "title": "answer webrtc call",
34109 "title": "Example usage:",
34110 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34114 "name": "Web_Bar_answer",
34123 "field": "sessionId",
34136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34137 "version": "0.0.0",
34138 "filename": "server/api/webbar/index.js",
34139 "groupTitle": "WebBar"
34143 "url": "/api/webbar/calls",
34144 "title": "webrtc call list",
34147 "title": "Example usage:",
34148 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34152 "name": "Web_Bar_calls",
34167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34168 "version": "0.0.0",
34169 "filename": "server/api/webbar/index.js",
34170 "groupTitle": "WebBar"
34174 "url": "/api/webbar/hangup",
34175 "title": "hangup webrtc call",
34178 "title": "Example usage:",
34179 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34183 "name": "Web_Bar_hangup",
34192 "field": "sessionId",
34205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34206 "version": "0.0.0",
34207 "filename": "server/api/webbar/index.js",
34208 "groupTitle": "WebBar"
34212 "url": "/api/webbar/unhold",
34213 "title": "unhold webrtc call",
34216 "title": "Example usage:",
34217 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34221 "name": "Web_Bar_hold",
34230 "field": "sessionId",
34243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34244 "version": "0.0.0",
34245 "filename": "server/api/webbar/index.js",
34246 "groupTitle": "WebBar"
34250 "url": "/api/webbar/hold",
34251 "title": "hold webrtc call",
34254 "title": "Example usage:",
34255 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34259 "name": "Web_Bar_hold",
34268 "field": "sessionId",
34281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34282 "version": "0.0.0",
34283 "filename": "server/api/webbar/index.js",
34284 "groupTitle": "WebBar"
34288 "url": "/api/webbar/originate",
34289 "title": "Originate new webrtc call",
34292 "title": "Example usage:",
34293 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34297 "name": "Web_Bar_originate",
34306 "field": "callNumber",
34320 "field": "callerId",
34327 "field": "callbackUrl",
34333 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34334 "version": "0.0.0",
34335 "filename": "server/api/webbar/index.js",
34336 "groupTitle": "WebBar"
34340 "url": "/api/webbar/transfer",
34341 "title": "blind transfer webrtc call",
34344 "title": "Example usage:",
34345 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34349 "name": "Web_Bar_transfer",
34365 "field": "sessionId",
34372 "field": "transferNumber",
34378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34379 "version": "0.0.0",
34380 "filename": "server/api/webbar/index.js",
34381 "groupTitle": "WebBar"
34385 "url": "/api/whatsapp/accounts/{id}/users",
34386 "title": "Add agents to a whatsapp account",
34389 "title": "Example usage:",
34390 "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",
34394 "name": "AddAgents",
34395 "group": "Whatsapp_Accounts",
34396 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34397 "version": "0.0.0",
34398 "filename": "server/api/whatsappAccount/index.js",
34399 "groupTitle": "Whatsapp_Accounts"
34403 "url": "/api/whatsapp/accounts",
34404 "title": "Creates a new Account",
34407 "title": "Example usage:",
34408 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34412 "name": "CreateAccounts",
34413 "group": "Whatsapp_Accounts",
34466 "field": "accountSid",
34473 "field": "authToken",
34480 "field": "notificationTemplate",
34487 "field": "notificationSound",
34494 "field": "notificationShake",
34501 "field": "waitForTheAssignedAgent",
34508 "field": "queueTransfer",
34515 "field": "queueTransferTimeout",
34522 "field": "agentTransfer",
34529 "field": "agentTransferTimeout",
34536 "field": "mandatoryDispositionPauseId",
34537 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34543 "field": "mandatoryDisposition",
34544 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34550 "field": "description",
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/{id}",
34564 "title": "Deletes a Account",
34567 "title": "Example usage:",
34568 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34572 "name": "DeleteAccounts",
34573 "group": "Whatsapp_Accounts",
34574 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34575 "version": "0.0.0",
34576 "filename": "server/api/whatsappAccount/index.js",
34577 "groupTitle": "Whatsapp_Accounts"
34581 "url": "/api/whatsapp/accounts/describe",
34582 "title": "Gets table info about Accounts",
34585 "title": "Example usage:",
34586 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34590 "name": "DescribeAccounts",
34591 "group": "Whatsapp_Accounts",
34592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34593 "version": "0.0.0",
34594 "filename": "server/api/whatsappAccount/index.js",
34595 "groupTitle": "Whatsapp_Accounts"
34599 "url": "/api/whatsapp/accounts",
34600 "title": "Gets a list of Accounts",
34603 "title": "Example usage:",
34604 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34608 "name": "GetAccounts",
34609 "group": "Whatsapp_Accounts",
34610 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34611 "version": "0.0.0",
34612 "filename": "server/api/whatsappAccount/index.js",
34613 "groupTitle": "Whatsapp_Accounts"
34617 "url": "/api/whatsapp/accounts/{id}/users",
34618 "title": "Gets agents from whatsapp account",
34621 "title": "Example usage:",
34622 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34626 "name": "GetAgents",
34627 "group": "Whatsapp_Accounts",
34628 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34629 "version": "0.0.0",
34630 "filename": "server/api/whatsappAccount/index.js",
34631 "groupTitle": "Whatsapp_Accounts"
34635 "url": "/api/whatsapp/accounts/{id}/users",
34636 "title": "Removes agents from a whatsapp account",
34639 "title": "Example usage:",
34640 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34644 "name": "RemoveAgents",
34645 "group": "Whatsapp_Accounts",
34646 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34647 "version": "0.0.0",
34648 "filename": "server/api/whatsappAccount/index.js",
34649 "groupTitle": "Whatsapp_Accounts"
34653 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34654 "title": "Removes canned answers from account",
34657 "title": "Example usage:",
34658 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34662 "name": "RemoveAnswers",
34663 "group": "Whatsapp_Accounts",
34664 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34665 "version": "0.0.0",
34666 "filename": "server/api/whatsappAccount/index.js",
34667 "groupTitle": "Whatsapp_Accounts"
34671 "url": "/api/whatsapp/accounts/{id}/dispositions",
34672 "title": "Removes dispositions from account",
34675 "title": "Example usage:",
34676 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34680 "name": "RemoveDispositions",
34681 "group": "Whatsapp_Accounts",
34682 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34683 "version": "0.0.0",
34684 "filename": "server/api/whatsappAccount/index.js",
34685 "groupTitle": "Whatsapp_Accounts"
34689 "url": "/api/whatsapp/accounts/{id}",
34690 "title": "Gets a single Account",
34693 "title": "Example usage:",
34694 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34698 "name": "ShowAccounts",
34699 "group": "Whatsapp_Accounts",
34700 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34701 "version": "0.0.0",
34702 "filename": "server/api/whatsappAccount/index.js",
34703 "groupTitle": "Whatsapp_Accounts"
34707 "url": "/api/whatsapp/messages/{id}/accept",
34708 "title": "Accepts message",
34711 "title": "Example usage:",
34712 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34716 "name": "acceptMessage",
34717 "group": "Whatsapp_Accounts",
34718 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34719 "version": "0.0.0",
34720 "filename": "server/api/whatsappMessage/index.js",
34721 "groupTitle": "Whatsapp_Accounts"
34725 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34726 "title": "Creates new canned answer",
34729 "title": "Example usage:",
34730 "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",
34734 "name": "addAnswer",
34735 "group": "Whatsapp_Accounts",
34757 "field": "description",
34770 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34771 "version": "0.0.0",
34772 "filename": "server/api/whatsappAccount/index.js",
34773 "groupTitle": "Whatsapp_Accounts"
34777 "url": "/api/whatsapp/accounts/{id}/applications",
34778 "title": "Creates new applications",
34781 "title": "Example usage:",
34782 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34786 "name": "addApplications",
34787 "group": "Whatsapp_Accounts",
34795 "field": "priority",
34809 "field": "appdata",
34816 "field": "description",
34823 "field": "interval",
34829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34830 "version": "0.0.0",
34831 "filename": "server/api/whatsappAccount/index.js",
34832 "groupTitle": "Whatsapp_Accounts"
34836 "url": "/api/whatsapp/accounts/{id}/dispositions",
34837 "title": "Creates new disposition",
34840 "title": "Example usage:",
34841 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34845 "name": "addDisposition",
34846 "group": "Whatsapp_Accounts",
34873 "field": "description",
34879 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34880 "version": "0.0.0",
34881 "filename": "server/api/whatsappAccount/index.js",
34882 "groupTitle": "Whatsapp_Accounts"
34886 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34887 "title": "Gets account canned answers",
34890 "title": "Example usage:",
34891 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34895 "name": "getAnswers",
34896 "group": "Whatsapp_Accounts",
34897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34898 "version": "0.0.0",
34899 "filename": "server/api/whatsappAccount/index.js",
34900 "groupTitle": "Whatsapp_Accounts"
34904 "url": "/api/whatsapp/accounts/{id}/applications",
34905 "title": "Gets account applications",
34908 "title": "Example usage:",
34909 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34913 "name": "getApplications",
34914 "group": "Whatsapp_Accounts",
34915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34916 "version": "0.0.0",
34917 "filename": "server/api/whatsappAccount/index.js",
34918 "groupTitle": "Whatsapp_Accounts"
34922 "url": "/api/whatsapp/accounts/{id}/dispositions",
34923 "title": "Gets account dispositions",
34926 "title": "Example usage:",
34927 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34931 "name": "getDispositions",
34932 "group": "Whatsapp_Accounts",
34933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34934 "version": "0.0.0",
34935 "filename": "server/api/whatsappAccount/index.js",
34936 "groupTitle": "Whatsapp_Accounts"
34940 "url": "/api/whatsapp/accounts/{id}/notify",
34941 "title": "Notify new message",
34944 "title": "Example usage:",
34945 "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",
34950 "group": "Whatsapp_Accounts",
34951 "description": "<p>Motion 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>",
34952 "version": "0.0.0",
34953 "filename": "server/api/whatsappAccount/index.js",
34954 "groupTitle": "Whatsapp_Accounts"
34958 "url": "/api/whatsapp/messages/{id}/reject",
34959 "title": "Rejects message",
34962 "title": "Example usage:",
34963 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34967 "name": "rejectMessage",
34968 "group": "Whatsapp_Accounts",
34969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34970 "version": "0.0.0",
34971 "filename": "server/api/whatsappMessage/index.js",
34972 "groupTitle": "Whatsapp_Accounts"
34976 "url": "/api/whatsapp/accounts/{id}/send",
34977 "title": "Send new whatsapp message",
34980 "title": "Example usage:",
34981 "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",
34985 "name": "sendWhatsapp",
34986 "group": "Whatsapp_Accounts",
34987 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34988 "version": "0.0.0",
34989 "filename": "server/api/whatsappAccount/index.js",
34990 "groupTitle": "Whatsapp_Accounts"
34994 "url": "/api/whatsapp/messages/{id}/status",
34995 "title": "Receive message status",
34998 "title": "Example usage:",
34999 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35003 "name": "statusMessage",
35004 "group": "Whatsapp_Accounts",
35005 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35006 "version": "0.0.0",
35007 "filename": "server/api/whatsappMessage/index.js",
35008 "groupTitle": "Whatsapp_Accounts"
35012 "url": "/api/whatsapp/accounts/{id}",
35013 "title": "Update an existing Account",
35016 "title": "Example usage:",
35017 "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",
35021 "name": "updateAccounts",
35022 "group": "Whatsapp_Accounts",
35023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35024 "version": "0.0.0",
35025 "filename": "server/api/whatsappAccount/index.js",
35026 "groupTitle": "Whatsapp_Accounts"
35030 "url": "/api/whatsapp/applications",
35031 "title": "Creates a new Application",
35034 "title": "Example usage:",
35035 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35039 "name": "CreateApplications",
35040 "group": "Whatsapp_Applications",
35048 "field": "priority",
35062 "field": "appdata",
35069 "field": "description",
35076 "field": "interval",
35082 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35083 "version": "0.0.0",
35084 "filename": "server/api/whatsappApplication/index.js",
35085 "groupTitle": "Whatsapp_Applications"
35089 "url": "/api/whatsapp/applications/{id}",
35090 "title": "Deletes a Application",
35093 "title": "Example usage:",
35094 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35098 "name": "DeleteApplications",
35099 "group": "Whatsapp_Applications",
35100 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35101 "version": "0.0.0",
35102 "filename": "server/api/whatsappApplication/index.js",
35103 "groupTitle": "Whatsapp_Applications"
35107 "url": "/api/whatsapp/applications",
35108 "title": "Gets a list of Applications",
35111 "title": "Example usage:",
35112 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35116 "name": "GetApplications",
35117 "group": "Whatsapp_Applications",
35118 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35119 "version": "0.0.0",
35120 "filename": "server/api/whatsappApplication/index.js",
35121 "groupTitle": "Whatsapp_Applications"
35125 "url": "/api/whatsapp/applications/{id}",
35126 "title": "Gets a single Application",
35129 "title": "Example usage:",
35130 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35134 "name": "ShowApplications",
35135 "group": "Whatsapp_Applications",
35136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35137 "version": "0.0.0",
35138 "filename": "server/api/whatsappApplication/index.js",
35139 "groupTitle": "Whatsapp_Applications"
35143 "url": "/api/whatsapp/applications/{id}",
35144 "title": "Update an existing Application",
35147 "title": "Example usage:",
35148 "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",
35152 "name": "updateApplications",
35153 "group": "Whatsapp_Applications",
35154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35155 "version": "0.0.0",
35156 "filename": "server/api/whatsappApplication/index.js",
35157 "groupTitle": "Whatsapp_Applications"
35161 "url": "/api/whatsapp/interactions/{id}/tags",
35162 "title": "Add tags to the interaction",
35165 "title": "Example usage:",
35166 "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",
35171 "group": "Whatsapp_Interactions",
35172 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35173 "version": "0.0.0",
35174 "filename": "server/api/whatsappInteraction/index.js",
35175 "groupTitle": "Whatsapp_Interactions"
35179 "url": "/api/whatsapp/interactions",
35180 "title": "Creates a new Interaction",
35183 "title": "Example usage:",
35184 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35188 "name": "CreateInteractions",
35189 "group": "Whatsapp_Interactions",
35204 "field": "closedAt",
35211 "field": "disposition",
35218 "field": "secondDisposition",
35225 "field": "thirdDisposition",
35246 "field": "read1stAt",
35257 "field": "firstMsgDirection",
35264 "field": "lastMsgAt",
35275 "field": "lastMsgDirection",
35281 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35282 "version": "0.0.0",
35283 "filename": "server/api/whatsappInteraction/index.js",
35284 "groupTitle": "Whatsapp_Interactions"
35288 "url": "/api/whatsapp/interactions/{id}",
35289 "title": "Deletes a Interaction",
35292 "title": "Example usage:",
35293 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35297 "name": "DeleteInteractions",
35298 "group": "Whatsapp_Interactions",
35299 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35300 "version": "0.0.0",
35301 "filename": "server/api/whatsappInteraction/index.js",
35302 "groupTitle": "Whatsapp_Interactions"
35306 "url": "/api/whatsapp/interactions/describe",
35307 "title": "Gets table info about Interactions",
35310 "title": "Example usage:",
35311 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35315 "name": "DescribeInteractions",
35316 "group": "Whatsapp_Interactions",
35317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35318 "version": "0.0.0",
35319 "filename": "server/api/whatsappInteraction/index.js",
35320 "groupTitle": "Whatsapp_Interactions"
35324 "url": "/api/whatsapp/interactions",
35325 "title": "Gets a list of Interactions",
35328 "title": "Example usage:",
35329 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35333 "name": "GetInteractions",
35334 "group": "Whatsapp_Interactions",
35335 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35336 "version": "0.0.0",
35337 "filename": "server/api/whatsappInteraction/index.js",
35338 "groupTitle": "Whatsapp_Interactions"
35342 "url": "/api/whatsapp/interactions/{id}/tags",
35343 "title": "Removes tags from interaction",
35346 "title": "Example usage:",
35347 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35351 "name": "RemoveTags",
35352 "group": "Whatsapp_Interactions",
35353 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35354 "version": "0.0.0",
35355 "filename": "server/api/whatsappInteraction/index.js",
35356 "groupTitle": "Whatsapp_Interactions"
35360 "url": "/api/whatsapp/interactions/{id}",
35361 "title": "Gets a single Interaction",
35364 "title": "Example usage:",
35365 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35369 "name": "ShowInteractions",
35370 "group": "Whatsapp_Interactions",
35371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35372 "version": "0.0.0",
35373 "filename": "server/api/whatsappInteraction/index.js",
35374 "groupTitle": "Whatsapp_Interactions"
35378 "url": "/api/whatsapp/interactions/{id}/messages",
35379 "title": "Creates new messages",
35382 "title": "Example usage:",
35383 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35387 "name": "addMessage",
35388 "group": "Whatsapp_Interactions",
35414 "field": "direction",
35421 "field": "messageId",
35449 "field": "providerName",
35456 "field": "providerResponse",
35462 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35463 "version": "0.0.0",
35464 "filename": "server/api/whatsappInteraction/index.js",
35465 "groupTitle": "Whatsapp_Interactions"
35469 "url": "/api/whatsapp/interactions/{id}/download",
35470 "title": "Gets interaction",
35473 "title": "Example usage:",
35474 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35478 "name": "download",
35479 "group": "Whatsapp_Interactions",
35480 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35481 "version": "0.0.0",
35482 "filename": "server/api/whatsappInteraction/index.js",
35483 "groupTitle": "Whatsapp_Interactions"
35487 "url": "/api/whatsapp/interactions/{id}/messages",
35488 "title": "Gets interaction messages",
35491 "title": "Example usage:",
35492 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35496 "name": "getMessages",
35497 "group": "Whatsapp_Interactions",
35498 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35499 "version": "0.0.0",
35500 "filename": "server/api/whatsappInteraction/index.js",
35501 "groupTitle": "Whatsapp_Interactions"
35505 "url": "/api/whatsapp/interactions/{id}",
35506 "title": "Update an existing Interaction",
35509 "title": "Example usage:",
35510 "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",
35514 "name": "updateInteractions",
35515 "group": "Whatsapp_Interactions",
35516 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35517 "version": "0.0.0",
35518 "filename": "server/api/whatsappInteraction/index.js",
35519 "groupTitle": "Whatsapp_Interactions"
35523 "url": "/api/whatsapp/messages",
35524 "title": "Creates a new Message",
35527 "title": "Example usage:",
35528 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35532 "name": "CreateMessages",
35533 "group": "Whatsapp_Messages",
35559 "field": "direction",
35566 "field": "messageId",
35594 "field": "providerName",
35601 "field": "providerResponse",
35607 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35608 "version": "0.0.0",
35609 "filename": "server/api/whatsappMessage/index.js",
35610 "groupTitle": "Whatsapp_Messages"
35614 "url": "/api/whatsapp/messages/{id}",
35615 "title": "Deletes a Message",
35618 "title": "Example usage:",
35619 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35623 "name": "DeleteMessages",
35624 "group": "Whatsapp_Messages",
35625 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35626 "version": "0.0.0",
35627 "filename": "server/api/whatsappMessage/index.js",
35628 "groupTitle": "Whatsapp_Messages"
35632 "url": "/api/whatsapp/messages/describe",
35633 "title": "Gets table info about Messages",
35636 "title": "Example usage:",
35637 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35641 "name": "DescribeMessages",
35642 "group": "Whatsapp_Messages",
35643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35644 "version": "0.0.0",
35645 "filename": "server/api/whatsappMessage/index.js",
35646 "groupTitle": "Whatsapp_Messages"
35650 "url": "/api/whatsapp/messages",
35651 "title": "Gets a list of Messages",
35654 "title": "Example usage:",
35655 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35659 "name": "GetMessages",
35660 "group": "Whatsapp_Messages",
35661 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35662 "version": "0.0.0",
35663 "filename": "server/api/whatsappMessage/index.js",
35664 "groupTitle": "Whatsapp_Messages"
35668 "url": "/api/whatsapp/messages/{id}",
35669 "title": "Gets a single Message",
35672 "title": "Example usage:",
35673 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35677 "name": "ShowMessages",
35678 "group": "Whatsapp_Messages",
35679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35680 "version": "0.0.0",
35681 "filename": "server/api/whatsappMessage/index.js",
35682 "groupTitle": "Whatsapp_Messages"
35686 "url": "/api/whatsapp/messages/{id}",
35687 "title": "Update an existing Message",
35690 "title": "Example usage:",
35691 "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",
35695 "name": "updateMessages",
35696 "group": "Whatsapp_Messages",
35697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35698 "version": "0.0.0",
35699 "filename": "server/api/whatsappMessage/index.js",
35700 "groupTitle": "Whatsapp_Messages"
35704 "url": "/api/whatsapp/reports/queue",
35705 "title": "Creates a new Whatsapp Queue Report",
35708 "title": "Example usage:",
35709 "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",
35713 "name": "CreateWhatsapp_Queue_Reports",
35714 "group": "Whatsapp_Queue_Reports",
35722 "field": "uniqueid",
35743 "field": "leaveAt",
35750 "field": "acceptAt",
35770 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35771 "version": "0.0.0",
35772 "filename": "server/api/whatsappQueueReport/index.js",
35773 "groupTitle": "Whatsapp_Queue_Reports"
35777 "url": "/api/whatsapp/reports/queue/{id}",
35778 "title": "Deletes a Whatsapp Queue Report",
35781 "title": "Example usage:",
35782 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35786 "name": "DeleteWhatsapp_Queue_Reports",
35787 "group": "Whatsapp_Queue_Reports",
35788 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35789 "version": "0.0.0",
35790 "filename": "server/api/whatsappQueueReport/index.js",
35791 "groupTitle": "Whatsapp_Queue_Reports"
35795 "url": "/api/whatsapp/reports/queue/describe",
35796 "title": "Gets table info about Whatsapp Queue Reports",
35799 "title": "Example usage:",
35800 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35804 "name": "DescribeWhatsapp_Queue_Reports",
35805 "group": "Whatsapp_Queue_Reports",
35806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35807 "version": "0.0.0",
35808 "filename": "server/api/whatsappQueueReport/index.js",
35809 "groupTitle": "Whatsapp_Queue_Reports"
35813 "url": "/api/whatsapp/reports/queue",
35814 "title": "Gets a list of Whatsapp Queue Reports",
35817 "title": "Example usage:",
35818 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35822 "name": "GetWhatsapp_Queue_Reports",
35823 "group": "Whatsapp_Queue_Reports",
35824 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35825 "version": "0.0.0",
35826 "filename": "server/api/whatsappQueueReport/index.js",
35827 "groupTitle": "Whatsapp_Queue_Reports"
35831 "url": "/api/whatsapp/reports/queue/{id}",
35832 "title": "Gets a single Whatsapp Queue Report",
35835 "title": "Example usage:",
35836 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35840 "name": "ShowWhatsapp_Queue_Reports",
35841 "group": "Whatsapp_Queue_Reports",
35842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35843 "version": "0.0.0",
35844 "filename": "server/api/whatsappQueueReport/index.js",
35845 "groupTitle": "Whatsapp_Queue_Reports"
35849 "url": "/api/whatsapp/reports/queue/{id}",
35850 "title": "Update an existing Whatsapp Queue Report",
35853 "title": "Example usage:",
35854 "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",
35858 "name": "updateWhatsapp_Queue_Reports",
35859 "group": "Whatsapp_Queue_Reports",
35860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35861 "version": "0.0.0",
35862 "filename": "server/api/whatsappQueueReport/index.js",
35863 "groupTitle": "Whatsapp_Queue_Reports"
35867 "url": "/api/whatsapp/queues/{id}/users",
35868 "title": "Add agents to a queue",
35871 "title": "Example usage:",
35872 "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",
35876 "name": "AddAgents",
35877 "group": "Whatsapp_Queues",
35878 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35879 "version": "0.0.0",
35880 "filename": "server/api/whatsappQueue/index.js",
35881 "groupTitle": "Whatsapp_Queues"
35885 "url": "/api/whatsapp/queues/{id}/teams",
35886 "title": "Add teams to a queue",
35889 "title": "Example usage:",
35890 "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",
35894 "name": "AddTeams",
35895 "group": "Whatsapp_Queues",
35896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35897 "version": "0.0.0",
35898 "filename": "server/api/whatsappQueue/index.js",
35899 "groupTitle": "Whatsapp_Queues"
35903 "url": "/api/whatsapp/queues",
35904 "title": "Creates a new Queue",
35907 "title": "Example usage:",
35908 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35912 "name": "CreateQueues",
35913 "group": "Whatsapp_Queues",
35928 "field": "timeout",
35940 "field": "strategy",
35947 "field": "description",
35953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35954 "version": "0.0.0",
35955 "filename": "server/api/whatsappQueue/index.js",
35956 "groupTitle": "Whatsapp_Queues"
35960 "url": "/api/whatsapp/queues/{id}",
35961 "title": "Deletes a Queue",
35964 "title": "Example usage:",
35965 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35969 "name": "DeleteQueues",
35970 "group": "Whatsapp_Queues",
35971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35972 "version": "0.0.0",
35973 "filename": "server/api/whatsappQueue/index.js",
35974 "groupTitle": "Whatsapp_Queues"
35978 "url": "/api/whatsapp/queues/describe",
35979 "title": "Gets table info about Queues",
35982 "title": "Example usage:",
35983 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35987 "name": "DescribeQueues",
35988 "group": "Whatsapp_Queues",
35989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35990 "version": "0.0.0",
35991 "filename": "server/api/whatsappQueue/index.js",
35992 "groupTitle": "Whatsapp_Queues"
35996 "url": "/api/whatsapp/queues/{id}/users",
35997 "title": "Gets queue agents",
36000 "title": "Example usage:",
36001 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36005 "name": "GetAgents",
36006 "group": "Whatsapp_Queues",
36007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36008 "version": "0.0.0",
36009 "filename": "server/api/whatsappQueue/index.js",
36010 "groupTitle": "Whatsapp_Queues"
36014 "url": "/api/whatsapp/queues/{id}/members",
36015 "title": "GetMembers",
36018 "title": "Example usage:",
36019 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36023 "name": "GetMembers",
36024 "group": "Whatsapp_Queues",
36025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36026 "version": "0.0.0",
36027 "filename": "server/api/whatsappQueue/index.js",
36028 "groupTitle": "Whatsapp_Queues"
36032 "url": "/api/whatsapp/queues",
36033 "title": "Gets a list of Queues",
36036 "title": "Example usage:",
36037 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36041 "name": "GetQueues",
36042 "group": "Whatsapp_Queues",
36043 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36044 "version": "0.0.0",
36045 "filename": "server/api/whatsappQueue/index.js",
36046 "groupTitle": "Whatsapp_Queues"
36050 "url": "/api/whatsapp/queues/{id}/teams",
36051 "title": "Gets queues list",
36054 "title": "Example usage:",
36055 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36059 "name": "GetTeams",
36060 "group": "Whatsapp_Queues",
36061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36062 "version": "0.0.0",
36063 "filename": "server/api/whatsappQueue/index.js",
36064 "groupTitle": "Whatsapp_Queues"
36068 "url": "/api/whatsapp/queues/{id}/users",
36069 "title": "Removes agents from a queue",
36072 "title": "Example usage:",
36073 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36077 "name": "RemoveAgents",
36078 "group": "Whatsapp_Queues",
36079 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36080 "version": "0.0.0",
36081 "filename": "server/api/whatsappQueue/index.js",
36082 "groupTitle": "Whatsapp_Queues"
36086 "url": "/api/whatsapp/queues/{id}",
36087 "title": "Gets a single Queue",
36090 "title": "Example usage:",
36091 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36095 "name": "ShowQueues",
36096 "group": "Whatsapp_Queues",
36097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36098 "version": "0.0.0",
36099 "filename": "server/api/whatsappQueue/index.js",
36100 "groupTitle": "Whatsapp_Queues"
36104 "url": "/api/whatsapp/queues/{id}",
36105 "title": "Update an existing Queue",
36108 "title": "Example usage:",
36109 "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",
36113 "name": "updateQueues",
36114 "group": "Whatsapp_Queues",
36115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36116 "version": "0.0.0",
36117 "filename": "server/api/whatsappQueue/index.js",
36118 "groupTitle": "Whatsapp_Queues"
36122 "url": "/api/whatsapp/reports/transfer",
36123 "title": "Creates a new Whatsapp Transfer Report",
36126 "title": "Example usage:",
36127 "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",
36131 "name": "CreateWhatsapp_Transfer_Reports",
36132 "group": "Whatsapp_Transfer_Reports",
36140 "field": "uniqueid",
36159 "field": "transferredAt",
36165 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36166 "version": "0.0.0",
36167 "filename": "server/api/whatsappTransferReport/index.js",
36168 "groupTitle": "Whatsapp_Transfer_Reports"
36172 "url": "/api/whatsapp/reports/transfer/{id}",
36173 "title": "Deletes a Whatsapp Transfer Report",
36176 "title": "Example usage:",
36177 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36181 "name": "DeleteWhatsapp_Transfer_Reports",
36182 "group": "Whatsapp_Transfer_Reports",
36183 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36184 "version": "0.0.0",
36185 "filename": "server/api/whatsappTransferReport/index.js",
36186 "groupTitle": "Whatsapp_Transfer_Reports"
36190 "url": "/api/whatsapp/reports/transfer/describe",
36191 "title": "Gets table info about Whatsapp Transfer Reports",
36194 "title": "Example usage:",
36195 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36199 "name": "DescribeWhatsapp_Transfer_Reports",
36200 "group": "Whatsapp_Transfer_Reports",
36201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36202 "version": "0.0.0",
36203 "filename": "server/api/whatsappTransferReport/index.js",
36204 "groupTitle": "Whatsapp_Transfer_Reports"
36208 "url": "/api/whatsapp/reports/transfer",
36209 "title": "Gets a list of Whatsapp Transfer Reports",
36212 "title": "Example usage:",
36213 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36217 "name": "GetWhatsapp_Transfer_Reports",
36218 "group": "Whatsapp_Transfer_Reports",
36219 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36220 "version": "0.0.0",
36221 "filename": "server/api/whatsappTransferReport/index.js",
36222 "groupTitle": "Whatsapp_Transfer_Reports"
36226 "url": "/api/whatsapp/reports/transfer/{id}",
36227 "title": "Gets a single Whatsapp Transfer Report",
36230 "title": "Example usage:",
36231 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36235 "name": "ShowWhatsapp_Transfer_Reports",
36236 "group": "Whatsapp_Transfer_Reports",
36237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36238 "version": "0.0.0",
36239 "filename": "server/api/whatsappTransferReport/index.js",
36240 "groupTitle": "Whatsapp_Transfer_Reports"
36244 "url": "/api/whatsapp/reports/transfer/{id}",
36245 "title": "Update an existing Whatsapp Transfer Report",
36248 "title": "Example usage:",
36249 "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",
36253 "name": "updateWhatsapp_Transfer_Reports",
36254 "group": "Whatsapp_Transfer_Reports",
36255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36256 "version": "0.0.0",
36257 "filename": "server/api/whatsappTransferReport/index.js",
36258 "groupTitle": "Whatsapp_Transfer_Reports"
36262 "url": "/api/integrations/zendesk/accounts",
36263 "title": "Creates a new Zendesk Account",
36266 "title": "Example usage:",
36267 "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",
36271 "name": "CreateZendesk_Accounts",
36272 "group": "Zendesk_Accounts",
36287 "field": "description",
36294 "field": "username",
36301 "field": "password",
36315 "field": "remoteUri",
36326 "field": "authType",
36333 "field": "serverUrl",
36340 "\"integrationTab\"",
36350 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36351 "version": "0.0.0",
36352 "filename": "server/api/intZendeskAccount/index.js",
36353 "groupTitle": "Zendesk_Accounts"
36357 "url": "/api/integrations/zendesk/accounts/{id}",
36358 "title": "Deletes a Zendesk Account",
36361 "title": "Example usage:",
36362 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36366 "name": "DeleteZendesk_Accounts",
36367 "group": "Zendesk_Accounts",
36368 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36369 "version": "0.0.0",
36370 "filename": "server/api/intZendeskAccount/index.js",
36371 "groupTitle": "Zendesk_Accounts"
36375 "url": "/api/integrations/zendesk/accounts",
36376 "title": "Gets a list of Zendesk Accounts",
36379 "title": "Example usage:",
36380 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36384 "name": "GetZendesk_Accounts",
36385 "group": "Zendesk_Accounts",
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/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>",
36387 "version": "0.0.0",
36388 "filename": "server/api/intZendeskAccount/index.js",
36389 "groupTitle": "Zendesk_Accounts"
36393 "url": "/api/integrations/zendesk/accounts/{id}",
36394 "title": "Gets a single Zendesk Account",
36397 "title": "Example usage:",
36398 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36402 "name": "ShowZendesk_Accounts",
36403 "group": "Zendesk_Accounts",
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/intZendeskAccount/index.js",
36407 "groupTitle": "Zendesk_Accounts"
36411 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36412 "title": "Creates new configuration",
36415 "title": "Example usage:",
36416 "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",
36420 "name": "addConfiguration",
36421 "group": "Zendesk_Accounts",
36422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36423 "version": "0.0.0",
36424 "filename": "server/api/intZendeskAccount/index.js",
36425 "groupTitle": "Zendesk_Accounts"
36429 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36430 "title": "Gets account configurations",
36433 "title": "Example usage:",
36434 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36438 "name": "getConfigurations",
36439 "group": "Zendesk_Accounts",
36440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36441 "version": "0.0.0",
36442 "filename": "server/api/intZendeskAccount/index.js",
36443 "groupTitle": "Zendesk_Accounts"
36447 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36448 "title": "Gets account fields",
36451 "title": "Example usage:",
36452 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36456 "name": "getFields",
36457 "group": "Zendesk_Accounts",
36458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36459 "version": "0.0.0",
36460 "filename": "server/api/intZendeskAccount/index.js",
36461 "groupTitle": "Zendesk_Accounts"
36465 "url": "/api/integrations/zendesk/accounts/{id}",
36466 "title": "Update an existing Zendesk Account",
36469 "title": "Example usage:",
36470 "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",
36474 "name": "updateZendesk_Accounts",
36475 "group": "Zendesk_Accounts",
36476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36477 "version": "0.0.0",
36478 "filename": "server/api/intZendeskAccount/index.js",
36479 "groupTitle": "Zendesk_Accounts"
36483 "url": "/api/integrations/zendesk/configurations",
36484 "title": "Creates a new Zendesk Configuration",
36487 "title": "Example usage:",
36488 "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",
36492 "name": "CreateZendesk_Configurations",
36493 "group": "Zendesk_Configurations",
36508 "field": "description",
36514 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36515 "version": "0.0.0",
36516 "filename": "server/api/intZendeskConfiguration/index.js",
36517 "groupTitle": "Zendesk_Configurations"
36521 "url": "/api/integrations/zendesk/configurations/{id}",
36522 "title": "Deletes a Zendesk Configuration",
36525 "title": "Example usage:",
36526 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36530 "name": "DeleteZendesk_Configurations",
36531 "group": "Zendesk_Configurations",
36532 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36533 "version": "0.0.0",
36534 "filename": "server/api/intZendeskConfiguration/index.js",
36535 "groupTitle": "Zendesk_Configurations"
36539 "url": "/api/integrations/zendesk/configurations",
36540 "title": "Gets a list of Zendesk Configurations",
36543 "title": "Example usage:",
36544 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36548 "name": "GetZendesk_Configurations",
36549 "group": "Zendesk_Configurations",
36550 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36551 "version": "0.0.0",
36552 "filename": "server/api/intZendeskConfiguration/index.js",
36553 "groupTitle": "Zendesk_Configurations"
36557 "url": "/api/integrations/zendesk/configurations/{id}",
36558 "title": "Gets a single Zendesk Configuration",
36561 "title": "Example usage:",
36562 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36566 "name": "ShowZendesk_Configurations",
36567 "group": "Zendesk_Configurations",
36568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36569 "version": "0.0.0",
36570 "filename": "server/api/intZendeskConfiguration/index.js",
36571 "groupTitle": "Zendesk_Configurations"
36575 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36576 "title": "Gets configurations descriptions",
36579 "title": "Example usage:",
36580 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36584 "name": "getDescriptions",
36585 "group": "Zendesk_Configurations",
36586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36587 "version": "0.0.0",
36588 "filename": "server/api/intZendeskConfiguration/index.js",
36589 "groupTitle": "Zendesk_Configurations"
36593 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36594 "title": "Gets configurations fields",
36597 "title": "Example usage:",
36598 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36602 "name": "getFields",
36603 "group": "Zendesk_Configurations",
36604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36605 "version": "0.0.0",
36606 "filename": "server/api/intZendeskConfiguration/index.js",
36607 "groupTitle": "Zendesk_Configurations"
36611 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36612 "title": "Gets configurations subjects",
36615 "title": "Example usage:",
36616 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36620 "name": "getSubjects",
36621 "group": "Zendesk_Configurations",
36622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36623 "version": "0.0.0",
36624 "filename": "server/api/intZendeskConfiguration/index.js",
36625 "groupTitle": "Zendesk_Configurations"
36629 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36630 "title": "Gets configurations tags",
36633 "title": "Example usage:",
36634 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36639 "group": "Zendesk_Configurations",
36640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36641 "version": "0.0.0",
36642 "filename": "server/api/intZendeskConfiguration/index.js",
36643 "groupTitle": "Zendesk_Configurations"
36647 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36648 "title": "Sets new tags",
36651 "title": "Example usage:",
36652 "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",
36657 "group": "Zendesk_Configurations",
36658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36659 "version": "0.0.0",
36660 "filename": "server/api/intZendeskConfiguration/index.js",
36661 "groupTitle": "Zendesk_Configurations"
36665 "url": "/api/integrations/zendesk/configurations/{id}",
36666 "title": "Update an existing Zendesk Configuration",
36669 "title": "Example usage:",
36670 "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",
36674 "name": "updateZendesk_Configurations",
36675 "group": "Zendesk_Configurations",
36676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36677 "version": "0.0.0",
36678 "filename": "server/api/intZendeskConfiguration/index.js",
36679 "groupTitle": "Zendesk_Configurations"
36683 "url": "/api/integrations/zendesk/fields",
36684 "title": "Creates a new Zendesk Field",
36687 "title": "Example usage:",
36688 "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",
36692 "name": "CreateZendesk_Fields",
36693 "group": "Zendesk_Fields",
36703 "\"customVariable\"",
36715 "field": "content",
36731 "\"customVariable\""
36734 "field": "keyType",
36741 "field": "keyContent",
36748 "field": "idField",
36755 "field": "nameField",
36762 "field": "customField",
36769 "field": "variableName",
36775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36776 "version": "0.0.0",
36777 "filename": "server/api/intZendeskField/index.js",
36778 "groupTitle": "Zendesk_Fields"
36782 "url": "/api/integrations/zendesk/fields/{id}",
36783 "title": "Deletes a Zendesk Field",
36786 "title": "Example usage:",
36787 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36791 "name": "DeleteZendesk_Fields",
36792 "group": "Zendesk_Fields",
36793 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36794 "version": "0.0.0",
36795 "filename": "server/api/intZendeskField/index.js",
36796 "groupTitle": "Zendesk_Fields"
36800 "url": "/api/integrations/zendesk/fields",
36801 "title": "Gets a list of Zendesk Fields",
36804 "title": "Example usage:",
36805 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36809 "name": "GetZendesk_Fields",
36810 "group": "Zendesk_Fields",
36811 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36812 "version": "0.0.0",
36813 "filename": "server/api/intZendeskField/index.js",
36814 "groupTitle": "Zendesk_Fields"
36818 "url": "/api/integrations/zendesk/fields/{id}",
36819 "title": "Gets a single Zendesk Field",
36822 "title": "Example usage:",
36823 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36827 "name": "ShowZendesk_Fields",
36828 "group": "Zendesk_Fields",
36829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36830 "version": "0.0.0",
36831 "filename": "server/api/intZendeskField/index.js",
36832 "groupTitle": "Zendesk_Fields"
36836 "url": "/api/integrations/zendesk/fields/{id}",
36837 "title": "Update an existing Zendesk Field",
36840 "title": "Example usage:",
36841 "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",
36845 "name": "updateZendesk_Fields",
36846 "group": "Zendesk_Fields",
36847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36848 "version": "0.0.0",
36849 "filename": "server/api/intZendeskField/index.js",
36850 "groupTitle": "Zendesk_Fields"
36854 "url": "/api/integrations/zoho/accounts",
36855 "title": "Creates a new Zoho Account",
36858 "title": "Example usage:",
36859 "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",
36863 "name": "CreateZoho_Accounts",
36864 "group": "Zoho_Accounts",
36879 "field": "description",
36900 "field": "clientId",
36907 "field": "clientSecret",
36914 "field": "serverUrl",
36928 "field": "refreshToken",
36934 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36935 "version": "0.0.0",
36936 "filename": "server/api/intZohoAccount/index.js",
36937 "groupTitle": "Zoho_Accounts"
36941 "url": "/api/integrations/zoho/accounts/{id}",
36942 "title": "Deletes a Zoho Account",
36945 "title": "Example usage:",
36946 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36950 "name": "DeleteZoho_Accounts",
36951 "group": "Zoho_Accounts",
36952 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36953 "version": "0.0.0",
36954 "filename": "server/api/intZohoAccount/index.js",
36955 "groupTitle": "Zoho_Accounts"
36959 "url": "/api/integrations/zoho/accounts",
36960 "title": "Gets a list of Zoho Accounts",
36963 "title": "Example usage:",
36964 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36968 "name": "GetZoho_Accounts",
36969 "group": "Zoho_Accounts",
36970 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36971 "version": "0.0.0",
36972 "filename": "server/api/intZohoAccount/index.js",
36973 "groupTitle": "Zoho_Accounts"
36977 "url": "/api/integrations/zoho/accounts/{id}",
36978 "title": "Gets a single Zoho Account",
36981 "title": "Example usage:",
36982 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36986 "name": "ShowZoho_Accounts",
36987 "group": "Zoho_Accounts",
36988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36989 "version": "0.0.0",
36990 "filename": "server/api/intZohoAccount/index.js",
36991 "groupTitle": "Zoho_Accounts"
36995 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36996 "title": "Creates new configuration",
36999 "title": "Example usage:",
37000 "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",
37004 "name": "addConfiguration",
37005 "group": "Zoho_Accounts",
37006 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37007 "version": "0.0.0",
37008 "filename": "server/api/intZohoAccount/index.js",
37009 "groupTitle": "Zoho_Accounts"
37013 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37014 "title": "Gets account configurations",
37017 "title": "Example usage:",
37018 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37022 "name": "getConfigurations",
37023 "group": "Zoho_Accounts",
37024 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37025 "version": "0.0.0",
37026 "filename": "server/api/intZohoAccount/index.js",
37027 "groupTitle": "Zoho_Accounts"
37031 "url": "/api/integrations/zoho/accounts/{id}/fields",
37032 "title": "Gets account fields",
37035 "title": "Example usage:",
37036 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37040 "name": "getFields",
37041 "group": "Zoho_Accounts",
37042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37043 "version": "0.0.0",
37044 "filename": "server/api/intZohoAccount/index.js",
37045 "groupTitle": "Zoho_Accounts"
37049 "url": "/api/integrations/zoho/accounts/{id}",
37050 "title": "Update an existing Zoho Account",
37053 "title": "Example usage:",
37054 "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",
37058 "name": "updateZoho_Accounts",
37059 "group": "Zoho_Accounts",
37060 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37061 "version": "0.0.0",
37062 "filename": "server/api/intZohoAccount/index.js",
37063 "groupTitle": "Zoho_Accounts"
37067 "url": "/api/integrations/zoho/configurations",
37068 "title": "Creates a new Zoho Configuration",
37071 "title": "Example usage:",
37072 "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",
37076 "name": "CreateZoho_Configurations",
37077 "group": "Zoho_Configurations",
37097 "field": "moduleCreate",
37104 "\"contact_lead\"",
37109 "field": "moduleSearch",
37116 "field": "description",
37122 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37123 "version": "0.0.0",
37124 "filename": "server/api/intZohoConfiguration/index.js",
37125 "groupTitle": "Zoho_Configurations"
37129 "url": "/api/integrations/zoho/configurations/{id}",
37130 "title": "Deletes a Zoho Configuration",
37133 "title": "Example usage:",
37134 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37138 "name": "DeleteZoho_Configurations",
37139 "group": "Zoho_Configurations",
37140 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37141 "version": "0.0.0",
37142 "filename": "server/api/intZohoConfiguration/index.js",
37143 "groupTitle": "Zoho_Configurations"
37147 "url": "/api/integrations/zoho/configurations",
37148 "title": "Gets a list of Zoho Configurations",
37151 "title": "Example usage:",
37152 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37156 "name": "GetZoho_Configurations",
37157 "group": "Zoho_Configurations",
37158 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37159 "version": "0.0.0",
37160 "filename": "server/api/intZohoConfiguration/index.js",
37161 "groupTitle": "Zoho_Configurations"
37165 "url": "/api/integrations/zoho/configurations/{id}",
37166 "title": "Gets a single Zoho Configuration",
37169 "title": "Example usage:",
37170 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37174 "name": "ShowZoho_Configurations",
37175 "group": "Zoho_Configurations",
37176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37177 "version": "0.0.0",
37178 "filename": "server/api/intZohoConfiguration/index.js",
37179 "groupTitle": "Zoho_Configurations"
37183 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37184 "title": "Gets configurations descriptions",
37187 "title": "Example usage:",
37188 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37192 "name": "getDescriptions",
37193 "group": "Zoho_Configurations",
37194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37195 "version": "0.0.0",
37196 "filename": "server/api/intZohoConfiguration/index.js",
37197 "groupTitle": "Zoho_Configurations"
37201 "url": "/api/integrations/zoho/configurations/{id}/fields",
37202 "title": "Gets configurations fields",
37205 "title": "Example usage:",
37206 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37210 "name": "getFields",
37211 "group": "Zoho_Configurations",
37212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37213 "version": "0.0.0",
37214 "filename": "server/api/intZohoConfiguration/index.js",
37215 "groupTitle": "Zoho_Configurations"
37219 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37220 "title": "Gets configurations subjects",
37223 "title": "Example usage:",
37224 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37228 "name": "getSubjects",
37229 "group": "Zoho_Configurations",
37230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37231 "version": "0.0.0",
37232 "filename": "server/api/intZohoConfiguration/index.js",
37233 "groupTitle": "Zoho_Configurations"
37237 "url": "/api/integrations/zoho/configurations/{id}",
37238 "title": "Update an existing Zoho Configuration",
37241 "title": "Example usage:",
37242 "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",
37246 "name": "updateZoho_Configurations",
37247 "group": "Zoho_Configurations",
37248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37249 "version": "0.0.0",
37250 "filename": "server/api/intZohoConfiguration/index.js",
37251 "groupTitle": "Zoho_Configurations"
37255 "url": "/api/integrations/zoho/fields",
37256 "title": "Creates a new Zoho Field",
37259 "title": "Example usage:",
37260 "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",
37264 "name": "CreateZoho_Fields",
37265 "group": "Zoho_Fields",
37275 "\"customVariable\"",
37287 "field": "content",
37303 "\"customVariable\""
37306 "field": "keyType",
37313 "field": "keyContent",
37320 "field": "idField",
37327 "field": "nameField",
37334 "field": "customField",
37341 "field": "variableName",
37347 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37348 "version": "0.0.0",
37349 "filename": "server/api/intZohoField/index.js",
37350 "groupTitle": "Zoho_Fields"
37354 "url": "/api/integrations/zoho/fields/{id}",
37355 "title": "Deletes a Zoho Field",
37358 "title": "Example usage:",
37359 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37363 "name": "DeleteZoho_Fields",
37364 "group": "Zoho_Fields",
37365 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37366 "version": "0.0.0",
37367 "filename": "server/api/intZohoField/index.js",
37368 "groupTitle": "Zoho_Fields"
37372 "url": "/api/integrations/zoho/fields",
37373 "title": "Gets a list of Zoho Fields",
37376 "title": "Example usage:",
37377 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37381 "name": "GetZoho_Fields",
37382 "group": "Zoho_Fields",
37383 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37384 "version": "0.0.0",
37385 "filename": "server/api/intZohoField/index.js",
37386 "groupTitle": "Zoho_Fields"
37390 "url": "/api/integrations/zoho/fields/{id}",
37391 "title": "Gets a single Zoho Field",
37394 "title": "Example usage:",
37395 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37399 "name": "ShowZoho_Fields",
37400 "group": "Zoho_Fields",
37401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37402 "version": "0.0.0",
37403 "filename": "server/api/intZohoField/index.js",
37404 "groupTitle": "Zoho_Fields"
37408 "url": "/api/integrations/zoho/fields/{id}",
37409 "title": "Update an existing Zoho Field",
37412 "title": "Example usage:",
37413 "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",
37417 "name": "updateZoho_Fields",
37418 "group": "Zoho_Fields",
37419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37420 "version": "0.0.0",
37421 "filename": "server/api/intZohoField/index.js",
37422 "groupTitle": "Zoho_Fields"
37427 "title": "Creates a new Cdr",
37430 "title": "Example usage:",
37431 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37435 "name": "CreateCdrs",
37444 "field": "calldate",
37472 "field": "dcontext",
37479 "field": "channel",
37486 "field": "dstchannel",
37493 "field": "lastapp",
37500 "field": "lastdata",
37507 "field": "duration",
37514 "field": "billsec",
37521 "field": "disposition",
37528 "field": "amaflags",
37535 "field": "accountcode",
37542 "field": "userfield",
37549 "field": "uniqueid",
37556 "field": "linkedid",
37563 "field": "sequence",
37570 "field": "peeraccount",
37590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37591 "version": "0.0.0",
37592 "filename": "server/api/cdr/index.js",
37593 "groupTitle": "cdr"
37597 "url": "/api/cdr/{id}",
37598 "title": "Deletes a Cdr",
37601 "title": "Example usage:",
37602 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37606 "name": "DeleteCdrs",
37608 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37609 "version": "0.0.0",
37610 "filename": "server/api/cdr/index.js",
37611 "groupTitle": "cdr"
37615 "url": "/api/cdr/describe",
37616 "title": "Gets table info about Cdrs",
37619 "title": "Example usage:",
37620 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37624 "name": "DescribeCdrs",
37626 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37627 "version": "0.0.0",
37628 "filename": "server/api/cdr/index.js",
37629 "groupTitle": "cdr"
37634 "title": "Gets a list of Cdrs",
37637 "title": "Example usage:",
37638 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37644 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37645 "version": "0.0.0",
37646 "filename": "server/api/cdr/index.js",
37647 "groupTitle": "cdr"
37651 "url": "/api/cdr/{id}",
37652 "title": "Gets a single Cdr",
37655 "title": "Example usage:",
37656 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37660 "name": "ShowCdrs",
37662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37663 "version": "0.0.0",
37664 "filename": "server/api/cdr/index.js",
37665 "groupTitle": "cdr"
37669 "url": "/api/cdr/{id}",
37670 "title": "Update an existing Cdr",
37673 "title": "Example usage:",
37674 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37678 "name": "updateCdrs",
37680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37681 "version": "0.0.0",
37682 "filename": "server/api/cdr/index.js",
37683 "groupTitle": "cdr"
37687 "url": "/api/voiceQueuesLog",
37688 "title": "Creates a new VoiceQueuesLog",
37691 "title": "Example usage:",
37692 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37696 "name": "CreateVoiceQueuesLogs",
37697 "group": "voiceQueuesLog",
37719 "field": "queuename",
37788 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37789 "version": "0.0.0",
37790 "filename": "server/api/voiceQueuesLog/index.js",
37791 "groupTitle": "voiceQueuesLog"
37795 "url": "/api/voiceQueuesLog/{id}",
37796 "title": "Deletes a VoiceQueuesLog",
37799 "title": "Example usage:",
37800 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37804 "name": "DeleteVoiceQueuesLogs",
37805 "group": "voiceQueuesLog",
37806 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37807 "version": "0.0.0",
37808 "filename": "server/api/voiceQueuesLog/index.js",
37809 "groupTitle": "voiceQueuesLog"
37813 "url": "/api/voiceQueuesLog",
37814 "title": "Gets a list of VoiceQueuesLogs",
37817 "title": "Example usage:",
37818 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37822 "name": "GetVoiceQueuesLogs",
37823 "group": "voiceQueuesLog",
37824 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37825 "version": "0.0.0",
37826 "filename": "server/api/voiceQueuesLog/index.js",
37827 "groupTitle": "voiceQueuesLog"
37831 "url": "/api/voiceQueuesLog/{id}",
37832 "title": "Gets a single VoiceQueuesLog",
37835 "title": "Example usage:",
37836 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37840 "name": "ShowVoiceQueuesLogs",
37841 "group": "voiceQueuesLog",
37842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37843 "version": "0.0.0",
37844 "filename": "server/api/voiceQueuesLog/index.js",
37845 "groupTitle": "voiceQueuesLog"
37849 "url": "/api/voiceQueuesLog/{id}",
37850 "title": "Update an existing VoiceQueuesLog",
37853 "title": "Example usage:",
37854 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37858 "name": "updateVoiceQueuesLogs",
37859 "group": "voiceQueuesLog",
37860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37861 "version": "0.0.0",
37862 "filename": "server/api/voiceQueuesLog/index.js",
37863 "groupTitle": "voiceQueuesLog"