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": "vidaooTopic",
4396 "field": "vidaooNote",
4403 "field": "vidaooMetadata",
4410 "field": "openNewInteraction",
4417 "field": "subjectOffline",
4423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4425 "filename": "server/api/chatWebsite/index.js",
4426 "groupTitle": "Chat_Websites"
4430 "url": "/api/chat/websites/{id}",
4431 "title": "Deletes a Website",
4434 "title": "Example usage:",
4435 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4439 "name": "DeleteWebsites",
4440 "group": "Chat_Websites",
4441 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4443 "filename": "server/api/chatWebsite/index.js",
4444 "groupTitle": "Chat_Websites"
4448 "url": "/api/chat/websites/describe",
4449 "title": "Gets table info about Websites",
4452 "title": "Example usage:",
4453 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4457 "name": "DescribeWebsites",
4458 "group": "Chat_Websites",
4459 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4461 "filename": "server/api/chatWebsite/index.js",
4462 "groupTitle": "Chat_Websites"
4466 "url": "/api/chat/websites/{id}/users",
4467 "title": "Gets agents from website",
4470 "title": "Example usage:",
4471 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4475 "name": "GetAgents",
4476 "group": "Chat_Websites",
4477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4479 "filename": "server/api/chatWebsite/index.js",
4480 "groupTitle": "Chat_Websites"
4484 "url": "/api/chat/websites",
4485 "title": "Gets a list of Websites",
4488 "title": "Example usage:",
4489 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4493 "name": "GetWebsites",
4494 "group": "Chat_Websites",
4495 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4497 "filename": "server/api/chatWebsite/index.js",
4498 "groupTitle": "Chat_Websites"
4502 "url": "/api/chat/websites/{id}/users",
4503 "title": "Removes agents from a website",
4506 "title": "Example usage:",
4507 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4511 "name": "RemoveAgents",
4512 "group": "Chat_Websites",
4513 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4515 "filename": "server/api/chatWebsite/index.js",
4516 "groupTitle": "Chat_Websites"
4520 "url": "/api/chat/websites/{id}/canned_answers",
4521 "title": "Removes canned answers from account",
4524 "title": "Example usage:",
4525 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4529 "name": "RemoveAnswers",
4530 "group": "Chat_Websites",
4531 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4533 "filename": "server/api/chatWebsite/index.js",
4534 "groupTitle": "Chat_Websites"
4538 "url": "/api/chat/websites/{id}/dispositions",
4539 "title": "Removes canned answers from account",
4542 "title": "Example usage:",
4543 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4547 "name": "RemoveDispositions",
4548 "group": "Chat_Websites",
4549 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4551 "filename": "server/api/chatWebsite/index.js",
4552 "groupTitle": "Chat_Websites"
4556 "url": "/api/chat/websites/{id}",
4557 "title": "Gets a single Website",
4560 "title": "Example usage:",
4561 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4565 "name": "ShowWebsites",
4566 "group": "Chat_Websites",
4567 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4569 "filename": "server/api/chatWebsite/index.js",
4570 "groupTitle": "Chat_Websites"
4574 "url": "/api/chat/messages/{id}/accept",
4575 "title": "Accepts message",
4578 "title": "Example usage:",
4579 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4583 "name": "acceptMessage",
4584 "group": "Chat_Websites",
4585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4587 "filename": "server/api/chatMessage/index.js",
4588 "groupTitle": "Chat_Websites"
4592 "url": "/api/chat/websites/{id}/canned_answers",
4593 "title": "Creates new canned answer",
4596 "title": "Example usage:",
4597 "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",
4601 "name": "addAnswer",
4602 "group": "Chat_Websites",
4624 "field": "description",
4637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4639 "filename": "server/api/chatWebsite/index.js",
4640 "groupTitle": "Chat_Websites"
4644 "url": "/api/chat/websites/{id}/applications",
4645 "title": "Creates new applications",
4648 "title": "Example usage:",
4649 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4653 "name": "addApplications",
4654 "group": "Chat_Websites",
4662 "field": "priority",
4683 "field": "description",
4690 "field": "interval",
4696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4698 "filename": "server/api/chatWebsite/index.js",
4699 "groupTitle": "Chat_Websites"
4703 "url": "/api/chat/websites/{id}/avatar",
4704 "title": "Add avatar",
4707 "title": "Example usage:",
4708 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4712 "name": "addAvatar",
4713 "group": "Chat_Websites",
4714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4716 "filename": "server/api/chatWebsite/index.js",
4717 "groupTitle": "Chat_Websites"
4721 "url": "/api/chat/websites/{id}/customer_avatar",
4722 "title": "Add customer avatar",
4725 "title": "Example usage:",
4726 "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",
4730 "name": "addCustomerAvatar",
4731 "group": "Chat_Websites",
4732 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4734 "filename": "server/api/chatWebsite/index.js",
4735 "groupTitle": "Chat_Websites"
4739 "url": "/api/chat/websites/{id}/dispositions",
4740 "title": "Creates new disposition",
4743 "title": "Example usage:",
4744 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4748 "name": "addDisposition",
4749 "group": "Chat_Websites",
4776 "field": "description",
4782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4784 "filename": "server/api/chatWebsite/index.js",
4785 "groupTitle": "Chat_Websites"
4789 "url": "/api/chat/accounts/{id}/interactions",
4790 "title": "Creates new interactions",
4793 "title": "Example usage:",
4794 "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",
4798 "name": "addInteraction",
4799 "group": "Chat_Websites",
4814 "field": "ratingValue",
4825 "field": "ratingType",
4832 "field": "ratingMessage",
4839 "field": "pathTranscript",
4846 "field": "mailTranscript",
4853 "field": "closedAt",
4860 "field": "disposition",
4867 "field": "secondDisposition",
4874 "field": "thirdDisposition",
4888 "field": "browserName",
4895 "field": "browserVersion",
4909 "field": "osVersion",
4916 "field": "deviceModel",
4923 "field": "deviceVendor",
4930 "field": "deviceType",
4944 "field": "customerIp",
4951 "field": "formData",
4958 "field": "read1stAt",
4965 "field": "lastMsgAt",
4976 "field": "lastMsgDirection",
4983 "field": "closeReason",
4990 "field": "customerPort",
4997 "field": "vidaooSessionId",
5003 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5005 "filename": "server/api/chatWebsite/index.js",
5006 "groupTitle": "Chat_Websites"
5010 "url": "/api/chat/websites/{id}/logo",
5011 "title": "Add logo",
5014 "title": "Example usage:",
5015 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5020 "group": "Chat_Websites",
5021 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5023 "filename": "server/api/chatWebsite/index.js",
5024 "groupTitle": "Chat_Websites"
5028 "url": "/api/chat/websites/{id}/proactive_actions",
5029 "title": "Creates new Proactive Actions",
5032 "title": "Example usage:",
5033 "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",
5037 "name": "addProactiveActions",
5038 "group": "Chat_Websites",
5064 "field": "selector",
5077 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5079 "filename": "server/api/chatWebsite/index.js",
5080 "groupTitle": "Chat_Websites"
5084 "url": "/api/chat/websites/{id}/system_avatar",
5085 "title": "Add system avatar",
5088 "title": "Example usage:",
5089 "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",
5093 "name": "addSystemAvatar",
5094 "group": "Chat_Websites",
5095 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5097 "filename": "server/api/chatWebsite/index.js",
5098 "groupTitle": "Chat_Websites"
5102 "url": "/api/chat/websites/{id}/canned_answers",
5103 "title": "Gets account canned answers",
5106 "title": "Example usage:",
5107 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5111 "name": "getAnswers",
5112 "group": "Chat_Websites",
5113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5115 "filename": "server/api/chatWebsite/index.js",
5116 "groupTitle": "Chat_Websites"
5120 "url": "/api/chat/websites/{id}/applications",
5121 "title": "Gets Website Applications",
5124 "title": "Example usage:",
5125 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5129 "name": "getApplications",
5130 "group": "Chat_Websites",
5131 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5133 "filename": "server/api/chatWebsite/index.js",
5134 "groupTitle": "Chat_Websites"
5138 "url": "/api/chat/websites/{id}/avatar",
5139 "title": "Get avatar",
5142 "title": "Example usage:",
5143 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5147 "name": "getAvatar",
5148 "group": "Chat_Websites",
5149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5151 "filename": "server/api/chatWebsite/index.js",
5152 "groupTitle": "Chat_Websites"
5156 "url": "/api/chat/websites/{id}/customer_avatar",
5157 "title": "Get Customer Avatar",
5160 "title": "Example usage:",
5161 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5165 "name": "getCustomerAvatar",
5166 "group": "Chat_Websites",
5167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5169 "filename": "server/api/chatWebsite/index.js",
5170 "groupTitle": "Chat_Websites"
5174 "url": "/api/chat/websites/{id}/dispositions",
5175 "title": "Gets account dispositions",
5178 "title": "Example usage:",
5179 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5183 "name": "getDispositions",
5184 "group": "Chat_Websites",
5185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5187 "filename": "server/api/chatWebsite/index.js",
5188 "groupTitle": "Chat_Websites"
5192 "url": "/api/chat/websites/{id}/fields",
5193 "title": "Gets Website Fields",
5196 "title": "Example usage:",
5197 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5201 "name": "getFields",
5202 "group": "Chat_Websites",
5203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5205 "filename": "server/api/chatWebsite/index.js",
5206 "groupTitle": "Chat_Websites"
5210 "url": "/api/chat/websites/{id}/interactions",
5211 "title": "Gets Website Interactions",
5214 "title": "Example usage:",
5215 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5219 "name": "getInteraction",
5220 "group": "Chat_Websites",
5221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5223 "filename": "server/api/chatWebsite/index.js",
5224 "groupTitle": "Chat_Websites"
5228 "url": "/api/chat/websites/{id}/logo",
5229 "title": "Get logo",
5232 "title": "Example usage:",
5233 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5238 "group": "Chat_Websites",
5239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5241 "filename": "server/api/chatWebsite/index.js",
5242 "groupTitle": "Chat_Websites"
5246 "url": "/api/chat/websites/{id}/offline_messages",
5247 "title": "Gets Website Offline Messages",
5250 "title": "Example usage:",
5251 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5255 "name": "getOfflineMessages",
5256 "group": "Chat_Websites",
5257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5259 "filename": "server/api/chatWebsite/index.js",
5260 "groupTitle": "Chat_Websites"
5264 "url": "/api/chat/websites/{id}/proactive_actions",
5265 "title": "Gets Website Proactive Actions",
5268 "title": "Example usage:",
5269 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5273 "name": "getProactiveActions",
5274 "group": "Chat_Websites",
5275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5277 "filename": "server/api/chatWebsite/index.js",
5278 "groupTitle": "Chat_Websites"
5282 "url": "/api/chat/websites/{id}/snippet",
5283 "title": "Gets Website Snippet",
5286 "title": "Example usage:",
5287 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5291 "name": "getSnippet",
5292 "group": "Chat_Websites",
5293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5295 "filename": "server/api/chatWebsite/index.js",
5296 "groupTitle": "Chat_Websites"
5300 "url": "/api/chat/websites/{id}/system_avatar",
5301 "title": "Get System Avatar",
5304 "title": "Example usage:",
5305 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5309 "name": "getSystemAvatar",
5310 "group": "Chat_Websites",
5311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5313 "filename": "server/api/chatWebsite/index.js",
5314 "groupTitle": "Chat_Websites"
5318 "url": "/api/chat/websites/{id}/notify",
5319 "title": "Notify new message",
5322 "title": "Example usage:",
5323 "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",
5328 "group": "Chat_Websites",
5329 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5331 "filename": "server/api/chatWebsite/index.js",
5332 "groupTitle": "Chat_Websites"
5336 "url": "/api/chat/websites/{id}/offline",
5337 "title": "Offline message",
5340 "title": "Example usage:",
5341 "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",
5346 "group": "Chat_Websites",
5347 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5349 "filename": "server/api/chatWebsite/index.js",
5350 "groupTitle": "Chat_Websites"
5354 "url": "/api/chat/messages/{id}/reject",
5355 "title": "Rejects message",
5358 "title": "Example usage:",
5359 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5363 "name": "rejectMessage",
5364 "group": "Chat_Websites",
5365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5367 "filename": "server/api/chatMessage/index.js",
5368 "groupTitle": "Chat_Websites"
5372 "url": "/api/chat/websites/{id}",
5373 "title": "Update an existing Website",
5376 "title": "Example usage:",
5377 "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",
5381 "name": "updateWebsites",
5382 "group": "Chat_Websites",
5383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5385 "filename": "server/api/chatWebsite/index.js",
5386 "groupTitle": "Chat_Websites"
5390 "url": "/api/cloudProviders",
5391 "title": "Creates a new CloudProvider",
5394 "title": "Example usage:",
5395 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5399 "name": "CreateCloudProviders",
5400 "group": "CloudProviders",
5439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5441 "filename": "server/api/cloudProvider/index.js",
5442 "groupTitle": "CloudProviders"
5446 "url": "/api/cloudProviders/{id}",
5447 "title": "Deletes a CloudProvider",
5450 "title": "Example usage:",
5451 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5455 "name": "DeleteCloudProviders",
5456 "group": "CloudProviders",
5457 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5459 "filename": "server/api/cloudProvider/index.js",
5460 "groupTitle": "CloudProviders"
5464 "url": "/api/cloudProviders",
5465 "title": "Gets a list of CloudProviders",
5468 "title": "Example usage:",
5469 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5473 "name": "GetCloudProviders",
5474 "group": "CloudProviders",
5475 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5477 "filename": "server/api/cloudProvider/index.js",
5478 "groupTitle": "CloudProviders"
5482 "url": "/api/cloudProviders/{id}",
5483 "title": "Gets a single CloudProvider",
5486 "title": "Example usage:",
5487 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5491 "name": "ShowCloudProviders",
5492 "group": "CloudProviders",
5493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5495 "filename": "server/api/cloudProvider/index.js",
5496 "groupTitle": "CloudProviders"
5500 "url": "/api/cloudProviders/{id}",
5501 "title": "Update an existing CloudProvider",
5504 "title": "Example usage:",
5505 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5509 "name": "updateCloudProviders",
5510 "group": "CloudProviders",
5511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5513 "filename": "server/api/cloudProvider/index.js",
5514 "groupTitle": "CloudProviders"
5518 "url": "/api/cm/companies",
5519 "title": "Creates a new Company",
5522 "title": "Example usage:",
5523 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5527 "name": "CreateCompanies",
5528 "group": "Cm_Companies",
5550 "field": "companyId",
5592 "field": "postalCode",
5620 "field": "emailDomain",
5634 "field": "sPostalCode",
5648 "field": "sCountry",
5655 "field": "description",
5661 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5663 "filename": "server/api/cmCompany/index.js",
5664 "groupTitle": "Cm_Companies"
5668 "url": "/api/cm/companies/{id}",
5669 "title": "Deletes a Company",
5672 "title": "Example usage:",
5673 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5677 "name": "DeleteCompanies",
5678 "group": "Cm_Companies",
5679 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5681 "filename": "server/api/cmCompany/index.js",
5682 "groupTitle": "Cm_Companies"
5686 "url": "/api/cm/companies/describe",
5687 "title": "Gets table info about Companies",
5690 "title": "Example usage:",
5691 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5695 "name": "DescribeCompanies",
5696 "group": "Cm_Companies",
5697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5699 "filename": "server/api/cmCompany/index.js",
5700 "groupTitle": "Cm_Companies"
5704 "url": "/api/cm/companies",
5705 "title": "Gets a list of Companies",
5708 "title": "Example usage:",
5709 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5713 "name": "GetCompanies",
5714 "group": "Cm_Companies",
5715 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5717 "filename": "server/api/cmCompany/index.js",
5718 "groupTitle": "Cm_Companies"
5722 "url": "/api/cm/companies/{id}",
5723 "title": "Gets a single Company",
5726 "title": "Example usage:",
5727 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5731 "name": "ShowCompanies",
5732 "group": "Cm_Companies",
5733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5735 "filename": "server/api/cmCompany/index.js",
5736 "groupTitle": "Cm_Companies"
5740 "url": "/api/cm/companies/{id}/contacts",
5741 "title": "Creates new contacts",
5744 "title": "Example usage:",
5745 "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",
5749 "name": "addContacts",
5750 "group": "Cm_Companies",
5758 "field": "firstName",
5765 "field": "lastName",
5779 "field": "postalCode",
5800 "field": "dateOfBirth",
5807 "field": "description",
5849 "field": "facebook",
5905 "field": "telegram",
5919 "field": "priority",
5926 "field": "scheduledat",
5932 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5934 "filename": "server/api/cmCompany/index.js",
5935 "groupTitle": "Cm_Companies"
5939 "url": "/api/cm/companies/{id}/contacts",
5940 "title": "Gets List Contacts",
5943 "title": "Example usage:",
5944 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5948 "name": "getContacts",
5949 "group": "Cm_Companies",
5950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5952 "filename": "server/api/cmCompany/index.js",
5953 "groupTitle": "Cm_Companies"
5957 "url": "/api/cm/companies/{id}",
5958 "title": "Update an existing Company",
5961 "title": "Example usage:",
5962 "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",
5966 "name": "updateCompanies",
5967 "group": "Cm_Companies",
5968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5970 "filename": "server/api/cmCompany/index.js",
5971 "groupTitle": "Cm_Companies"
5975 "url": "/api/cm/contacts/{id}",
5976 "title": "Deletes a Contact",
5979 "title": "Example usage:",
5980 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5984 "name": "DeleteContacts",
5985 "group": "Cm_Contacts",
5986 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5988 "filename": "server/api/cmContact/index.js",
5989 "groupTitle": "Cm_Contacts"
5993 "url": "/api/cm/contacts/describe",
5994 "title": "Gets table info about Contacts",
5997 "title": "Example usage:",
5998 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6002 "name": "DescribeContacts",
6003 "group": "Cm_Contacts",
6004 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6006 "filename": "server/api/cmContact/index.js",
6007 "groupTitle": "Cm_Contacts"
6011 "url": "/api/cm/contacts",
6012 "title": "Gets a list of Contacts",
6015 "title": "Example usage:",
6016 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6020 "name": "GetContacts",
6021 "group": "Cm_Contacts",
6022 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6024 "filename": "server/api/cmContact/index.js",
6025 "groupTitle": "Cm_Contacts"
6029 "url": "/api/cm/contacts/{id}/finals",
6030 "title": "Gets contact hopper finals",
6033 "title": "Example usage:",
6034 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6038 "name": "GetHopperFinals",
6039 "group": "Cm_Contacts",
6040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6042 "filename": "server/api/cmContact/index.js",
6043 "groupTitle": "Cm_Contacts"
6047 "url": "/api/cm/contacts/{id}/hopper_histories",
6048 "title": "Gets contact hopper histories",
6051 "title": "Example usage:",
6052 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6056 "name": "GetHopperHistories",
6057 "group": "Cm_Contacts",
6058 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6060 "filename": "server/api/cmContact/index.js",
6061 "groupTitle": "Cm_Contacts"
6065 "url": "/api/cm/contacts/{id}/hoppers",
6066 "title": "Gets contact hoppers",
6069 "title": "Example usage:",
6070 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6074 "name": "GetHoppers",
6075 "group": "Cm_Contacts",
6076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6078 "filename": "server/api/cmContact/index.js",
6079 "groupTitle": "Cm_Contacts"
6083 "url": "/api/cm/contacts/create_many",
6084 "title": "Create Contacts",
6087 "title": "Example usage:",
6088 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6092 "name": "bulkCreate",
6093 "group": "Cm_Contacts",
6094 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6096 "filename": "server/api/cmContact/index.js",
6097 "groupTitle": "Cm_Contacts"
6101 "url": "/api/cm/contacts",
6102 "title": "Create Contact",
6105 "title": "Example usage:",
6106 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6111 "group": "Cm_Contacts",
6112 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6114 "filename": "server/api/cmContact/index.js",
6115 "groupTitle": "Cm_Contacts"
6119 "url": "/api/cm/contacts/{id}/journey",
6120 "title": "Gets customer journey",
6123 "title": "Example usage:",
6124 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6128 "name": "getJourney",
6129 "group": "Cm_Contacts",
6130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6132 "filename": "server/api/cmContact/index.js",
6133 "groupTitle": "Cm_Contacts"
6137 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6138 "title": "Gets contact hopper blacks",
6141 "title": "Example usage:",
6142 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6146 "name": "getJscriptySessions",
6147 "group": "Cm_Contacts",
6148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6150 "filename": "server/api/cmContact/index.js",
6151 "groupTitle": "Cm_Contacts"
6155 "url": "/api/cm/contacts/{id}/tags",
6156 "title": "Gets configurations tags",
6159 "title": "Example usage:",
6160 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6165 "group": "Cm_Contacts",
6166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6168 "filename": "server/api/cmContact/index.js",
6169 "groupTitle": "Cm_Contacts"
6173 "url": "/api/cm/contacts/merge",
6174 "title": "Merge Contact",
6177 "title": "Example usage:",
6178 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6183 "group": "Cm_Contacts",
6184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6186 "filename": "server/api/cmContact/index.js",
6187 "groupTitle": "Cm_Contacts"
6191 "url": "/api/cm/contacts/{id}/tags",
6192 "title": "Sets new tags",
6195 "title": "Example usage:",
6196 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6201 "group": "Cm_Contacts",
6202 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6204 "filename": "server/api/cmContact/index.js",
6205 "groupTitle": "Cm_Contacts"
6209 "url": "/api/cm/contacts/{id}",
6210 "title": "Gets a single Contact",
6213 "title": "Example usage:",
6214 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6219 "group": "Cm_Contacts",
6220 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6222 "filename": "server/api/cmContact/index.js",
6223 "groupTitle": "Cm_Contacts"
6227 "url": "/api/cm/contacts/{id}",
6228 "title": "Update a single Contact",
6231 "title": "Example usage:",
6232 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6237 "group": "Cm_Contacts",
6238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6240 "filename": "server/api/cmContact/index.js",
6241 "groupTitle": "Cm_Contacts"
6245 "url": "/api/cm/custom_fields/{id}",
6246 "title": "Deletes a Custom Field",
6249 "title": "Example usage:",
6250 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6254 "name": "DeleteCustom_Fields",
6255 "group": "Cm_Custom_Fields",
6256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6258 "filename": "server/api/cmCustomField/index.js",
6259 "groupTitle": "Cm_Custom_Fields"
6263 "url": "/api/cm/custom_fields",
6264 "title": "Gets a list of Custom Fields",
6267 "title": "Example usage:",
6268 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6272 "name": "GetCustom_Fields",
6273 "group": "Cm_Custom_Fields",
6274 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6276 "filename": "server/api/cmCustomField/index.js",
6277 "groupTitle": "Cm_Custom_Fields"
6281 "url": "/api/cm/custom_fields/{id}",
6282 "title": "Gets a single Custom Field",
6285 "title": "Example usage:",
6286 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6290 "name": "ShowCustom_Fields",
6291 "group": "Cm_Custom_Fields",
6292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6294 "filename": "server/api/cmCustomField/index.js",
6295 "groupTitle": "Cm_Custom_Fields"
6299 "url": "/api/cm/custom_fields/{id}",
6300 "title": "Update an existing Custom Field",
6303 "title": "Example usage:",
6304 "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",
6308 "name": "updateCustom_Fields",
6309 "group": "Cm_Custom_Fields",
6310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6312 "filename": "server/api/cmCustomField/index.js",
6313 "groupTitle": "Cm_Custom_Fields"
6317 "url": "/api/cm/hopper",
6318 "title": "Creates a new Hopper",
6321 "title": "Example usage:",
6322 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6326 "name": "CreateHopper",
6327 "group": "Cm_Hopper",
6349 "field": "scheduledat",
6356 "field": "countbusyretry",
6363 "field": "countcongestionretry",
6370 "field": "countnoanswerretry",
6377 "field": "callback",
6384 "field": "callbackuniqueid",
6391 "field": "callbackat",
6398 "field": "priority",
6405 "field": "recallme",
6412 "field": "ContactId",
6433 "field": "VoiceQueueId",
6440 "field": "CampaignId",
6447 "field": "countnosuchnumberretry",
6454 "field": "countdropretry",
6461 "field": "countabandonedretry",
6468 "field": "countmachineretry",
6475 "field": "countagentrejectretry",
6481 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6483 "filename": "server/api/cmHopper/index.js",
6484 "groupTitle": "Cm_Hopper"
6488 "url": "/api/cm/hopper/describe",
6489 "title": "Gets table info about Hopper",
6492 "title": "Example usage:",
6493 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6497 "name": "DescribeHopper",
6498 "group": "Cm_Hopper",
6499 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6501 "filename": "server/api/cmHopper/index.js",
6502 "groupTitle": "Cm_Hopper"
6506 "url": "/api/cm/hopper",
6507 "title": "Gets a list of Hopper",
6510 "title": "Example usage:",
6511 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6515 "name": "GetHopper",
6516 "group": "Cm_Hopper",
6517 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6519 "filename": "server/api/cmHopper/index.js",
6520 "groupTitle": "Cm_Hopper"
6524 "url": "/api/cm/hopper/{id}",
6525 "title": "Gets a single Hopper",
6528 "title": "Example usage:",
6529 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6533 "name": "ShowHopper",
6534 "group": "Cm_Hopper",
6535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6537 "filename": "server/api/cmHopper/index.js",
6538 "groupTitle": "Cm_Hopper"
6542 "url": "/api/cm/hopper_black/{id}",
6543 "title": "Deletes a Hopper Black",
6546 "title": "Example usage:",
6547 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6551 "name": "DeleteHopper_Black",
6552 "group": "Cm_Hopper_Black",
6553 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6555 "filename": "server/api/cmHopperBlack/index.js",
6556 "groupTitle": "Cm_Hopper_Black"
6560 "url": "/api/cm/hopper_black/describe",
6561 "title": "Gets table info about Hopper Black",
6564 "title": "Example usage:",
6565 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6569 "name": "DescribeHopper_Black",
6570 "group": "Cm_Hopper_Black",
6571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6573 "filename": "server/api/cmHopperBlack/index.js",
6574 "groupTitle": "Cm_Hopper_Black"
6578 "url": "/api/cm/hopper_black",
6579 "title": "Gets a list of Hopper Black",
6582 "title": "Example usage:",
6583 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6587 "name": "GetHopper_Black",
6588 "group": "Cm_Hopper_Black",
6589 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6591 "filename": "server/api/cmHopperBlack/index.js",
6592 "groupTitle": "Cm_Hopper_Black"
6596 "url": "/api/cm/hopper_black/{id}",
6597 "title": "Gets a single Hopper Black",
6600 "title": "Example usage:",
6601 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6605 "name": "ShowHopper_Black",
6606 "group": "Cm_Hopper_Black",
6607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6609 "filename": "server/api/cmHopperBlack/index.js",
6610 "groupTitle": "Cm_Hopper_Black"
6614 "url": "/api/cm/hopper_black/{id}",
6615 "title": "Update an existing Hopper Black",
6618 "title": "Example usage:",
6619 "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",
6623 "name": "updateHopper_Black",
6624 "group": "Cm_Hopper_Black",
6625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6627 "filename": "server/api/cmHopperBlack/index.js",
6628 "groupTitle": "Cm_Hopper_Black"
6632 "url": "/api/cm/hopper_final/checkContactHopper",
6633 "title": "Check if contact is in hopper",
6636 "title": "Example usage:",
6637 "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",
6641 "name": "/checkContactHopper",
6642 "group": "Cm_Hopper_Final",
6643 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6645 "filename": "server/api/cmHopperFinal/index.js",
6646 "groupTitle": "Cm_Hopper_Final"
6650 "url": "/api/cm/hopper_final/describe",
6651 "title": "Gets table info about HopperFinal",
6654 "title": "Example usage:",
6655 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6659 "name": "DescribeHopperFinal",
6660 "group": "Cm_Hopper_Final",
6661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6663 "filename": "server/api/cmHopperFinal/index.js",
6664 "groupTitle": "Cm_Hopper_Final"
6668 "url": "/api/cm/hopper_final",
6669 "title": "Gets a list of HopperFinal",
6672 "title": "Example usage:",
6673 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6677 "name": "GetHopperFinal",
6678 "group": "Cm_Hopper_Final",
6679 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6681 "filename": "server/api/cmHopperFinal/index.js",
6682 "groupTitle": "Cm_Hopper_Final"
6686 "url": "/api/cm/hopper_final/{id}",
6687 "title": "Gets a single HopperFinal",
6690 "title": "Example usage:",
6691 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6695 "name": "ShowHopperFinal",
6696 "group": "Cm_Hopper_Final",
6697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6699 "filename": "server/api/cmHopperFinal/index.js",
6700 "groupTitle": "Cm_Hopper_Final"
6704 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6705 "title": "Return number contacts for attributes",
6708 "title": "Example usage:",
6709 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6713 "name": "countContactsIvrCampaignHopperFinal",
6714 "group": "Cm_Hopper_Final",
6715 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6717 "filename": "server/api/cmHopperFinal/index.js",
6718 "groupTitle": "Cm_Hopper_Final"
6722 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6723 "title": "Return number contacts for attributes",
6726 "title": "Example usage:",
6727 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6731 "name": "countContactsQueueCampaignHopperFinal",
6732 "group": "Cm_Hopper_Final",
6733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6735 "filename": "server/api/cmHopperFinal/index.js",
6736 "groupTitle": "Cm_Hopper_Final"
6740 "url": "/api/cm/hopper_final/campaign/{id}",
6741 "title": "Move contacts in hopper",
6744 "title": "Example usage:",
6745 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6749 "name": "moveContactsIvrCampaignHopperFinal",
6750 "group": "Cm_Hopper_Final",
6751 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6753 "filename": "server/api/cmHopperFinal/index.js",
6754 "groupTitle": "Cm_Hopper_Final"
6758 "url": "/api/cm/hopper_final/voice/queue/{id}",
6759 "title": "Move contacts in hopper",
6762 "title": "Example usage:",
6763 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6767 "name": "moveContactsQueueCampaignHopperFinal",
6768 "group": "Cm_Hopper_Final",
6769 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6771 "filename": "server/api/cmHopperFinal/index.js",
6772 "groupTitle": "Cm_Hopper_Final"
6776 "url": "/api/cm/hopper_final/{id}",
6777 "title": "Update a single hopper final",
6780 "title": "Example usage:",
6781 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6786 "group": "Cm_Hopper_Final",
6787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6789 "filename": "server/api/cmHopperFinal/index.js",
6790 "groupTitle": "Cm_Hopper_Final"
6794 "url": "/api/cm/hopper_history",
6795 "title": "Creates a new HopperHistory",
6798 "title": "Example usage:",
6799 "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",
6803 "name": "CreateHopperHistory",
6804 "group": "Cm_Hopper_History",
6819 "field": "statedesc",
6826 "field": "scheduledat",
6833 "field": "countbusyretry",
6840 "field": "countcongestionretry",
6847 "field": "countnoanswerretry",
6854 "field": "countglobal",
6861 "field": "uniqueid",
6868 "field": "originatecalleridnum",
6875 "field": "originatecalleridname",
6882 "field": "calleridnum",
6889 "field": "calleridname",
6896 "field": "starttime",
6903 "field": "responsetime",
6910 "field": "answertime",
6917 "field": "droptime",
6931 "field": "ringtime",
6938 "field": "holdtime",
6945 "field": "talktime",
6952 "field": "followuptime",
6959 "field": "dropreason",
6966 "field": "campaign",
6973 "field": "campaigntype",
6980 "field": "membername",
7008 "field": "callback",
7015 "field": "callbackuniqueid",
7022 "field": "callbackat",
7029 "field": "recallme",
7036 "field": "editedat",
7050 "field": "countnosuchnumberretry",
7057 "field": "countdropretry",
7064 "field": "countabandonedretry",
7071 "field": "countmachineretry",
7078 "field": "countagentrejectretry",
7084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7086 "filename": "server/api/cmHopperHistory/index.js",
7087 "groupTitle": "Cm_Hopper_History"
7091 "url": "/api/cm/hopper_history/describe",
7092 "title": "Gets table info about HopperHistory",
7095 "title": "Example usage:",
7096 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7100 "name": "DescribeHopperHistory",
7101 "group": "Cm_Hopper_History",
7102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7104 "filename": "server/api/cmHopperHistory/index.js",
7105 "groupTitle": "Cm_Hopper_History"
7109 "url": "/api/cm/hopper_history",
7110 "title": "Gets a list of HopperHistory",
7113 "title": "Example usage:",
7114 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7118 "name": "GetHopperHistory",
7119 "group": "Cm_Hopper_History",
7120 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7122 "filename": "server/api/cmHopperHistory/index.js",
7123 "groupTitle": "Cm_Hopper_History"
7127 "url": "/api/cm/hopper_history/{id}",
7128 "title": "Gets a single HopperHistory",
7131 "title": "Example usage:",
7132 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7136 "name": "ShowHopperHistory",
7137 "group": "Cm_Hopper_History",
7138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7140 "filename": "server/api/cmHopperHistory/index.js",
7141 "groupTitle": "Cm_Hopper_History"
7145 "url": "/api/cm/hopper_history/{id}",
7146 "title": "Update a single hopper history",
7149 "title": "Example usage:",
7150 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7155 "group": "Cm_Hopper_History",
7156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7158 "filename": "server/api/cmHopperHistory/index.js",
7159 "groupTitle": "Cm_Hopper_History"
7163 "url": "/api/cm/hopper/{id}",
7164 "title": "Delete Hopper",
7167 "title": "Example usage:",
7168 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7173 "group": "Cm_Hopper",
7174 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7176 "filename": "server/api/cmHopper/index.js",
7177 "groupTitle": "Cm_Hopper"
7181 "url": "/api/cm/hopper/opencontacts",
7182 "title": "Gets Open Contacts",
7185 "title": "Example usage:",
7186 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7190 "name": "getOpenContacts",
7191 "group": "Cm_Hopper",
7192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7194 "filename": "server/api/cmHopper/index.js",
7195 "groupTitle": "Cm_Hopper"
7199 "url": "/api/cm/hopper/preview",
7200 "title": "Gets Preview Dialer Contacts",
7203 "title": "Example usage:",
7204 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7208 "name": "getPreview",
7209 "group": "Cm_Hopper",
7210 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7212 "filename": "server/api/cmHopper/index.js",
7213 "groupTitle": "Cm_Hopper"
7217 "url": "/api/cm/hopper/{id}",
7218 "title": "Update an existing Hopper",
7221 "title": "Example usage:",
7222 "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",
7226 "name": "updateHopper",
7227 "group": "Cm_Hopper",
7228 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7230 "filename": "server/api/cmHopper/index.js",
7231 "groupTitle": "Cm_Hopper"
7235 "url": "/api/cm/lists",
7236 "title": "Creates a new List",
7239 "title": "Example usage:",
7240 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7244 "name": "CreateLists",
7245 "group": "Cm_Lists",
7260 "field": "description",
7267 "field": "dialPrefix",
7273 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7275 "filename": "server/api/cmList/index.js",
7276 "groupTitle": "Cm_Lists"
7280 "url": "/api/cm/lists/{id}",
7281 "title": "Deletes a List",
7284 "title": "Example usage:",
7285 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7289 "name": "DeleteLists",
7290 "group": "Cm_Lists",
7291 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7293 "filename": "server/api/cmList/index.js",
7294 "groupTitle": "Cm_Lists"
7298 "url": "/api/cm/lists/describe",
7299 "title": "Gets table info about Lists",
7302 "title": "Example usage:",
7303 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7307 "name": "DescribeLists",
7308 "group": "Cm_Lists",
7309 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7311 "filename": "server/api/cmList/index.js",
7312 "groupTitle": "Cm_Lists"
7316 "url": "/api/cm/lists/{id}/users",
7317 "title": "Gets agents from list",
7320 "title": "Example usage:",
7321 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7325 "name": "GetAgents",
7326 "group": "Cm_Lists",
7327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7329 "filename": "server/api/cmList/index.js",
7330 "groupTitle": "Cm_Lists"
7334 "url": "/api/cm/lists",
7335 "title": "Gets a list of Lists",
7338 "title": "Example usage:",
7339 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7344 "group": "Cm_Lists",
7345 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7347 "filename": "server/api/cmList/index.js",
7348 "groupTitle": "Cm_Lists"
7352 "url": "/api/cm/lists/{id}/users",
7353 "title": "Removes agents from a list",
7356 "title": "Example usage:",
7357 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7361 "name": "RemoveAgents",
7362 "group": "Cm_Lists",
7363 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7365 "filename": "server/api/cmList/index.js",
7366 "groupTitle": "Cm_Lists"
7370 "url": "/api/cm/lists/{id}/dispositions",
7371 "title": "Removes dispositions from account",
7374 "title": "Example usage:",
7375 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7379 "name": "RemoveDispositions",
7380 "group": "Cm_Lists",
7381 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7383 "filename": "server/api/cmList/index.js",
7384 "groupTitle": "Cm_Lists"
7388 "url": "/api/cm/lists/{id}",
7389 "title": "Gets a single List",
7392 "title": "Example usage:",
7393 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7397 "name": "ShowLists",
7398 "group": "Cm_Lists",
7399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7401 "filename": "server/api/cmList/index.js",
7402 "groupTitle": "Cm_Lists"
7406 "url": "/api/cm/lists/{id}/users",
7407 "title": "Adds agents to a list",
7410 "title": "Example usage:",
7411 "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",
7415 "name": "addAgents",
7416 "group": "Cm_Lists",
7417 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7419 "filename": "server/api/cmList/index.js",
7420 "groupTitle": "Cm_Lists"
7424 "url": "/api/cm/lists/{id}/contacts",
7425 "title": "Creates new contacts",
7428 "title": "Example usage:",
7429 "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",
7433 "name": "addContacts",
7434 "group": "Cm_Lists",
7442 "field": "firstName",
7449 "field": "lastName",
7463 "field": "postalCode",
7484 "field": "dateOfBirth",
7491 "field": "description",
7533 "field": "facebook",
7589 "field": "telegram",
7603 "field": "priority",
7610 "field": "scheduledat",
7616 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7618 "filename": "server/api/cmList/index.js",
7619 "groupTitle": "Cm_Lists"
7623 "url": "/api/cm/lists/{id}/fields",
7624 "title": "Creates a new custom field",
7627 "title": "Example usage:",
7628 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7632 "name": "addCustomField",
7633 "group": "Cm_Lists",
7634 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7636 "filename": "server/api/cmList/index.js",
7637 "groupTitle": "Cm_Lists"
7641 "url": "/api/cm/lists/{id}/dispositions",
7642 "title": "Creates new disposition",
7645 "title": "Example usage:",
7646 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7650 "name": "addDisposition",
7651 "group": "Cm_Lists",
7678 "field": "description",
7684 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7686 "filename": "server/api/cmList/index.js",
7687 "groupTitle": "Cm_Lists"
7691 "url": "/api/cm/lists/{id}/contacts",
7692 "title": "Gets List Contacts",
7695 "title": "Example usage:",
7696 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7700 "name": "getContacts",
7701 "group": "Cm_Lists",
7702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7704 "filename": "server/api/cmList/index.js",
7705 "groupTitle": "Cm_Lists"
7709 "url": "/api/cm/lists/{id}/fields",
7710 "title": "Gets Custom Fields",
7713 "title": "Example usage:",
7714 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7718 "name": "getCustomFields",
7719 "group": "Cm_Lists",
7720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7722 "filename": "server/api/cmList/index.js",
7723 "groupTitle": "Cm_Lists"
7727 "url": "/api/cm/lists/{id}/dispositions",
7728 "title": "Gets list dispositions",
7731 "title": "Example usage:",
7732 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7736 "name": "getDispositions",
7737 "group": "Cm_Lists",
7738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7740 "filename": "server/api/cmList/index.js",
7741 "groupTitle": "Cm_Lists"
7745 "url": "/api/cm/lists/{id}/contacts/csv",
7746 "title": "Gets CSV List Contacts",
7749 "title": "Example usage:",
7750 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7755 "group": "Cm_Lists",
7756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7758 "filename": "server/api/cmList/index.js",
7759 "groupTitle": "Cm_Lists"
7763 "url": "/api/cm/lists/{id}",
7764 "title": "Update an existing List",
7767 "title": "Example usage:",
7768 "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",
7772 "name": "updateLists",
7773 "group": "Cm_Lists",
7774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7776 "filename": "server/api/cmList/index.js",
7777 "groupTitle": "Cm_Lists"
7781 "url": "/api/cm/contacts/upload/:id",
7782 "title": "Import new contacts by csv",
7785 "title": "Example usage:",
7786 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7791 "group": "Cm_contacts",
7792 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7794 "filename": "server/api/cmContact/index.js",
7795 "groupTitle": "Cm_contacts"
7799 "url": "/api/cm/contacts/upload",
7800 "title": "Upload csv",
7803 "title": "Example usage:",
7804 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7809 "group": "Cm_contacts",
7810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7812 "filename": "server/api/cmContact/index.js",
7813 "groupTitle": "Cm_contacts"
7817 "url": "/api/cm/contacts/csv",
7818 "title": "Create new contacts by csv",
7821 "title": "Example usage:",
7822 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7826 "name": "uploadCsv",
7827 "group": "Cm_contacts",
7828 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7830 "filename": "server/api/cmContact/index.js",
7831 "groupTitle": "Cm_contacts"
7835 "url": "/api/conditions/{id}",
7836 "title": "Deletes a Condition",
7839 "title": "Example usage:",
7840 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7844 "name": "DeleteConditions",
7845 "group": "Conditions",
7846 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7848 "filename": "server/api/condition/index.js",
7849 "groupTitle": "Conditions"
7853 "url": "/api/conditions/{id}",
7854 "title": "Update an existing Condition",
7857 "title": "Example usage:",
7858 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7862 "name": "updateConditions",
7863 "group": "Conditions",
7864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7866 "filename": "server/api/condition/index.js",
7867 "groupTitle": "Conditions"
7871 "url": "/api/cm/custom_field",
7872 "title": "Create a new custom field",
7875 "title": "Example usage:",
7876 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7880 "name": "CreateCustomField",
7881 "group": "Custom_Fields",
7882 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7884 "filename": "server/api/cmCustomField/index.js",
7885 "groupTitle": "Custom_Fields"
7889 "url": "/api/dashboards/items",
7890 "title": "Create dasboard item",
7893 "title": "Example usage:",
7894 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7899 "group": "Dashboard_Items",
7900 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7902 "filename": "server/api/dashboardItem/index.js",
7903 "groupTitle": "Dashboard_Items"
7907 "url": "/api/dashboards/items/{id}",
7908 "title": "Deletes a Dashboard Item",
7911 "title": "Example usage:",
7912 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7916 "name": "DeleteDashboard_Items",
7917 "group": "Dashboard_Items",
7918 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7920 "filename": "server/api/dashboardItem/index.js",
7921 "groupTitle": "Dashboard_Items"
7925 "url": "/api/dashboards/items/{id}",
7926 "title": "Gets a single Dashboard Item",
7929 "title": "Example usage:",
7930 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7934 "name": "ShowDashboard_Items",
7935 "group": "Dashboard_Items",
7936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7938 "filename": "server/api/dashboardItem/index.js",
7939 "groupTitle": "Dashboard_Items"
7943 "url": "/api/dashboards/items/{id}",
7944 "title": "Update an existing item",
7947 "title": "Example usage:",
7948 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7953 "group": "Dashboard_Items",
7954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7956 "filename": "server/api/dashboardItem/index.js",
7957 "groupTitle": "Dashboard_Items"
7961 "url": "/api/dashboards/clone",
7962 "title": "Clone an existing Dashboard",
7965 "title": "Example usage:",
7966 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7970 "name": "CloneDashboards",
7971 "group": "Dashboards",
7972 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7974 "filename": "server/api/dashboard/index.js",
7975 "groupTitle": "Dashboards"
7979 "url": "/api/dashboards",
7980 "title": "Creates a new Dashboard",
7983 "title": "Example usage:",
7984 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7988 "name": "CreateDashboards",
7989 "group": "Dashboards",
8004 "field": "description",
8010 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8012 "filename": "server/api/dashboard/index.js",
8013 "groupTitle": "Dashboards"
8017 "url": "/api/dashboards/{id}",
8018 "title": "Deletes a Dashboard",
8021 "title": "Example usage:",
8022 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8026 "name": "DeleteDashboards",
8027 "group": "Dashboards",
8028 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8030 "filename": "server/api/dashboard/index.js",
8031 "groupTitle": "Dashboards"
8035 "url": "/api/dashboards",
8036 "title": "Gets a list of Dashboards",
8039 "title": "Example usage:",
8040 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8044 "name": "GetDashboards",
8045 "group": "Dashboards",
8046 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8048 "filename": "server/api/dashboard/index.js",
8049 "groupTitle": "Dashboards"
8053 "url": "/api/dashboards/{id}",
8054 "title": "Gets a single Dashboard",
8057 "title": "Example usage:",
8058 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8062 "name": "ShowDashboards",
8063 "group": "Dashboards",
8064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8066 "filename": "server/api/dashboard/index.js",
8067 "groupTitle": "Dashboards"
8071 "url": "/api/dashboards/{id}/items",
8072 "title": "Creates new item",
8075 "title": "Example usage:",
8076 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8081 "group": "Dashboards",
8082 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8084 "filename": "server/api/dashboard/index.js",
8085 "groupTitle": "Dashboards"
8089 "url": "/api/dashboards/{id}/items",
8090 "title": "Gets items",
8093 "title": "Example usage:",
8094 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8099 "group": "Dashboards",
8100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8102 "filename": "server/api/dashboard/index.js",
8103 "groupTitle": "Dashboards"
8107 "url": "/api/dashboards/{id}",
8108 "title": "Update an existing Dashboard",
8111 "title": "Example usage:",
8112 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8116 "name": "updateDashboards",
8117 "group": "Dashboards",
8118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8120 "filename": "server/api/dashboard/index.js",
8121 "groupTitle": "Dashboards"
8125 "url": "/api/integrations/desk/accounts",
8126 "title": "Creates a new Desk Account",
8129 "title": "Example usage:",
8130 "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",
8134 "name": "CreateDesk_Accounts",
8135 "group": "Desk_Accounts",
8150 "field": "description",
8157 "field": "username",
8164 "field": "remoteUri",
8174 "field": "authType",
8181 "field": "password",
8188 "field": "consumerKey",
8195 "field": "consumerSecret",
8209 "field": "tokenSecret",
8216 "field": "serverUrl",
8223 "\"integrationTab\"",
8233 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8235 "filename": "server/api/intDeskAccount/index.js",
8236 "groupTitle": "Desk_Accounts"
8240 "url": "/api/integrations/desk/accounts/{id}",
8241 "title": "Deletes a Desk Account",
8244 "title": "Example usage:",
8245 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8249 "name": "DeleteDesk_Accounts",
8250 "group": "Desk_Accounts",
8251 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8253 "filename": "server/api/intDeskAccount/index.js",
8254 "groupTitle": "Desk_Accounts"
8258 "url": "/api/integrations/desk/accounts",
8259 "title": "Gets a list of Desk Accounts",
8262 "title": "Example usage:",
8263 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8267 "name": "GetDesk_Accounts",
8268 "group": "Desk_Accounts",
8269 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8271 "filename": "server/api/intDeskAccount/index.js",
8272 "groupTitle": "Desk_Accounts"
8276 "url": "/api/integrations/desk/accounts/{id}",
8277 "title": "Gets a single Desk Account",
8280 "title": "Example usage:",
8281 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8285 "name": "ShowDesk_Accounts",
8286 "group": "Desk_Accounts",
8287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8289 "filename": "server/api/intDeskAccount/index.js",
8290 "groupTitle": "Desk_Accounts"
8294 "url": "/api/integrations/desk/accounts/{id}/configurations",
8295 "title": "Creates new configuration",
8298 "title": "Example usage:",
8299 "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",
8303 "name": "addConfiguration",
8304 "group": "Desk_Accounts",
8305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8307 "filename": "server/api/intDeskAccount/index.js",
8308 "groupTitle": "Desk_Accounts"
8312 "url": "/api/integrations/desk/accounts/{id}/configurations",
8313 "title": "Gets account configurations",
8316 "title": "Example usage:",
8317 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8321 "name": "getConfigurations",
8322 "group": "Desk_Accounts",
8323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8325 "filename": "server/api/intDeskAccount/index.js",
8326 "groupTitle": "Desk_Accounts"
8330 "url": "/api/integrations/desk/accounts/{id}/fields",
8331 "title": "Gets account fields",
8334 "title": "Example usage:",
8335 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8339 "name": "getFields",
8340 "group": "Desk_Accounts",
8341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8343 "filename": "server/api/intDeskAccount/index.js",
8344 "groupTitle": "Desk_Accounts"
8348 "url": "/api/integrations/desk/accounts/{id}",
8349 "title": "Update an existing Desk Account",
8352 "title": "Example usage:",
8353 "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",
8357 "name": "updateDesk_Accounts",
8358 "group": "Desk_Accounts",
8359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8361 "filename": "server/api/intDeskAccount/index.js",
8362 "groupTitle": "Desk_Accounts"
8366 "url": "/api/integrations/desk/configurations",
8367 "title": "Creates a new Desk Configuration",
8370 "title": "Example usage:",
8371 "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",
8375 "name": "CreateDesk_Configurations",
8376 "group": "Desk_Configurations",
8391 "field": "description",
8397 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8399 "filename": "server/api/intDeskConfiguration/index.js",
8400 "groupTitle": "Desk_Configurations"
8404 "url": "/api/integrations/desk/configurations/{id}",
8405 "title": "Deletes a Desk Configuration",
8408 "title": "Example usage:",
8409 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8413 "name": "DeleteDesk_Configurations",
8414 "group": "Desk_Configurations",
8415 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8417 "filename": "server/api/intDeskConfiguration/index.js",
8418 "groupTitle": "Desk_Configurations"
8422 "url": "/api/integrations/desk/configurations",
8423 "title": "Gets a list of Desk Configurations",
8426 "title": "Example usage:",
8427 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8431 "name": "GetDesk_Configurations",
8432 "group": "Desk_Configurations",
8433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8435 "filename": "server/api/intDeskConfiguration/index.js",
8436 "groupTitle": "Desk_Configurations"
8440 "url": "/api/integrations/desk/configurations/{id}",
8441 "title": "Gets a single Desk Configuration",
8444 "title": "Example usage:",
8445 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8449 "name": "ShowDesk_Configurations",
8450 "group": "Desk_Configurations",
8451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8453 "filename": "server/api/intDeskConfiguration/index.js",
8454 "groupTitle": "Desk_Configurations"
8458 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8459 "title": "Gets configurations descriptions",
8462 "title": "Example usage:",
8463 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8467 "name": "getDescriptions",
8468 "group": "Desk_Configurations",
8469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8471 "filename": "server/api/intDeskConfiguration/index.js",
8472 "groupTitle": "Desk_Configurations"
8476 "url": "/api/integrations/desk/configurations/{id}/fields",
8477 "title": "Gets configurations fields",
8480 "title": "Example usage:",
8481 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8485 "name": "getFields",
8486 "group": "Desk_Configurations",
8487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8489 "filename": "server/api/intDeskConfiguration/index.js",
8490 "groupTitle": "Desk_Configurations"
8494 "url": "/api/integrations/desk/configurations/{id}/subjects",
8495 "title": "Gets configurations subjects",
8498 "title": "Example usage:",
8499 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8503 "name": "getSubjects",
8504 "group": "Desk_Configurations",
8505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8507 "filename": "server/api/intDeskConfiguration/index.js",
8508 "groupTitle": "Desk_Configurations"
8512 "url": "/api/integrations/desk/configurations/{id}/tags",
8513 "title": "Gets configurations tags",
8516 "title": "Example usage:",
8517 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8522 "group": "Desk_Configurations",
8523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8525 "filename": "server/api/intDeskConfiguration/index.js",
8526 "groupTitle": "Desk_Configurations"
8530 "url": "/api/integrations/desk/configurations/{id}/tags",
8531 "title": "Sets new tags",
8534 "title": "Example usage:",
8535 "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",
8540 "group": "Desk_Configurations",
8541 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8543 "filename": "server/api/intDeskConfiguration/index.js",
8544 "groupTitle": "Desk_Configurations"
8548 "url": "/api/integrations/desk/configurations/{id}",
8549 "title": "Update an existing Desk Configuration",
8552 "title": "Example usage:",
8553 "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",
8557 "name": "updateDesk_Configurations",
8558 "group": "Desk_Configurations",
8559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8561 "filename": "server/api/intDeskConfiguration/index.js",
8562 "groupTitle": "Desk_Configurations"
8566 "url": "/api/integrations/desk/fields",
8567 "title": "Creates a new Desk Field",
8570 "title": "Example usage:",
8571 "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",
8575 "name": "CreateDesk_Fields",
8576 "group": "Desk_Fields",
8586 "\"customVariable\"",
8614 "\"customVariable\""
8624 "field": "keyContent",
8638 "field": "nameField",
8645 "field": "customField",
8652 "field": "variableName",
8658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8660 "filename": "server/api/intDeskField/index.js",
8661 "groupTitle": "Desk_Fields"
8665 "url": "/api/integrations/desk/fields/{id}",
8666 "title": "Deletes a Desk Field",
8669 "title": "Example usage:",
8670 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8674 "name": "DeleteDesk_Fields",
8675 "group": "Desk_Fields",
8676 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8678 "filename": "server/api/intDeskField/index.js",
8679 "groupTitle": "Desk_Fields"
8683 "url": "/api/integrations/desk/fields",
8684 "title": "Gets a list of Desk Fields",
8687 "title": "Example usage:",
8688 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8692 "name": "GetDesk_Fields",
8693 "group": "Desk_Fields",
8694 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8696 "filename": "server/api/intDeskField/index.js",
8697 "groupTitle": "Desk_Fields"
8701 "url": "/api/integrations/desk/fields/{id}",
8702 "title": "Gets a single Desk Field",
8705 "title": "Example usage:",
8706 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8710 "name": "ShowDesk_Fields",
8711 "group": "Desk_Fields",
8712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8714 "filename": "server/api/intDeskField/index.js",
8715 "groupTitle": "Desk_Fields"
8719 "url": "/api/integrations/desk/fields/{id}",
8720 "title": "Update an existing Desk Field",
8723 "title": "Example usage:",
8724 "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",
8728 "name": "updateDesk_Fields",
8729 "group": "Desk_Fields",
8730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8732 "filename": "server/api/intDeskField/index.js",
8733 "groupTitle": "Desk_Fields"
8737 "url": "/api/dispositions",
8738 "title": "Creates a new Disposition",
8741 "title": "Example usage:",
8742 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8746 "name": "CreateDispositions",
8747 "group": "Dispositions",
8774 "field": "description",
8780 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8782 "filename": "server/api/disposition/index.js",
8783 "groupTitle": "Dispositions"
8787 "url": "/api/dispositions/{id}",
8788 "title": "Deletes a Disposition",
8791 "title": "Example usage:",
8792 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8796 "name": "DeleteDispositions",
8797 "group": "Dispositions",
8798 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8800 "filename": "server/api/disposition/index.js",
8801 "groupTitle": "Dispositions"
8805 "url": "/api/dispositions",
8806 "title": "Gets a list of Dispositions",
8809 "title": "Example usage:",
8810 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8814 "name": "GetDispositions",
8815 "group": "Dispositions",
8816 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8818 "filename": "server/api/disposition/index.js",
8819 "groupTitle": "Dispositions"
8823 "url": "/api/dispositions/{id}",
8824 "title": "Gets a single Disposition",
8827 "title": "Example usage:",
8828 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8832 "name": "ShowDispositions",
8833 "group": "Dispositions",
8834 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8836 "filename": "server/api/disposition/index.js",
8837 "groupTitle": "Dispositions"
8841 "url": "/api/dispositions/{id}",
8842 "title": "Update an existing Disposition",
8845 "title": "Example usage:",
8846 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8850 "name": "updateDispositions",
8851 "group": "Dispositions",
8852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8854 "filename": "server/api/disposition/index.js",
8855 "groupTitle": "Dispositions"
8859 "url": "/api/integrations/dynamics365/accounts",
8860 "title": "Creates a new Dynamics365 Account",
8863 "title": "Example usage:",
8864 "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",
8868 "name": "CreateDynamics365_Accounts",
8869 "group": "Dynamics365_Accounts",
8884 "field": "username",
8891 "field": "password",
8898 "field": "remoteUri",
8905 "field": "tenantId",
8912 "field": "clientId",
8919 "field": "clientSecret",
8926 "field": "serverUrl",
8933 "field": "description",
8939 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8941 "filename": "server/api/intDynamics365Account/index.js",
8942 "groupTitle": "Dynamics365_Accounts"
8946 "url": "/api/integrations/dynamics365/accounts/{id}",
8947 "title": "Deletes a Dynamics365 Account",
8950 "title": "Example usage:",
8951 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8955 "name": "DeleteDynamics365_Accounts",
8956 "group": "Dynamics365_Accounts",
8957 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8959 "filename": "server/api/intDynamics365Account/index.js",
8960 "groupTitle": "Dynamics365_Accounts"
8964 "url": "/api/integrations/dynamics365/accounts",
8965 "title": "Gets a list of Dynamics365 Accounts",
8968 "title": "Example usage:",
8969 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8973 "name": "GetDynamics365_Accounts",
8974 "group": "Dynamics365_Accounts",
8975 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8977 "filename": "server/api/intDynamics365Account/index.js",
8978 "groupTitle": "Dynamics365_Accounts"
8982 "url": "/api/integrations/dynamics365/accounts/{id}",
8983 "title": "Gets a single Dynamics365 Account",
8986 "title": "Example usage:",
8987 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8991 "name": "ShowDynamics365_Accounts",
8992 "group": "Dynamics365_Accounts",
8993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8995 "filename": "server/api/intDynamics365Account/index.js",
8996 "groupTitle": "Dynamics365_Accounts"
9000 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9001 "title": "Creates new configuration",
9004 "title": "Example usage:",
9005 "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",
9009 "name": "addConfiguration",
9010 "group": "Dynamics365_Accounts",
9011 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9013 "filename": "server/api/intDynamics365Account/index.js",
9014 "groupTitle": "Dynamics365_Accounts"
9018 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9019 "title": "Gets account configurations",
9022 "title": "Example usage:",
9023 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9027 "name": "getConfigurations",
9028 "group": "Dynamics365_Accounts",
9029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9031 "filename": "server/api/intDynamics365Account/index.js",
9032 "groupTitle": "Dynamics365_Accounts"
9036 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9037 "title": "Gets account fields",
9040 "title": "Example usage:",
9041 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9045 "name": "getFields",
9046 "group": "Dynamics365_Accounts",
9047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9049 "filename": "server/api/intDynamics365Account/index.js",
9050 "groupTitle": "Dynamics365_Accounts"
9054 "url": "/api/integrations/dynamics365/accounts/{id}",
9055 "title": "Update an existing Dynamics365 Account",
9058 "title": "Example usage:",
9059 "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",
9063 "name": "updateDynamics365_Accounts",
9064 "group": "Dynamics365_Accounts",
9065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9067 "filename": "server/api/intDynamics365Account/index.js",
9068 "groupTitle": "Dynamics365_Accounts"
9072 "url": "/api/integrations/dynamics365/configurations",
9073 "title": "Creates a new Dynamics365 Configuration",
9076 "title": "Example usage:",
9077 "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",
9081 "name": "CreateDynamics365_Configurations",
9082 "group": "Dynamics365_Configurations",
9097 "field": "description",
9108 "field": "ticketType",
9114 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9116 "filename": "server/api/intDynamics365Configuration/index.js",
9117 "groupTitle": "Dynamics365_Configurations"
9121 "url": "/api/integrations/dynamics365/configurations/{id}",
9122 "title": "Deletes a Dynamics365 Configuration",
9125 "title": "Example usage:",
9126 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9130 "name": "DeleteDynamics365_Configurations",
9131 "group": "Dynamics365_Configurations",
9132 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9134 "filename": "server/api/intDynamics365Configuration/index.js",
9135 "groupTitle": "Dynamics365_Configurations"
9139 "url": "/api/integrations/dynamics365/configurations",
9140 "title": "Gets a list of Dynamics365 Configurations",
9143 "title": "Example usage:",
9144 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9148 "name": "GetDynamics365_Configurations",
9149 "group": "Dynamics365_Configurations",
9150 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9152 "filename": "server/api/intDynamics365Configuration/index.js",
9153 "groupTitle": "Dynamics365_Configurations"
9157 "url": "/api/integrations/dynamics365/configurations/{id}",
9158 "title": "Gets a single Dynamics365 Configuration",
9161 "title": "Example usage:",
9162 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9166 "name": "ShowDynamics365_Configurations",
9167 "group": "Dynamics365_Configurations",
9168 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9170 "filename": "server/api/intDynamics365Configuration/index.js",
9171 "groupTitle": "Dynamics365_Configurations"
9175 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9176 "title": "Gets configurations descriptions",
9179 "title": "Example usage:",
9180 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9184 "name": "getDescriptions",
9185 "group": "Dynamics365_Configurations",
9186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9188 "filename": "server/api/intDynamics365Configuration/index.js",
9189 "groupTitle": "Dynamics365_Configurations"
9193 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9194 "title": "Gets configurations fields",
9197 "title": "Example usage:",
9198 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9202 "name": "getFields",
9203 "group": "Dynamics365_Configurations",
9204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9206 "filename": "server/api/intDynamics365Configuration/index.js",
9207 "groupTitle": "Dynamics365_Configurations"
9211 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9212 "title": "Gets configurations subjects",
9215 "title": "Example usage:",
9216 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9220 "name": "getSubjects",
9221 "group": "Dynamics365_Configurations",
9222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9224 "filename": "server/api/intDynamics365Configuration/index.js",
9225 "groupTitle": "Dynamics365_Configurations"
9229 "url": "/api/integrations/dynamics365/configurations/{id}",
9230 "title": "Update an existing Dynamics365 Configuration",
9233 "title": "Example usage:",
9234 "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",
9238 "name": "updateDynamics365_Configurations",
9239 "group": "Dynamics365_Configurations",
9240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9242 "filename": "server/api/intDynamics365Configuration/index.js",
9243 "groupTitle": "Dynamics365_Configurations"
9247 "url": "/api/integrations/dynamics365/fields",
9248 "title": "Creates a new Dynamics365 Field",
9251 "title": "Example usage:",
9252 "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",
9256 "name": "CreateDynamics365_Fields",
9257 "group": "Dynamics365_Fields",
9267 "\"customVariable\"",
9295 "\"customVariable\""
9305 "field": "keyContent",
9319 "field": "nameField",
9326 "field": "customField",
9333 "field": "variableName",
9339 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9341 "filename": "server/api/intDynamics365Field/index.js",
9342 "groupTitle": "Dynamics365_Fields"
9346 "url": "/api/integrations/dynamics365/fields/{id}",
9347 "title": "Deletes a Dynamics365 Field",
9350 "title": "Example usage:",
9351 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9355 "name": "DeleteDynamics365_Fields",
9356 "group": "Dynamics365_Fields",
9357 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9359 "filename": "server/api/intDynamics365Field/index.js",
9360 "groupTitle": "Dynamics365_Fields"
9364 "url": "/api/integrations/dynamics365/fields",
9365 "title": "Gets a list of Dynamics365 Fields",
9368 "title": "Example usage:",
9369 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9373 "name": "GetDynamics365_Fields",
9374 "group": "Dynamics365_Fields",
9375 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9377 "filename": "server/api/intDynamics365Field/index.js",
9378 "groupTitle": "Dynamics365_Fields"
9382 "url": "/api/integrations/dynamics365/fields/{id}",
9383 "title": "Gets a single Dynamics365 Field",
9386 "title": "Example usage:",
9387 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9391 "name": "ShowDynamics365_Fields",
9392 "group": "Dynamics365_Fields",
9393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9395 "filename": "server/api/intDynamics365Field/index.js",
9396 "groupTitle": "Dynamics365_Fields"
9400 "url": "/api/integrations/dynamics365/fields/{id}",
9401 "title": "Update an existing Dynamics365 Field",
9404 "title": "Example usage:",
9405 "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",
9409 "name": "updateDynamics365_Fields",
9410 "group": "Dynamics365_Fields",
9411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9413 "filename": "server/api/intDynamics365Field/index.js",
9414 "groupTitle": "Dynamics365_Fields"
9418 "url": "/api/fax/accounts/{id}/users",
9419 "title": "Add agents to a fax account",
9422 "title": "Example usage:",
9423 "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",
9427 "name": "AddAgents",
9428 "group": "Fax_Accounts",
9429 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9431 "filename": "server/api/faxAccount/index.js",
9432 "groupTitle": "Fax_Accounts"
9436 "url": "/api/fax/accounts",
9437 "title": "Creates a new Account",
9440 "title": "Example usage:",
9441 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9445 "name": "CreateAccounts",
9446 "group": "Fax_Accounts",
9461 "field": "description",
9479 "field": "headerinfo",
9486 "field": "localstationid",
9537 "field": "faxdetect",
9544 "field": "t38timeout",
9571 "field": "notificationTemplate",
9578 "field": "notificationSound",
9585 "field": "notificationShake",
9592 "field": "waitForTheAssignedAgent",
9599 "field": "queueTransfer",
9606 "field": "queueTransferTimeout",
9613 "field": "agentTransfer",
9620 "field": "agentTransferTimeout",
9627 "field": "mandatoryDispositionPauseId",
9628 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9634 "field": "mandatoryDisposition",
9635 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9642 "filename": "server/api/faxAccount/index.js",
9643 "groupTitle": "Fax_Accounts"
9647 "url": "/api/fax/accounts/{id}",
9648 "title": "Deletes a Account",
9651 "title": "Example usage:",
9652 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9656 "name": "DeleteAccounts",
9657 "group": "Fax_Accounts",
9658 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9660 "filename": "server/api/faxAccount/index.js",
9661 "groupTitle": "Fax_Accounts"
9665 "url": "/api/fax/accounts/describe",
9666 "title": "Gets table info about Accounts",
9669 "title": "Example usage:",
9670 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9674 "name": "DescribeAccounts",
9675 "group": "Fax_Accounts",
9676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9678 "filename": "server/api/faxAccount/index.js",
9679 "groupTitle": "Fax_Accounts"
9683 "url": "/api/fax/accounts",
9684 "title": "Gets a list of Accounts",
9687 "title": "Example usage:",
9688 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9692 "name": "GetAccounts",
9693 "group": "Fax_Accounts",
9694 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9696 "filename": "server/api/faxAccount/index.js",
9697 "groupTitle": "Fax_Accounts"
9701 "url": "/api/fax/accounts/{id}/users",
9702 "title": "Gets agents from fax account",
9705 "title": "Example usage:",
9706 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9710 "name": "GetAgents",
9711 "group": "Fax_Accounts",
9712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9714 "filename": "server/api/faxAccount/index.js",
9715 "groupTitle": "Fax_Accounts"
9719 "url": "/api/fax/accounts/{id}/users",
9720 "title": "Removes agents from a fax account",
9723 "title": "Example usage:",
9724 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9728 "name": "RemoveAgents",
9729 "group": "Fax_Accounts",
9730 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9732 "filename": "server/api/faxAccount/index.js",
9733 "groupTitle": "Fax_Accounts"
9737 "url": "/api/fax/accounts/{id}/canned_answers",
9738 "title": "Removes canned answers from account",
9741 "title": "Example usage:",
9742 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9746 "name": "RemoveAnswers",
9747 "group": "Fax_Accounts",
9748 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9750 "filename": "server/api/faxAccount/index.js",
9751 "groupTitle": "Fax_Accounts"
9755 "url": "/api/fax/accounts/{id}/dispositions",
9756 "title": "Removes dispositions from account",
9759 "title": "Example usage:",
9760 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9764 "name": "RemoveDispositions",
9765 "group": "Fax_Accounts",
9766 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9768 "filename": "server/api/faxAccount/index.js",
9769 "groupTitle": "Fax_Accounts"
9773 "url": "/api/fax/accounts/{id}",
9774 "title": "Gets a single Account",
9777 "title": "Example usage:",
9778 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9782 "name": "ShowAccounts",
9783 "group": "Fax_Accounts",
9784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9786 "filename": "server/api/faxAccount/index.js",
9787 "groupTitle": "Fax_Accounts"
9791 "url": "/api/fax/accounts/{id}/canned_answers",
9792 "title": "Creates new canned answer",
9795 "title": "Example usage:",
9796 "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",
9800 "name": "addAnswer",
9801 "group": "Fax_Accounts",
9823 "field": "description",
9836 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9838 "filename": "server/api/faxAccount/index.js",
9839 "groupTitle": "Fax_Accounts"
9843 "url": "/api/fax/accounts/addaccountapplications",
9844 "title": "Creates new account and applications",
9847 "title": "Example usage:",
9848 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9852 "name": "addApplications",
9853 "group": "Fax_Accounts",
9861 "field": "priority",
9882 "field": "description",
9889 "field": "interval",
9895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9897 "filename": "server/api/faxAccount/index.js",
9898 "groupTitle": "Fax_Accounts"
9902 "url": "/api/fax/accounts/{id}/applications",
9903 "title": "Creates new applications",
9906 "title": "Example usage:",
9907 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9911 "name": "addApplications",
9912 "group": "Fax_Accounts",
9920 "field": "priority",
9941 "field": "description",
9948 "field": "interval",
9954 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9956 "filename": "server/api/faxAccount/index.js",
9957 "groupTitle": "Fax_Accounts"
9961 "url": "/api/fax/accounts/{id}/dispositions",
9962 "title": "Creates new disposition",
9965 "title": "Example usage:",
9966 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9970 "name": "addDisposition",
9971 "group": "Fax_Accounts",
9998 "field": "description",
10004 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10005 "version": "0.0.0",
10006 "filename": "server/api/faxAccount/index.js",
10007 "groupTitle": "Fax_Accounts"
10011 "url": "/api/fax/accounts/{id}/interactions",
10012 "title": "Creates new interactions",
10015 "title": "Example usage:",
10016 "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",
10020 "name": "addInteraction",
10021 "group": "Fax_Accounts",
10036 "field": "closedAt",
10043 "field": "disposition",
10050 "field": "secondDisposition",
10057 "field": "thirdDisposition",
10071 "field": "read1stAt",
10089 "field": "firstMsgDirection",
10096 "field": "lastMsgAt",
10107 "field": "lastMsgDirection",
10113 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10114 "version": "0.0.0",
10115 "filename": "server/api/faxAccount/index.js",
10116 "groupTitle": "Fax_Accounts"
10120 "url": "/api/fax/accounts/{id}/canned_answers",
10121 "title": "Gets account canned answers",
10124 "title": "Example usage:",
10125 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10129 "name": "getAnswers",
10130 "group": "Fax_Accounts",
10131 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10132 "version": "0.0.0",
10133 "filename": "server/api/faxAccount/index.js",
10134 "groupTitle": "Fax_Accounts"
10138 "url": "/api/fax/accounts/{id}/applications",
10139 "title": "Gets account pplications",
10142 "title": "Example usage:",
10143 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10147 "name": "getApplications",
10148 "group": "Fax_Accounts",
10149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10150 "version": "0.0.0",
10151 "filename": "server/api/faxAccount/index.js",
10152 "groupTitle": "Fax_Accounts"
10156 "url": "/api/fax/accounts/{id}/dispositions",
10157 "title": "Gets account dispositions",
10160 "title": "Example usage:",
10161 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10165 "name": "getDispositions",
10166 "group": "Fax_Accounts",
10167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10168 "version": "0.0.0",
10169 "filename": "server/api/faxAccount/index.js",
10170 "groupTitle": "Fax_Accounts"
10174 "url": "/api/fax/accounts/{id}/interactions",
10175 "title": "Gets account interactions",
10178 "title": "Example usage:",
10179 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10183 "name": "getInteraction",
10184 "group": "Fax_Accounts",
10185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10186 "version": "0.0.0",
10187 "filename": "server/api/faxAccount/index.js",
10188 "groupTitle": "Fax_Accounts"
10192 "url": "/api/fax/accounts/{id}/messages",
10193 "title": "Gets account messages",
10196 "title": "Example usage:",
10197 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10201 "name": "getMessages",
10202 "group": "Fax_Accounts",
10203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10204 "version": "0.0.0",
10205 "filename": "server/api/faxAccount/index.js",
10206 "groupTitle": "Fax_Accounts"
10210 "url": "/api/fax/accounts/{id}/send",
10211 "title": "Send new fax",
10214 "title": "Example usage:",
10215 "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",
10220 "group": "Fax_Accounts",
10221 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10222 "version": "0.0.0",
10223 "filename": "server/api/faxAccount/index.js",
10224 "groupTitle": "Fax_Accounts"
10228 "url": "/api/fax/accounts/{id}",
10229 "title": "Update an existing Account",
10232 "title": "Example usage:",
10233 "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",
10237 "name": "updateAccounts",
10238 "group": "Fax_Accounts",
10239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10240 "version": "0.0.0",
10241 "filename": "server/api/faxAccount/index.js",
10242 "groupTitle": "Fax_Accounts"
10246 "url": "/api/fax/accounts/updateaccountapplications",
10247 "title": "Update account and applications",
10250 "title": "Example usage:",
10251 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10255 "name": "updateApplications",
10256 "group": "Fax_Accounts",
10264 "field": "priority",
10278 "field": "appdata",
10285 "field": "description",
10292 "field": "interval",
10298 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10299 "version": "0.0.0",
10300 "filename": "server/api/faxAccount/index.js",
10301 "groupTitle": "Fax_Accounts"
10305 "url": "/api/fax/applications",
10306 "title": "Creates a new Application",
10309 "title": "Example usage:",
10310 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10314 "name": "CreateApplications",
10315 "group": "Fax_Applications",
10323 "field": "priority",
10337 "field": "appdata",
10344 "field": "description",
10351 "field": "interval",
10357 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10358 "version": "0.0.0",
10359 "filename": "server/api/faxApplication/index.js",
10360 "groupTitle": "Fax_Applications"
10364 "url": "/api/fax/applications/{id}",
10365 "title": "Deletes a Application",
10368 "title": "Example usage:",
10369 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10373 "name": "DeleteApplications",
10374 "group": "Fax_Applications",
10375 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10376 "version": "0.0.0",
10377 "filename": "server/api/faxApplication/index.js",
10378 "groupTitle": "Fax_Applications"
10382 "url": "/api/fax/applications",
10383 "title": "Gets a list of Applications",
10386 "title": "Example usage:",
10387 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10391 "name": "GetApplications",
10392 "group": "Fax_Applications",
10393 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10394 "version": "0.0.0",
10395 "filename": "server/api/faxApplication/index.js",
10396 "groupTitle": "Fax_Applications"
10400 "url": "/api/fax/applications/{id}",
10401 "title": "Gets a single Application",
10404 "title": "Example usage:",
10405 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10409 "name": "ShowApplications",
10410 "group": "Fax_Applications",
10411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10412 "version": "0.0.0",
10413 "filename": "server/api/faxApplication/index.js",
10414 "groupTitle": "Fax_Applications"
10418 "url": "/api/fax/applications/{id}",
10419 "title": "Update an existing Application",
10422 "title": "Example usage:",
10423 "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",
10427 "name": "updateApplications",
10428 "group": "Fax_Applications",
10429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10430 "version": "0.0.0",
10431 "filename": "server/api/faxApplication/index.js",
10432 "groupTitle": "Fax_Applications"
10436 "url": "/api/fax/interactions/{id}/tags",
10437 "title": "Add tags to the interaction",
10440 "title": "Example usage:",
10441 "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",
10446 "group": "Fax_Interactions",
10447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10448 "version": "0.0.0",
10449 "filename": "server/api/faxInteraction/index.js",
10450 "groupTitle": "Fax_Interactions"
10454 "url": "/api/fax/interactions",
10455 "title": "Creates a new Interaction",
10458 "title": "Example usage:",
10459 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10463 "name": "CreateInteractions",
10464 "group": "Fax_Interactions",
10479 "field": "closedAt",
10486 "field": "disposition",
10493 "field": "secondDisposition",
10500 "field": "thirdDisposition",
10514 "field": "read1stAt",
10532 "field": "firstMsgDirection",
10539 "field": "lastMsgAt",
10550 "field": "lastMsgDirection",
10556 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10557 "version": "0.0.0",
10558 "filename": "server/api/faxInteraction/index.js",
10559 "groupTitle": "Fax_Interactions"
10563 "url": "/api/fax/interactions/{id}",
10564 "title": "Deletes a Interaction",
10567 "title": "Example usage:",
10568 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10572 "name": "DeleteInteractions",
10573 "group": "Fax_Interactions",
10574 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10575 "version": "0.0.0",
10576 "filename": "server/api/faxInteraction/index.js",
10577 "groupTitle": "Fax_Interactions"
10581 "url": "/api/fax/interactions/describe",
10582 "title": "Gets table info about Interactions",
10585 "title": "Example usage:",
10586 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10590 "name": "DescribeInteractions",
10591 "group": "Fax_Interactions",
10592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10593 "version": "0.0.0",
10594 "filename": "server/api/faxInteraction/index.js",
10595 "groupTitle": "Fax_Interactions"
10599 "url": "/api/fax/interactions",
10600 "title": "Gets a list of Interactions",
10603 "title": "Example usage:",
10604 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10608 "name": "GetInteractions",
10609 "group": "Fax_Interactions",
10610 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10611 "version": "0.0.0",
10612 "filename": "server/api/faxInteraction/index.js",
10613 "groupTitle": "Fax_Interactions"
10617 "url": "/api/fax/interactions/{id}/tags",
10618 "title": "Removes tags from interaction",
10621 "title": "Example usage:",
10622 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10626 "name": "RemoveTags",
10627 "group": "Fax_Interactions",
10628 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10629 "version": "0.0.0",
10630 "filename": "server/api/faxInteraction/index.js",
10631 "groupTitle": "Fax_Interactions"
10635 "url": "/api/fax/interactions/{id}",
10636 "title": "Gets a single Interaction",
10639 "title": "Example usage:",
10640 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10644 "name": "ShowInteractions",
10645 "group": "Fax_Interactions",
10646 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10647 "version": "0.0.0",
10648 "filename": "server/api/faxInteraction/index.js",
10649 "groupTitle": "Fax_Interactions"
10653 "url": "/api/fax/interactions/{id}/messages",
10654 "title": "Creates new messages",
10657 "title": "Example usage:",
10658 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10662 "name": "addMessage",
10663 "group": "Fax_Interactions",
10689 "field": "direction",
10696 "field": "failMessage",
10709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10710 "version": "0.0.0",
10711 "filename": "server/api/faxInteraction/index.js",
10712 "groupTitle": "Fax_Interactions"
10716 "url": "/api/fax/interactions/{id}/download",
10717 "title": "Get interactions",
10720 "title": "Example usage:",
10721 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10725 "name": "download",
10726 "group": "Fax_Interactions",
10727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10728 "version": "0.0.0",
10729 "filename": "server/api/faxInteraction/index.js",
10730 "groupTitle": "Fax_Interactions"
10734 "url": "/api/fax/interactions/{id}/messages",
10735 "title": "Gets interaction messages",
10738 "title": "Example usage:",
10739 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10743 "name": "getMessages",
10744 "group": "Fax_Interactions",
10745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10746 "version": "0.0.0",
10747 "filename": "server/api/faxInteraction/index.js",
10748 "groupTitle": "Fax_Interactions"
10752 "url": "/api/fax/interactions/{id}",
10753 "title": "Update an existing Interaction",
10756 "title": "Example usage:",
10757 "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",
10761 "name": "updateInteractions",
10762 "group": "Fax_Interactions",
10763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10764 "version": "0.0.0",
10765 "filename": "server/api/faxInteraction/index.js",
10766 "groupTitle": "Fax_Interactions"
10770 "url": "/api/fax/messages/{id}/download",
10771 "title": "Get message",
10774 "title": "Example usage:",
10775 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10779 "name": "download",
10780 "group": "Fax_Message",
10781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10782 "version": "0.0.0",
10783 "filename": "server/api/faxMessage/index.js",
10784 "groupTitle": "Fax_Message"
10788 "url": "/api/fax/messages/{id}",
10789 "title": "Deletes a Message",
10792 "title": "Example usage:",
10793 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10797 "name": "DeleteMessages",
10798 "group": "Fax_Messages",
10799 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10800 "version": "0.0.0",
10801 "filename": "server/api/faxMessage/index.js",
10802 "groupTitle": "Fax_Messages"
10806 "url": "/api/fax/messages/describe",
10807 "title": "Gets table info about Messages",
10810 "title": "Example usage:",
10811 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10815 "name": "DescribeMessages",
10816 "group": "Fax_Messages",
10817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10818 "version": "0.0.0",
10819 "filename": "server/api/faxMessage/index.js",
10820 "groupTitle": "Fax_Messages"
10824 "url": "/api/fax/messages",
10825 "title": "Gets a list of Messages",
10828 "title": "Example usage:",
10829 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10833 "name": "GetMessages",
10834 "group": "Fax_Messages",
10835 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10836 "version": "0.0.0",
10837 "filename": "server/api/faxMessage/index.js",
10838 "groupTitle": "Fax_Messages"
10842 "url": "/api/fax/messages/{id}",
10843 "title": "Gets a single Message",
10846 "title": "Example usage:",
10847 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10851 "name": "ShowMessages",
10852 "group": "Fax_Messages",
10853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10854 "version": "0.0.0",
10855 "filename": "server/api/faxMessage/index.js",
10856 "groupTitle": "Fax_Messages"
10860 "url": "/api/fax/messages/{id}/accept",
10861 "title": "Accepts message",
10864 "title": "Example usage:",
10865 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10869 "name": "acceptMessage",
10870 "group": "Fax_Messages",
10871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10872 "version": "0.0.0",
10873 "filename": "server/api/faxMessage/index.js",
10874 "groupTitle": "Fax_Messages"
10878 "url": "/api/fax/messages",
10879 "title": "Create message and send Fax",
10882 "title": "Example usage:",
10883 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10887 "name": "rejectMessage",
10888 "group": "Fax_Messages",
10889 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10890 "version": "0.0.0",
10891 "filename": "server/api/faxMessage/index.js",
10892 "groupTitle": "Fax_Messages"
10896 "url": "/api/fax/messages/{id}/reject",
10897 "title": "Rejects message",
10900 "title": "Example usage:",
10901 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10905 "name": "rejectMessage",
10906 "group": "Fax_Messages",
10907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10908 "version": "0.0.0",
10909 "filename": "server/api/faxMessage/index.js",
10910 "groupTitle": "Fax_Messages"
10914 "url": "/api/fax/messages/{id}",
10915 "title": "Update an existing Message",
10918 "title": "Example usage:",
10919 "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",
10923 "name": "updateMessages",
10924 "group": "Fax_Messages",
10925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10926 "version": "0.0.0",
10927 "filename": "server/api/faxMessage/index.js",
10928 "groupTitle": "Fax_Messages"
10932 "url": "/api/fax/reports/queue",
10933 "title": "Creates a new Fax Queue Report",
10936 "title": "Example usage:",
10937 "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",
10941 "name": "CreateFax_Queue_Reports",
10942 "group": "Fax_Queue_Reports",
10950 "field": "uniqueid",
10971 "field": "leaveAt",
10978 "field": "acceptAt",
10998 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10999 "version": "0.0.0",
11000 "filename": "server/api/faxQueueReport/index.js",
11001 "groupTitle": "Fax_Queue_Reports"
11005 "url": "/api/fax/reports/queue/{id}",
11006 "title": "Deletes a Fax Queue Report",
11009 "title": "Example usage:",
11010 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11014 "name": "DeleteFax_Queue_Reports",
11015 "group": "Fax_Queue_Reports",
11016 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11017 "version": "0.0.0",
11018 "filename": "server/api/faxQueueReport/index.js",
11019 "groupTitle": "Fax_Queue_Reports"
11023 "url": "/api/fax/reports/queue/describe",
11024 "title": "Gets table info about Fax Queue Reports",
11027 "title": "Example usage:",
11028 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11032 "name": "DescribeFax_Queue_Reports",
11033 "group": "Fax_Queue_Reports",
11034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11035 "version": "0.0.0",
11036 "filename": "server/api/faxQueueReport/index.js",
11037 "groupTitle": "Fax_Queue_Reports"
11041 "url": "/api/fax/reports/queue",
11042 "title": "Gets a list of Fax Queue Reports",
11045 "title": "Example usage:",
11046 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11050 "name": "GetFax_Queue_Reports",
11051 "group": "Fax_Queue_Reports",
11052 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11053 "version": "0.0.0",
11054 "filename": "server/api/faxQueueReport/index.js",
11055 "groupTitle": "Fax_Queue_Reports"
11059 "url": "/api/fax/reports/queue/{id}",
11060 "title": "Gets a single Fax Queue Report",
11063 "title": "Example usage:",
11064 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11068 "name": "ShowFax_Queue_Reports",
11069 "group": "Fax_Queue_Reports",
11070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11071 "version": "0.0.0",
11072 "filename": "server/api/faxQueueReport/index.js",
11073 "groupTitle": "Fax_Queue_Reports"
11077 "url": "/api/fax/reports/queue/{id}",
11078 "title": "Update an existing Fax Queue Report",
11081 "title": "Example usage:",
11082 "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",
11086 "name": "updateFax_Queue_Reports",
11087 "group": "Fax_Queue_Reports",
11088 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11089 "version": "0.0.0",
11090 "filename": "server/api/faxQueueReport/index.js",
11091 "groupTitle": "Fax_Queue_Reports"
11095 "url": "/api/fax/queues/{id}/users",
11096 "title": "Add agents to a queue",
11099 "title": "Example usage:",
11100 "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",
11104 "name": "AddAgents",
11105 "group": "Fax_Queues",
11106 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11107 "version": "0.0.0",
11108 "filename": "server/api/faxQueue/index.js",
11109 "groupTitle": "Fax_Queues"
11113 "url": "/api/fax/queues/{id}/teams",
11114 "title": "Add teams to a queue",
11117 "title": "Example usage:",
11118 "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",
11122 "name": "AddTeams",
11123 "group": "Fax_Queues",
11124 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11125 "version": "0.0.0",
11126 "filename": "server/api/faxQueue/index.js",
11127 "groupTitle": "Fax_Queues"
11131 "url": "/api/fax/queues",
11132 "title": "Creates a new Queue",
11135 "title": "Example usage:",
11136 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11140 "name": "CreateQueues",
11141 "group": "Fax_Queues",
11156 "field": "description",
11163 "field": "timeout",
11175 "field": "strategy",
11182 "field": "lastAgent",
11188 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11189 "version": "0.0.0",
11190 "filename": "server/api/faxQueue/index.js",
11191 "groupTitle": "Fax_Queues"
11195 "url": "/api/fax/queues/{id}",
11196 "title": "Deletes a Queue",
11199 "title": "Example usage:",
11200 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11204 "name": "DeleteQueues",
11205 "group": "Fax_Queues",
11206 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11207 "version": "0.0.0",
11208 "filename": "server/api/faxQueue/index.js",
11209 "groupTitle": "Fax_Queues"
11213 "url": "/api/fax/queues/describe",
11214 "title": "Gets table info about Queues",
11217 "title": "Example usage:",
11218 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11222 "name": "DescribeQueues",
11223 "group": "Fax_Queues",
11224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11225 "version": "0.0.0",
11226 "filename": "server/api/faxQueue/index.js",
11227 "groupTitle": "Fax_Queues"
11231 "url": "/api/fax/queues/{id}/users",
11232 "title": "Gets queue agents",
11235 "title": "Example usage:",
11236 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11240 "name": "GetAgents",
11241 "group": "Fax_Queues",
11242 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11243 "version": "0.0.0",
11244 "filename": "server/api/faxQueue/index.js",
11245 "groupTitle": "Fax_Queues"
11249 "url": "/api/fax/queues/{id}/members",
11250 "title": "GetMembers",
11253 "title": "Example usage:",
11254 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11258 "name": "GetMembers",
11259 "group": "Fax_Queues",
11260 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11261 "version": "0.0.0",
11262 "filename": "server/api/faxQueue/index.js",
11263 "groupTitle": "Fax_Queues"
11267 "url": "/api/fax/queues",
11268 "title": "Gets a list of Queues",
11271 "title": "Example usage:",
11272 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11276 "name": "GetQueues",
11277 "group": "Fax_Queues",
11278 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11279 "version": "0.0.0",
11280 "filename": "server/api/faxQueue/index.js",
11281 "groupTitle": "Fax_Queues"
11285 "url": "/api/fax/queues/{id}/teams",
11286 "title": "Gets queues list",
11289 "title": "Example usage:",
11290 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11294 "name": "GetTeams",
11295 "group": "Fax_Queues",
11296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11297 "version": "0.0.0",
11298 "filename": "server/api/faxQueue/index.js",
11299 "groupTitle": "Fax_Queues"
11303 "url": "/api/fax/queues/{id}/users",
11304 "title": "Removes agents from a queue",
11307 "title": "Example usage:",
11308 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11312 "name": "RemoveAgents",
11313 "group": "Fax_Queues",
11314 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11315 "version": "0.0.0",
11316 "filename": "server/api/faxQueue/index.js",
11317 "groupTitle": "Fax_Queues"
11321 "url": "/api/fax/queues/{id}",
11322 "title": "Gets a single Queue",
11325 "title": "Example usage:",
11326 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11330 "name": "ShowQueues",
11331 "group": "Fax_Queues",
11332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11333 "version": "0.0.0",
11334 "filename": "server/api/faxQueue/index.js",
11335 "groupTitle": "Fax_Queues"
11339 "url": "/api/fax/queues/{id}",
11340 "title": "Update an existing Queue",
11343 "title": "Example usage:",
11344 "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",
11348 "name": "updateQueues",
11349 "group": "Fax_Queues",
11350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11351 "version": "0.0.0",
11352 "filename": "server/api/faxQueue/index.js",
11353 "groupTitle": "Fax_Queues"
11357 "url": "/api/fax/reports/transfer",
11358 "title": "Creates a new Fax Transfer Report",
11361 "title": "Example usage:",
11362 "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",
11366 "name": "CreateFax_Transfer_Reports",
11367 "group": "Fax_Transfer_Reports",
11375 "field": "uniqueid",
11394 "field": "transferredAt",
11400 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11401 "version": "0.0.0",
11402 "filename": "server/api/faxTransferReport/index.js",
11403 "groupTitle": "Fax_Transfer_Reports"
11407 "url": "/api/fax/reports/transfer/{id}",
11408 "title": "Deletes a Fax Transfer Report",
11411 "title": "Example usage:",
11412 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11416 "name": "DeleteFax_Transfer_Reports",
11417 "group": "Fax_Transfer_Reports",
11418 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11419 "version": "0.0.0",
11420 "filename": "server/api/faxTransferReport/index.js",
11421 "groupTitle": "Fax_Transfer_Reports"
11425 "url": "/api/fax/reports/transfer/describe",
11426 "title": "Gets table info about Fax Transfer Reports",
11429 "title": "Example usage:",
11430 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11434 "name": "DescribeFax_Transfer_Reports",
11435 "group": "Fax_Transfer_Reports",
11436 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11437 "version": "0.0.0",
11438 "filename": "server/api/faxTransferReport/index.js",
11439 "groupTitle": "Fax_Transfer_Reports"
11443 "url": "/api/fax/reports/transfer",
11444 "title": "Gets a list of Fax Transfer Reports",
11447 "title": "Example usage:",
11448 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11452 "name": "GetFax_Transfer_Reports",
11453 "group": "Fax_Transfer_Reports",
11454 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11455 "version": "0.0.0",
11456 "filename": "server/api/faxTransferReport/index.js",
11457 "groupTitle": "Fax_Transfer_Reports"
11461 "url": "/api/fax/reports/transfer/{id}",
11462 "title": "Gets a single Fax Transfer Report",
11465 "title": "Example usage:",
11466 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11470 "name": "ShowFax_Transfer_Reports",
11471 "group": "Fax_Transfer_Reports",
11472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11473 "version": "0.0.0",
11474 "filename": "server/api/faxTransferReport/index.js",
11475 "groupTitle": "Fax_Transfer_Reports"
11479 "url": "/api/fax/reports/transfer/{id}",
11480 "title": "Update an existing Fax Transfer Report",
11483 "title": "Example usage:",
11484 "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",
11488 "name": "updateFax_Transfer_Reports",
11489 "group": "Fax_Transfer_Reports",
11490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11491 "version": "0.0.0",
11492 "filename": "server/api/faxTransferReport/index.js",
11493 "groupTitle": "Fax_Transfer_Reports"
11497 "url": "/api/integrations/freshdesk/accounts",
11498 "title": "Creates a new Freshdesk Account",
11501 "title": "Example usage:",
11502 "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",
11506 "name": "CreateFreshdesk_Accounts",
11507 "group": "Freshdesk_Accounts",
11522 "field": "description",
11529 "field": "username",
11543 "field": "remoteUri",
11550 "field": "serverUrl",
11556 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11557 "version": "0.0.0",
11558 "filename": "server/api/intFreshdeskAccount/index.js",
11559 "groupTitle": "Freshdesk_Accounts"
11563 "url": "/api/integrations/freshdesk/accounts/{id}",
11564 "title": "Deletes a Freshdesk Account",
11567 "title": "Example usage:",
11568 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11572 "name": "DeleteFreshdesk_Accounts",
11573 "group": "Freshdesk_Accounts",
11574 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11575 "version": "0.0.0",
11576 "filename": "server/api/intFreshdeskAccount/index.js",
11577 "groupTitle": "Freshdesk_Accounts"
11581 "url": "/api/integrations/freshdesk/accounts",
11582 "title": "Gets a list of Freshdesk Accounts",
11585 "title": "Example usage:",
11586 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11590 "name": "GetFreshdesk_Accounts",
11591 "group": "Freshdesk_Accounts",
11592 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11593 "version": "0.0.0",
11594 "filename": "server/api/intFreshdeskAccount/index.js",
11595 "groupTitle": "Freshdesk_Accounts"
11599 "url": "/api/integrations/freshdesk/accounts/{id}",
11600 "title": "Gets a single Freshdesk Account",
11603 "title": "Example usage:",
11604 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11608 "name": "ShowFreshdesk_Accounts",
11609 "group": "Freshdesk_Accounts",
11610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11611 "version": "0.0.0",
11612 "filename": "server/api/intFreshdeskAccount/index.js",
11613 "groupTitle": "Freshdesk_Accounts"
11617 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11618 "title": "Creates new configuration",
11621 "title": "Example usage:",
11622 "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",
11626 "name": "addConfiguration",
11627 "group": "Freshdesk_Accounts",
11628 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11629 "version": "0.0.0",
11630 "filename": "server/api/intFreshdeskAccount/index.js",
11631 "groupTitle": "Freshdesk_Accounts"
11635 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11636 "title": "Gets account configurations",
11639 "title": "Example usage:",
11640 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11644 "name": "getConfigurations",
11645 "group": "Freshdesk_Accounts",
11646 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11647 "version": "0.0.0",
11648 "filename": "server/api/intFreshdeskAccount/index.js",
11649 "groupTitle": "Freshdesk_Accounts"
11653 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11654 "title": "Gets account fields",
11657 "title": "Example usage:",
11658 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11662 "name": "getFields",
11663 "group": "Freshdesk_Accounts",
11664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11665 "version": "0.0.0",
11666 "filename": "server/api/intFreshdeskAccount/index.js",
11667 "groupTitle": "Freshdesk_Accounts"
11671 "url": "/api/integrations/freshdesk/accounts/{id}",
11672 "title": "Update an existing Freshdesk Account",
11675 "title": "Example usage:",
11676 "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",
11680 "name": "updateFreshdesk_Accounts",
11681 "group": "Freshdesk_Accounts",
11682 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11683 "version": "0.0.0",
11684 "filename": "server/api/intFreshdeskAccount/index.js",
11685 "groupTitle": "Freshdesk_Accounts"
11689 "url": "/api/integrations/freshdesk/configurations",
11690 "title": "Creates a new Freshdesk Configuration",
11693 "title": "Example usage:",
11694 "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",
11698 "name": "CreateFreshdesk_Configurations",
11699 "group": "Freshdesk_Configurations",
11714 "field": "description",
11720 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11721 "version": "0.0.0",
11722 "filename": "server/api/intFreshdeskConfiguration/index.js",
11723 "groupTitle": "Freshdesk_Configurations"
11727 "url": "/api/integrations/freshdesk/configurations/{id}",
11728 "title": "Deletes a Freshdesk Configuration",
11731 "title": "Example usage:",
11732 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11736 "name": "DeleteFreshdesk_Configurations",
11737 "group": "Freshdesk_Configurations",
11738 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11739 "version": "0.0.0",
11740 "filename": "server/api/intFreshdeskConfiguration/index.js",
11741 "groupTitle": "Freshdesk_Configurations"
11745 "url": "/api/integrations/freshdesk/configurations",
11746 "title": "Gets a list of Freshdesk Configurations",
11749 "title": "Example usage:",
11750 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11754 "name": "GetFreshdesk_Configurations",
11755 "group": "Freshdesk_Configurations",
11756 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11757 "version": "0.0.0",
11758 "filename": "server/api/intFreshdeskConfiguration/index.js",
11759 "groupTitle": "Freshdesk_Configurations"
11763 "url": "/api/integrations/freshdesk/configurations/{id}",
11764 "title": "Gets a single Freshdesk Configuration",
11767 "title": "Example usage:",
11768 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11772 "name": "ShowFreshdesk_Configurations",
11773 "group": "Freshdesk_Configurations",
11774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11775 "version": "0.0.0",
11776 "filename": "server/api/intFreshdeskConfiguration/index.js",
11777 "groupTitle": "Freshdesk_Configurations"
11781 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11782 "title": "Gets configurations descriptions",
11785 "title": "Example usage:",
11786 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11790 "name": "getDescriptions",
11791 "group": "Freshdesk_Configurations",
11792 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11793 "version": "0.0.0",
11794 "filename": "server/api/intFreshdeskConfiguration/index.js",
11795 "groupTitle": "Freshdesk_Configurations"
11799 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11800 "title": "Gets configurations fields",
11803 "title": "Example usage:",
11804 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11808 "name": "getFields",
11809 "group": "Freshdesk_Configurations",
11810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11811 "version": "0.0.0",
11812 "filename": "server/api/intFreshdeskConfiguration/index.js",
11813 "groupTitle": "Freshdesk_Configurations"
11817 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11818 "title": "Gets configurations subjects",
11821 "title": "Example usage:",
11822 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11826 "name": "getSubjects",
11827 "group": "Freshdesk_Configurations",
11828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11829 "version": "0.0.0",
11830 "filename": "server/api/intFreshdeskConfiguration/index.js",
11831 "groupTitle": "Freshdesk_Configurations"
11835 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11836 "title": "Gets configurations tags",
11839 "title": "Example usage:",
11840 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11845 "group": "Freshdesk_Configurations",
11846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11847 "version": "0.0.0",
11848 "filename": "server/api/intFreshdeskConfiguration/index.js",
11849 "groupTitle": "Freshdesk_Configurations"
11853 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11854 "title": "Sets new tags",
11857 "title": "Example usage:",
11858 "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",
11863 "group": "Freshdesk_Configurations",
11864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11865 "version": "0.0.0",
11866 "filename": "server/api/intFreshdeskConfiguration/index.js",
11867 "groupTitle": "Freshdesk_Configurations"
11871 "url": "/api/integrations/freshdesk/configurations/{id}",
11872 "title": "Update an existing Freshdesk Configuration",
11875 "title": "Example usage:",
11876 "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",
11880 "name": "updateFreshdesk_Configurations",
11881 "group": "Freshdesk_Configurations",
11882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11883 "version": "0.0.0",
11884 "filename": "server/api/intFreshdeskConfiguration/index.js",
11885 "groupTitle": "Freshdesk_Configurations"
11889 "url": "/api/integrations/freshdesk/fields",
11890 "title": "Creates a new Freshdesk Field",
11893 "title": "Example usage:",
11894 "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",
11898 "name": "CreateFreshdesk_Fields",
11899 "group": "Freshdesk_Fields",
11909 "\"customVariable\"",
11921 "field": "content",
11937 "\"customVariable\""
11940 "field": "keyType",
11947 "field": "keyContent",
11954 "field": "idField",
11961 "field": "nameField",
11968 "field": "customField",
11975 "field": "variableName",
11981 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11982 "version": "0.0.0",
11983 "filename": "server/api/intFreshdeskField/index.js",
11984 "groupTitle": "Freshdesk_Fields"
11988 "url": "/api/integrations/freshdesk/fields/{id}",
11989 "title": "Deletes a Freshdesk Field",
11992 "title": "Example usage:",
11993 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11997 "name": "DeleteFreshdesk_Fields",
11998 "group": "Freshdesk_Fields",
11999 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12000 "version": "0.0.0",
12001 "filename": "server/api/intFreshdeskField/index.js",
12002 "groupTitle": "Freshdesk_Fields"
12006 "url": "/api/integrations/freshdesk/fields",
12007 "title": "Gets a list of Freshdesk Fields",
12010 "title": "Example usage:",
12011 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12015 "name": "GetFreshdesk_Fields",
12016 "group": "Freshdesk_Fields",
12017 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12018 "version": "0.0.0",
12019 "filename": "server/api/intFreshdeskField/index.js",
12020 "groupTitle": "Freshdesk_Fields"
12024 "url": "/api/integrations/freshdesk/fields/{id}",
12025 "title": "Gets a single Freshdesk Field",
12028 "title": "Example usage:",
12029 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12033 "name": "ShowFreshdesk_Fields",
12034 "group": "Freshdesk_Fields",
12035 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12036 "version": "0.0.0",
12037 "filename": "server/api/intFreshdeskField/index.js",
12038 "groupTitle": "Freshdesk_Fields"
12042 "url": "/api/integrations/freshdesk/fields/{id}",
12043 "title": "Update an existing Freshdesk Field",
12046 "title": "Example usage:",
12047 "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",
12051 "name": "updateFreshdesk_Fields",
12052 "group": "Freshdesk_Fields",
12053 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12054 "version": "0.0.0",
12055 "filename": "server/api/intFreshdeskField/index.js",
12056 "groupTitle": "Freshdesk_Fields"
12060 "url": "/api/integrations/freshsales/accounts",
12061 "title": "Creates a new Freshsales Account",
12064 "title": "Example usage:",
12065 "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",
12069 "name": "CreateFreshsales_Accounts",
12070 "group": "Freshsales_Accounts",
12085 "field": "description",
12092 "field": "username",
12106 "field": "remoteUri",
12113 "field": "serverUrl",
12119 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12120 "version": "0.0.0",
12121 "filename": "server/api/intFreshsalesAccount/index.js",
12122 "groupTitle": "Freshsales_Accounts"
12126 "url": "/api/integrations/freshsales/accounts/{id}",
12127 "title": "Deletes a Freshsales Account",
12130 "title": "Example usage:",
12131 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12135 "name": "DeleteFreshsales_Accounts",
12136 "group": "Freshsales_Accounts",
12137 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12138 "version": "0.0.0",
12139 "filename": "server/api/intFreshsalesAccount/index.js",
12140 "groupTitle": "Freshsales_Accounts"
12144 "url": "/api/integrations/freshsales/accounts",
12145 "title": "Gets a list of Freshsales Accounts",
12148 "title": "Example usage:",
12149 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12153 "name": "GetFreshsales_Accounts",
12154 "group": "Freshsales_Accounts",
12155 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12156 "version": "0.0.0",
12157 "filename": "server/api/intFreshsalesAccount/index.js",
12158 "groupTitle": "Freshsales_Accounts"
12162 "url": "/api/integrations/freshsales/accounts/{id}",
12163 "title": "Gets a single Freshsales Account",
12166 "title": "Example usage:",
12167 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12171 "name": "ShowFreshsales_Accounts",
12172 "group": "Freshsales_Accounts",
12173 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12174 "version": "0.0.0",
12175 "filename": "server/api/intFreshsalesAccount/index.js",
12176 "groupTitle": "Freshsales_Accounts"
12180 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12181 "title": "Creates new configuration",
12184 "title": "Example usage:",
12185 "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",
12189 "name": "addConfiguration",
12190 "group": "Freshsales_Accounts",
12191 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12192 "version": "0.0.0",
12193 "filename": "server/api/intFreshsalesAccount/index.js",
12194 "groupTitle": "Freshsales_Accounts"
12198 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12199 "title": "Gets account configurations",
12202 "title": "Example usage:",
12203 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12207 "name": "getConfigurations",
12208 "group": "Freshsales_Accounts",
12209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12210 "version": "0.0.0",
12211 "filename": "server/api/intFreshsalesAccount/index.js",
12212 "groupTitle": "Freshsales_Accounts"
12216 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12217 "title": "Gets account fields",
12220 "title": "Example usage:",
12221 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12225 "name": "getFields",
12226 "group": "Freshsales_Accounts",
12227 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12228 "version": "0.0.0",
12229 "filename": "server/api/intFreshsalesAccount/index.js",
12230 "groupTitle": "Freshsales_Accounts"
12234 "url": "/api/integrations/freshsales/accounts/{id}",
12235 "title": "Update an existing Freshsales Account",
12238 "title": "Example usage:",
12239 "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",
12243 "name": "updateFreshsales_Accounts",
12244 "group": "Freshsales_Accounts",
12245 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12246 "version": "0.0.0",
12247 "filename": "server/api/intFreshsalesAccount/index.js",
12248 "groupTitle": "Freshsales_Accounts"
12252 "url": "/api/integrations/freshsales/configurations",
12253 "title": "Creates a new Freshsales Configuration",
12256 "title": "Example usage:",
12257 "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",
12261 "name": "CreateFreshsales_Configurations",
12262 "group": "Freshsales_Configurations",
12277 "field": "description",
12283 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12284 "version": "0.0.0",
12285 "filename": "server/api/intFreshsalesConfiguration/index.js",
12286 "groupTitle": "Freshsales_Configurations"
12290 "url": "/api/integrations/freshsales/configurations/{id}",
12291 "title": "Deletes a Freshsales Configuration",
12294 "title": "Example usage:",
12295 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12299 "name": "DeleteFreshsales_Configurations",
12300 "group": "Freshsales_Configurations",
12301 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12302 "version": "0.0.0",
12303 "filename": "server/api/intFreshsalesConfiguration/index.js",
12304 "groupTitle": "Freshsales_Configurations"
12308 "url": "/api/integrations/freshsales/configurations",
12309 "title": "Gets a list of Freshsales Configurations",
12312 "title": "Example usage:",
12313 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12317 "name": "GetFreshsales_Configurations",
12318 "group": "Freshsales_Configurations",
12319 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12320 "version": "0.0.0",
12321 "filename": "server/api/intFreshsalesConfiguration/index.js",
12322 "groupTitle": "Freshsales_Configurations"
12326 "url": "/api/integrations/freshsales/configurations/{id}",
12327 "title": "Gets a single Freshsales Configuration",
12330 "title": "Example usage:",
12331 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12335 "name": "ShowFreshsales_Configurations",
12336 "group": "Freshsales_Configurations",
12337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12338 "version": "0.0.0",
12339 "filename": "server/api/intFreshsalesConfiguration/index.js",
12340 "groupTitle": "Freshsales_Configurations"
12344 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12345 "title": "Gets configurations descriptions",
12348 "title": "Example usage:",
12349 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12353 "name": "getDescriptions",
12354 "group": "Freshsales_Configurations",
12355 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12356 "version": "0.0.0",
12357 "filename": "server/api/intFreshsalesConfiguration/index.js",
12358 "groupTitle": "Freshsales_Configurations"
12362 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12363 "title": "Gets configurations fields",
12366 "title": "Example usage:",
12367 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12371 "name": "getFields",
12372 "group": "Freshsales_Configurations",
12373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12374 "version": "0.0.0",
12375 "filename": "server/api/intFreshsalesConfiguration/index.js",
12376 "groupTitle": "Freshsales_Configurations"
12380 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12381 "title": "Gets configurations subjects",
12384 "title": "Example usage:",
12385 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12389 "name": "getSubjects",
12390 "group": "Freshsales_Configurations",
12391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12392 "version": "0.0.0",
12393 "filename": "server/api/intFreshsalesConfiguration/index.js",
12394 "groupTitle": "Freshsales_Configurations"
12398 "url": "/api/integrations/freshsales/configurations/{id}",
12399 "title": "Update an existing Freshsales Configuration",
12402 "title": "Example usage:",
12403 "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",
12407 "name": "updateFreshsales_Configurations",
12408 "group": "Freshsales_Configurations",
12409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12410 "version": "0.0.0",
12411 "filename": "server/api/intFreshsalesConfiguration/index.js",
12412 "groupTitle": "Freshsales_Configurations"
12416 "url": "/api/integrations/freshsales/fields",
12417 "title": "Creates a new Freshsales Field",
12420 "title": "Example usage:",
12421 "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",
12425 "name": "CreateFreshsales_Fields",
12426 "group": "Freshsales_Fields",
12436 "\"customVariable\"",
12448 "field": "content",
12464 "\"customVariable\""
12467 "field": "keyType",
12474 "field": "keyContent",
12481 "field": "idField",
12488 "field": "nameField",
12495 "field": "customField",
12502 "field": "variableName",
12508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12509 "version": "0.0.0",
12510 "filename": "server/api/intFreshsalesField/index.js",
12511 "groupTitle": "Freshsales_Fields"
12515 "url": "/api/integrations/freshsales/fields/{id}",
12516 "title": "Deletes a Freshsales Field",
12519 "title": "Example usage:",
12520 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12524 "name": "DeleteFreshsales_Fields",
12525 "group": "Freshsales_Fields",
12526 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12527 "version": "0.0.0",
12528 "filename": "server/api/intFreshsalesField/index.js",
12529 "groupTitle": "Freshsales_Fields"
12533 "url": "/api/integrations/freshsales/fields",
12534 "title": "Gets a list of Freshsales Fields",
12537 "title": "Example usage:",
12538 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12542 "name": "GetFreshsales_Fields",
12543 "group": "Freshsales_Fields",
12544 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12545 "version": "0.0.0",
12546 "filename": "server/api/intFreshsalesField/index.js",
12547 "groupTitle": "Freshsales_Fields"
12551 "url": "/api/integrations/freshsales/fields/{id}",
12552 "title": "Gets a single Freshsales Field",
12555 "title": "Example usage:",
12556 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12560 "name": "ShowFreshsales_Fields",
12561 "group": "Freshsales_Fields",
12562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12563 "version": "0.0.0",
12564 "filename": "server/api/intFreshsalesField/index.js",
12565 "groupTitle": "Freshsales_Fields"
12569 "url": "/api/integrations/freshsales/fields/{id}",
12570 "title": "Update an existing Freshsales Field",
12573 "title": "Example usage:",
12574 "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",
12578 "name": "updateFreshsales_Fields",
12579 "group": "Freshsales_Fields",
12580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12581 "version": "0.0.0",
12582 "filename": "server/api/intFreshsalesField/index.js",
12583 "groupTitle": "Freshsales_Fields"
12587 "url": "/api/campaigns/{id}/blacklists",
12588 "title": "Add blacklists to an IVR campaign",
12591 "title": "Example usage:",
12592 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12596 "name": "AddBlackLists",
12597 "group": "IVR_Campaigns",
12598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12599 "version": "0.0.0",
12600 "filename": "server/api/campaign/index.js",
12601 "groupTitle": "IVR_Campaigns"
12605 "url": "/api/campaigns/{id}/lists",
12606 "title": "Add lists to an IVR campaign",
12609 "title": "Example usage:",
12610 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12614 "name": "AddLists",
12615 "group": "IVR_Campaigns",
12616 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12617 "version": "0.0.0",
12618 "filename": "server/api/campaign/index.js",
12619 "groupTitle": "IVR_Campaigns"
12623 "url": "/api/campaigns/clone",
12624 "title": "Clone an existing IVR Campaign",
12627 "title": "Example usage:",
12628 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12632 "name": "CloneIVR_Campaigns",
12633 "group": "IVR_Campaigns",
12634 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12635 "version": "0.0.0",
12636 "filename": "server/api/campaign/index.js",
12637 "groupTitle": "IVR_Campaigns"
12641 "url": "/api/campaigns",
12642 "title": "Creates a new IVR Campaign",
12645 "title": "Example usage:",
12646 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12650 "name": "CreateIVR_Campaigns",
12651 "group": "IVR_Campaigns",
12676 "field": "description",
12684 "description": "<p>Active/Disactive Campaign</p>"
12690 "field": "limitCalls",
12691 "description": "<p>Max 200 calls.</p>"
12697 "field": "dialOriginateCallerIdName",
12704 "field": "dialOriginateCallerIdNumber",
12711 "field": "dialOriginateTimeout",
12712 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12718 "field": "dialCongestionMaxRetry",
12719 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12725 "field": "dialCongestionRetryFrequency",
12726 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12732 "field": "dialBusyMaxRetry",
12733 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12739 "field": "dialBusyRetryFrequency",
12740 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12746 "field": "dialNoAnswerMaxRetry",
12747 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12753 "field": "dialNoAnswerRetryFrequency",
12754 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12760 "field": "dialGlobalMaxRetry",
12761 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12767 "field": "dialTimezone",
12774 "field": "dialGlobalInterval",
12786 "field": "dialCheckDuplicateType",
12793 "field": "dialAMDActive",
12794 "description": "<p>Active/Disactive AMD</p>"
12800 "field": "dialAMDInitialSilence",
12801 "description": "<p>#AMD Initial Silence</p>"
12807 "field": "dialAMDGreeting",
12808 "description": "<p>#AMD Greeting</p>"
12814 "field": "dialAMDAfterGreetingSilence",
12815 "description": "<p>#AMD After Greeting Silence</p>"
12821 "field": "dialAMDTotalAnalysisTime",
12822 "description": "<p>#AMD Total Analysis Time</p>"
12828 "field": "dialAMDMinWordLength",
12829 "description": "<p>#AMD Min Word Length</p>"
12835 "field": "dialAMDBetweenWordsSilence",
12836 "description": "<p>#AMD Between Words Silence</p>"
12842 "field": "dialAMDMaximumNumberOfWords",
12843 "description": "<p>#AMD Maximum Number Of Words</p>"
12849 "field": "dialAMDSilenceThreshold",
12850 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12856 "field": "dialAMDMaximumWordLength",
12857 "description": "<p>#AMD Maximum Word Length</p>"
12867 "field": "dialOrderByScheduledAt",
12874 "field": "dialPrefix",
12881 "field": "dialRandomLastDigitCallerIdNumber",
12882 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12888 "field": "dialCutDigit",
12889 "description": "<p>Cut Digit (min:1, max:15)</p>"
12895 "field": "dialNoSuchNumberMaxRetry",
12896 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12902 "field": "dialNoSuchNumberRetryFrequency",
12903 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12909 "field": "dialDropMaxRetry",
12910 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12916 "field": "dialDropRetryFrequency",
12917 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12923 "field": "dialAbandonedMaxRetry",
12924 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12930 "field": "dialAbandonedRetryFrequency",
12931 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12937 "field": "dialMachineMaxRetry",
12938 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12944 "field": "dialMachineRetryFrequency",
12945 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12951 "field": "dialAgentRejectMaxRetry",
12952 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12958 "field": "dialAgentRejectRetryFrequency",
12959 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12964 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12965 "version": "0.0.0",
12966 "filename": "server/api/campaign/index.js",
12967 "groupTitle": "IVR_Campaigns"
12971 "url": "/api/campaigns/{id}",
12972 "title": "Deletes a IVR Campaign",
12975 "title": "Example usage:",
12976 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12980 "name": "DeleteIVR_Campaigns",
12981 "group": "IVR_Campaigns",
12982 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12983 "version": "0.0.0",
12984 "filename": "server/api/campaign/index.js",
12985 "groupTitle": "IVR_Campaigns"
12989 "url": "/api/campaigns/{id}/blacklists",
12990 "title": "Get IVR campaign blacklists",
12993 "title": "Example usage:",
12994 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12998 "name": "GetBlackLists",
12999 "group": "IVR_Campaigns",
13000 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13001 "version": "0.0.0",
13002 "filename": "server/api/campaign/index.js",
13003 "groupTitle": "IVR_Campaigns"
13007 "url": "/api/campaigns/{id}/finals",
13008 "title": "Gets IVR campaign hopper finals",
13011 "title": "Example usage:",
13012 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13016 "name": "GetHopperFinals",
13017 "group": "IVR_Campaigns",
13018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13019 "version": "0.0.0",
13020 "filename": "server/api/campaign/index.js",
13021 "groupTitle": "IVR_Campaigns"
13025 "url": "/api/campaigns/{id}/hopper_histories",
13026 "title": "Gets IVR campaign hopper histories",
13029 "title": "Example usage:",
13030 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13034 "name": "GetHopperHistories",
13035 "group": "IVR_Campaigns",
13036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13037 "version": "0.0.0",
13038 "filename": "server/api/campaign/index.js",
13039 "groupTitle": "IVR_Campaigns"
13043 "url": "/api/campaigns/{id}/hoppers",
13044 "title": "Gets IVR campaign hoppers",
13047 "title": "Example usage:",
13048 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13052 "name": "GetHoppers",
13053 "group": "IVR_Campaigns",
13054 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13055 "version": "0.0.0",
13056 "filename": "server/api/campaign/index.js",
13057 "groupTitle": "IVR_Campaigns"
13061 "url": "/api/campaigns",
13062 "title": "Gets a list of IVR Campaigns",
13065 "title": "Example usage:",
13066 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13070 "name": "GetIVR_Campaigns",
13071 "group": "IVR_Campaigns",
13072 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13073 "version": "0.0.0",
13074 "filename": "server/api/campaign/index.js",
13075 "groupTitle": "IVR_Campaigns"
13079 "url": "/api/campaigns/{id}/lists",
13080 "title": "Get IVR campaign lists",
13083 "title": "Example usage:",
13084 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13088 "name": "GetLists",
13089 "group": "IVR_Campaigns",
13090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13091 "version": "0.0.0",
13092 "filename": "server/api/campaign/index.js",
13093 "groupTitle": "IVR_Campaigns"
13097 "url": "/api/campaigns/{id}/blacklists",
13098 "title": "Remove blacklists from an IVR Campaign",
13101 "title": "Example usage:",
13102 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13106 "name": "RemoveBlackLists",
13107 "group": "IVR_Campaigns",
13108 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13109 "version": "0.0.0",
13110 "filename": "server/api/campaign/index.js",
13111 "groupTitle": "IVR_Campaigns"
13115 "url": "/api/campaigns/{id}/lists",
13116 "title": "Remove lists from an IVR Campaign",
13119 "title": "Example usage:",
13120 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13124 "name": "RemoveLists",
13125 "group": "IVR_Campaigns",
13126 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13127 "version": "0.0.0",
13128 "filename": "server/api/campaign/index.js",
13129 "groupTitle": "IVR_Campaigns"
13133 "url": "/api/campaigns/{id}",
13134 "title": "Gets a single IVR Campaign",
13137 "title": "Example usage:",
13138 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13142 "name": "ShowIVR_Campaigns",
13143 "group": "IVR_Campaigns",
13144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13145 "version": "0.0.0",
13146 "filename": "server/api/campaign/index.js",
13147 "groupTitle": "IVR_Campaigns"
13151 "url": "/api/campaigns/{id}/blacks",
13152 "title": "Gets IVR campaign hopper blacks",
13155 "title": "Example usage:",
13156 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13160 "name": "getHopperBlacks",
13161 "group": "IVR_Campaigns",
13162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13163 "version": "0.0.0",
13164 "filename": "server/api/campaign/index.js",
13165 "groupTitle": "IVR_Campaigns"
13169 "url": "/api/campaigns/{id}",
13170 "title": "Update an existing IVR Campaign",
13173 "title": "Example usage:",
13174 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13178 "name": "updateIVR_Campaigns",
13179 "group": "IVR_Campaigns",
13180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13181 "version": "0.0.0",
13182 "filename": "server/api/campaign/index.js",
13183 "groupTitle": "IVR_Campaigns"
13187 "url": "/api/integrations/reports",
13188 "title": "Creates a new Integration Report",
13191 "title": "Example usage:",
13192 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13196 "name": "CreateIntegration_Reports",
13197 "group": "Integration_Reports",
13205 "field": "integration",
13212 "field": "eventChannel",
13219 "field": "exitStatus",
13226 "field": "ticketId",
13233 "field": "integrationId",
13240 "field": "contacts",
13247 "field": "uniqueid",
13254 "field": "calleridnum",
13261 "field": "calleridname",
13275 "field": "interface",
13282 "field": "membername",
13289 "field": "agentcalledAt",
13296 "field": "agentconnectAt",
13303 "field": "holdtime",
13310 "field": "agentcomplete",
13317 "field": "agentcompleteAt",
13324 "field": "talktime",
13331 "field": "agentacw",
13338 "field": "acwtime",
13352 "field": "agentringnoanswer",
13359 "field": "agentringnoanswerAt",
13366 "field": "agentdump",
13373 "field": "agentdumpAt",
13380 "field": "lastevent",
13387 "field": "channel",
13394 "field": "channelstate",
13401 "field": "channelstatedesc",
13408 "field": "connectedlinenum",
13415 "field": "connectedlinename",
13422 "field": "language",
13429 "field": "accountcode",
13436 "field": "context",
13450 "field": "priority",
13457 "field": "destchannel",
13464 "field": "destchannelstate",
13471 "field": "destchannelstatedesc",
13478 "field": "destcalleridnum",
13485 "field": "destcalleridname",
13492 "field": "destconnectedlinenum",
13499 "field": "destconnectedlinename",
13506 "field": "destlanguage",
13513 "field": "destaccountcode",
13520 "field": "destcontext",
13527 "field": "destexten",
13534 "field": "destpriority",
13541 "field": "destuniqueid",
13548 "field": "messageId",
13555 "field": "inReplyTo",
13562 "field": "subject",
13590 "field": "attachment",
13638 "field": "appdata",
13645 "field": "projectId",
13651 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13652 "version": "0.0.0",
13653 "filename": "server/api/integrationReport/index.js",
13654 "groupTitle": "Integration_Reports"
13658 "url": "/api/integrations/reports/{id}",
13659 "title": "Deletes a Integration Report",
13662 "title": "Example usage:",
13663 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13667 "name": "DeleteIntegration_Reports",
13668 "group": "Integration_Reports",
13669 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13670 "version": "0.0.0",
13671 "filename": "server/api/integrationReport/index.js",
13672 "groupTitle": "Integration_Reports"
13676 "url": "/api/integrations/reports/describe",
13677 "title": "Gets table info about Integration Reports",
13680 "title": "Example usage:",
13681 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13685 "name": "DescribeIntegration_Reports",
13686 "group": "Integration_Reports",
13687 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13688 "version": "0.0.0",
13689 "filename": "server/api/integrationReport/index.js",
13690 "groupTitle": "Integration_Reports"
13694 "url": "/api/integrations/reports",
13695 "title": "Gets a list of Integration Reports",
13698 "title": "Example usage:",
13699 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13703 "name": "GetIntegration_Reports",
13704 "group": "Integration_Reports",
13705 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13706 "version": "0.0.0",
13707 "filename": "server/api/integrationReport/index.js",
13708 "groupTitle": "Integration_Reports"
13712 "url": "/api/integrations/reports/{id}",
13713 "title": "Gets a single Integration Report",
13716 "title": "Example usage:",
13717 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13721 "name": "ShowIntegration_Reports",
13722 "group": "Integration_Reports",
13723 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13724 "version": "0.0.0",
13725 "filename": "server/api/integrationReport/index.js",
13726 "groupTitle": "Integration_Reports"
13730 "url": "/api/integrations/reports/{id}",
13731 "title": "Update an existing Integration Report",
13734 "title": "Example usage:",
13735 "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",
13739 "name": "updateIntegration_Reports",
13740 "group": "Integration_Reports",
13741 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13742 "version": "0.0.0",
13743 "filename": "server/api/integrationReport/index.js",
13744 "groupTitle": "Integration_Reports"
13748 "url": "/api/intervals",
13749 "title": "Creates a new Interval",
13752 "title": "Example usage:",
13753 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13757 "name": "CreateIntervals",
13758 "group": "Intervals",
13773 "field": "description",
13780 "field": "interval",
13786 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13787 "version": "0.0.0",
13788 "filename": "server/api/interval/index.js",
13789 "groupTitle": "Intervals"
13793 "url": "/api/intervals/{id}",
13794 "title": "Deletes a Interval",
13797 "title": "Example usage:",
13798 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13802 "name": "DeleteIntervals",
13803 "group": "Intervals",
13804 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13805 "version": "0.0.0",
13806 "filename": "server/api/interval/index.js",
13807 "groupTitle": "Intervals"
13811 "url": "/api/intervals",
13812 "title": "Gets a list of Intervals",
13815 "title": "Example usage:",
13816 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13820 "name": "GetIntervals",
13821 "group": "Intervals",
13822 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13823 "version": "0.0.0",
13824 "filename": "server/api/interval/index.js",
13825 "groupTitle": "Intervals"
13829 "url": "/api/intervals/{id}",
13830 "title": "Gets a single Interval",
13833 "title": "Example usage:",
13834 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13838 "name": "ShowIntervals",
13839 "group": "Intervals",
13840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13841 "version": "0.0.0",
13842 "filename": "server/api/interval/index.js",
13843 "groupTitle": "Intervals"
13847 "url": "/api/intervals/{id}/sub_intervals",
13848 "title": "Creates a new sub interval",
13851 "title": "Example usage:",
13852 "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",
13856 "name": "addInterval",
13857 "group": "Intervals",
13858 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13859 "version": "0.0.0",
13860 "filename": "server/api/interval/index.js",
13861 "groupTitle": "Intervals"
13865 "url": "/api/intervals/{id}/sub_intervals/create_many",
13866 "title": "Create new sub intervals set",
13869 "title": "Example usage:",
13870 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13874 "name": "addIntervals",
13875 "group": "Intervals",
13876 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13877 "version": "0.0.0",
13878 "filename": "server/api/interval/index.js",
13879 "groupTitle": "Intervals"
13883 "url": "/api/intervals/{id}/sub_intervals",
13884 "title": "Get sub intervals set",
13887 "title": "Example usage:",
13888 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13892 "name": "getIntervals",
13893 "group": "Intervals",
13894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13895 "version": "0.0.0",
13896 "filename": "server/api/interval/index.js",
13897 "groupTitle": "Intervals"
13901 "url": "/api/intervals/{id}",
13902 "title": "Update an existing Interval",
13905 "title": "Example usage:",
13906 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13910 "name": "updateIntervals",
13911 "group": "Intervals",
13912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13913 "version": "0.0.0",
13914 "filename": "server/api/interval/index.js",
13915 "groupTitle": "Intervals"
13919 "url": "/api/jira",
13920 "title": "Creates a new issue",
13923 "title": "Example usage:",
13924 "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}",
13928 "name": "Creates_Issue",
13940 "field": "issuetype",
13947 "field": "summary",
13954 "field": "description",
13960 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13961 "version": "0.0.0",
13962 "filename": "server/api/jira/index.js",
13963 "groupTitle": "Issue"
13967 "url": "/api/jscripty/answers/reports",
13968 "title": "Creates a new Report",
13971 "title": "Example usage:",
13972 "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",
13976 "name": "CreateReports",
13977 "group": "JscriptyAnswerReport",
13985 "field": "question",
13999 "field": "membername",
14006 "field": "projectname",
14020 "field": "uniqueid",
14027 "field": "calleridname",
14034 "field": "calleridnum",
14041 "field": "questionId",
14047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14048 "version": "0.0.0",
14049 "filename": "server/api/jscriptyAnswerReport/index.js",
14050 "groupTitle": "JscriptyAnswerReport"
14054 "url": "/api/jscripty/answers/reports/{id}",
14055 "title": "Deletes a Report",
14058 "title": "Example usage:",
14059 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14063 "name": "DeleteReports",
14064 "group": "JscriptyAnswerReport",
14065 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14066 "version": "0.0.0",
14067 "filename": "server/api/jscriptyAnswerReport/index.js",
14068 "groupTitle": "JscriptyAnswerReport"
14072 "url": "/api/jscripty/answers/reports/describe",
14073 "title": "Gets table info about Reports",
14076 "title": "Example usage:",
14077 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14081 "name": "DescribeReports",
14082 "group": "JscriptyAnswerReport",
14083 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14084 "version": "0.0.0",
14085 "filename": "server/api/jscriptyAnswerReport/index.js",
14086 "groupTitle": "JscriptyAnswerReport"
14090 "url": "/api/jscripty/answers/reports",
14091 "title": "Gets a list of Reports",
14094 "title": "Example usage:",
14095 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14099 "name": "GetReports",
14100 "group": "JscriptyAnswerReport",
14101 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14102 "version": "0.0.0",
14103 "filename": "server/api/jscriptyAnswerReport/index.js",
14104 "groupTitle": "JscriptyAnswerReport"
14108 "url": "/api/jscripty/answers/reports/{id}",
14109 "title": "Gets a single Report",
14112 "title": "Example usage:",
14113 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14117 "name": "ShowReports",
14118 "group": "JscriptyAnswerReport",
14119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14120 "version": "0.0.0",
14121 "filename": "server/api/jscriptyAnswerReport/index.js",
14122 "groupTitle": "JscriptyAnswerReport"
14126 "url": "/api/jscripty/answers/reports/{id}",
14127 "title": "Update an existing Report",
14130 "title": "Example usage:",
14131 "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",
14135 "name": "updateReports",
14136 "group": "JscriptyAnswerReport",
14137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14138 "version": "0.0.0",
14139 "filename": "server/api/jscriptyAnswerReport/index.js",
14140 "groupTitle": "JscriptyAnswerReport"
14144 "url": "/api/jscripty/questions/reports",
14145 "title": "Creates a new Report",
14148 "title": "Example usage:",
14149 "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",
14153 "name": "CreateReports",
14154 "group": "JscriptyQuestionReport",
14162 "field": "question",
14176 "field": "membername",
14183 "field": "projectname",
14197 "field": "uniqueid",
14204 "field": "calleridname",
14211 "field": "calleridnum",
14218 "field": "questionId",
14224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14225 "version": "0.0.0",
14226 "filename": "server/api/jscriptyQuestionReport/index.js",
14227 "groupTitle": "JscriptyQuestionReport"
14231 "url": "/api/jscripty/questions/reports/{id}",
14232 "title": "Deletes a Report",
14235 "title": "Example usage:",
14236 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14240 "name": "DeleteReports",
14241 "group": "JscriptyQuestionReport",
14242 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14243 "version": "0.0.0",
14244 "filename": "server/api/jscriptyQuestionReport/index.js",
14245 "groupTitle": "JscriptyQuestionReport"
14249 "url": "/api/jscripty/questions/reports/describe",
14250 "title": "Gets table info about Reports",
14253 "title": "Example usage:",
14254 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14258 "name": "DescribeReports",
14259 "group": "JscriptyQuestionReport",
14260 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14261 "version": "0.0.0",
14262 "filename": "server/api/jscriptyQuestionReport/index.js",
14263 "groupTitle": "JscriptyQuestionReport"
14267 "url": "/api/jscripty/questions/reports",
14268 "title": "Gets a list of Reports",
14271 "title": "Example usage:",
14272 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14276 "name": "GetReports",
14277 "group": "JscriptyQuestionReport",
14278 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14279 "version": "0.0.0",
14280 "filename": "server/api/jscriptyQuestionReport/index.js",
14281 "groupTitle": "JscriptyQuestionReport"
14285 "url": "/api/jscripty/questions/reports/{id}",
14286 "title": "Gets a single Report",
14289 "title": "Example usage:",
14290 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14294 "name": "ShowReports",
14295 "group": "JscriptyQuestionReport",
14296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14297 "version": "0.0.0",
14298 "filename": "server/api/jscriptyQuestionReport/index.js",
14299 "groupTitle": "JscriptyQuestionReport"
14303 "url": "/api/jscripty/questions/reports/{id}",
14304 "title": "Update an existing Report",
14307 "title": "Example usage:",
14308 "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",
14312 "name": "updateReports",
14313 "group": "JscriptyQuestionReport",
14314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14315 "version": "0.0.0",
14316 "filename": "server/api/jscriptyQuestionReport/index.js",
14317 "groupTitle": "JscriptyQuestionReport"
14321 "url": "/api/jscripty/sessions/reports",
14322 "title": "Creates a new Report",
14325 "title": "Example usage:",
14326 "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",
14330 "name": "CreateReports",
14331 "group": "JscriptySessionReport",
14339 "field": "starttime",
14346 "field": "endtime",
14353 "field": "membername",
14360 "field": "projectname",
14374 "field": "uniqueid",
14381 "field": "calleridname",
14388 "field": "calleridnum",
14395 "field": "completed",
14401 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14402 "version": "0.0.0",
14403 "filename": "server/api/jscriptySessionReport/index.js",
14404 "groupTitle": "JscriptySessionReport"
14408 "url": "/api/jscripty/sessions/reports/{id}",
14409 "title": "Deletes a Report",
14412 "title": "Example usage:",
14413 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14417 "name": "DeleteReports",
14418 "group": "JscriptySessionReport",
14419 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14420 "version": "0.0.0",
14421 "filename": "server/api/jscriptySessionReport/index.js",
14422 "groupTitle": "JscriptySessionReport"
14426 "url": "/api/jscripty/sessions/reports/describe",
14427 "title": "Gets table info about Reports",
14430 "title": "Example usage:",
14431 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14435 "name": "DescribeReports",
14436 "group": "JscriptySessionReport",
14437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14438 "version": "0.0.0",
14439 "filename": "server/api/jscriptySessionReport/index.js",
14440 "groupTitle": "JscriptySessionReport"
14444 "url": "/api/jscripty/sessions/reports",
14445 "title": "Gets a list of Reports",
14448 "title": "Example usage:",
14449 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14453 "name": "GetReports",
14454 "group": "JscriptySessionReport",
14455 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14456 "version": "0.0.0",
14457 "filename": "server/api/jscriptySessionReport/index.js",
14458 "groupTitle": "JscriptySessionReport"
14462 "url": "/api/jscripty/sessions/reports/{id}",
14463 "title": "Gets a single Report",
14466 "title": "Example usage:",
14467 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14471 "name": "ShowReports",
14472 "group": "JscriptySessionReport",
14473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14474 "version": "0.0.0",
14475 "filename": "server/api/jscriptySessionReport/index.js",
14476 "groupTitle": "JscriptySessionReport"
14480 "url": "/api/jscripty/sessions/reports/{id}/questions",
14481 "title": "Gets Jscripty Session questions",
14484 "title": "Example usage:",
14485 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14489 "name": "getQuestions",
14490 "group": "JscriptySessionReport",
14491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14492 "version": "0.0.0",
14493 "filename": "server/api/jscriptySessionReport/index.js",
14494 "groupTitle": "JscriptySessionReport"
14498 "url": "/api/jscripty/sessions/reports/{id}",
14499 "title": "Update an existing Report",
14502 "title": "Example usage:",
14503 "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",
14507 "name": "updateReports",
14508 "group": "JscriptySessionReport",
14509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14510 "version": "0.0.0",
14511 "filename": "server/api/jscriptySessionReport/index.js",
14512 "groupTitle": "JscriptySessionReport"
14516 "url": "/api/jscripty/projects/clone",
14517 "title": "Clone an existing Project",
14520 "title": "Example usage:",
14521 "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",
14525 "name": "CloneProjects",
14526 "group": "Jscripty_Projects",
14527 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14528 "version": "0.0.0",
14529 "filename": "server/api/jscriptyProject/index.js",
14530 "groupTitle": "Jscripty_Projects"
14534 "url": "/api/jscripty/projects",
14535 "title": "Creates a new Project",
14538 "title": "Example usage:",
14539 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14543 "name": "CreateProjects",
14544 "group": "Jscripty_Projects",
14559 "field": "description",
14566 "field": "formData",
14573 "field": "enableUncompleteSave",
14580 "field": "sendUnpauseOnSubmit",
14586 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14587 "version": "0.0.0",
14588 "filename": "server/api/jscriptyProject/index.js",
14589 "groupTitle": "Jscripty_Projects"
14593 "url": "/api/jscripty/projects/{id}",
14594 "title": "Deletes a Project",
14597 "title": "Example usage:",
14598 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14602 "name": "DeleteProjects",
14603 "group": "Jscripty_Projects",
14604 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14605 "version": "0.0.0",
14606 "filename": "server/api/jscriptyProject/index.js",
14607 "groupTitle": "Jscripty_Projects"
14611 "url": "/api/jscripty/projects",
14612 "title": "Gets a list of Projects",
14615 "title": "Example usage:",
14616 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14620 "name": "GetProjects",
14621 "group": "Jscripty_Projects",
14622 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14623 "version": "0.0.0",
14624 "filename": "server/api/jscriptyProject/index.js",
14625 "groupTitle": "Jscripty_Projects"
14629 "url": "/api/jscripty/projects/{id}",
14630 "title": "Gets a single Project",
14633 "title": "Example usage:",
14634 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14638 "name": "ShowProjects",
14639 "group": "Jscripty_Projects",
14640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14641 "version": "0.0.0",
14642 "filename": "server/api/jscriptyProject/index.js",
14643 "groupTitle": "Jscripty_Projects"
14647 "url": "/api/jscripty/projects/{id}/answers",
14648 "title": "Gets jscripty project answers",
14651 "title": "Example usage:",
14652 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14656 "name": "getAnswers",
14657 "group": "Jscripty_Projects",
14658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14659 "version": "0.0.0",
14660 "filename": "server/api/jscriptyProject/index.js",
14661 "groupTitle": "Jscripty_Projects"
14665 "url": "/api/jscripty/projects/{id}/sessions",
14666 "title": "Gets jscripty project sessions",
14669 "title": "Example usage:",
14670 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14674 "name": "getSessions",
14675 "group": "Jscripty_Projects",
14676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14677 "version": "0.0.0",
14678 "filename": "server/api/jscriptyProject/index.js",
14679 "groupTitle": "Jscripty_Projects"
14683 "url": "/api/jscripty/projects/{id}/summary",
14684 "title": "Gets jscripty project summary",
14687 "title": "Example usage:",
14688 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14692 "name": "getSummary",
14693 "group": "Jscripty_Projects",
14694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14695 "version": "0.0.0",
14696 "filename": "server/api/jscriptyProject/index.js",
14697 "groupTitle": "Jscripty_Projects"
14701 "url": "/api/jscripty/projects/{id}",
14702 "title": "Update an existing Project",
14705 "title": "Example usage:",
14706 "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",
14710 "name": "updateProjects",
14711 "group": "Jscripty_Projects",
14712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14713 "version": "0.0.0",
14714 "filename": "server/api/jscriptyProject/index.js",
14715 "groupTitle": "Jscripty_Projects"
14719 "url": "/api/license",
14720 "title": "Gets License Info",
14723 "title": "Example usage:",
14724 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14729 "group": "License",
14730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14731 "version": "0.0.0",
14732 "filename": "server/api/license/index.js",
14733 "groupTitle": "License"
14737 "url": "/api/license/{id}",
14738 "title": "Update License Info",
14741 "title": "Example usage:",
14742 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14747 "group": "License",
14748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14749 "version": "0.0.0",
14750 "filename": "server/api/license/index.js",
14751 "groupTitle": "License"
14755 "url": "/api/mail/accounts/{id}/users",
14756 "title": "Add agents to a mail account",
14759 "title": "Example usage:",
14760 "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",
14764 "name": "AddAgents",
14765 "group": "Mail_Accounts",
14766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14767 "version": "0.0.0",
14768 "filename": "server/api/mailAccount/index.js",
14769 "groupTitle": "Mail_Accounts"
14773 "url": "/api/mail/accounts/{id}/in_servers",
14774 "title": "Creates a new IMAP server",
14777 "title": "Example usage:",
14778 "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",
14783 "group": "Mail_Accounts",
14791 "field": "description",
14805 "field": "authentication",
14819 "field": "password",
14840 "field": "mailbox",
14847 "field": "connTimeout",
14854 "field": "authTimeout",
14861 "field": "service",
14867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14868 "version": "0.0.0",
14869 "filename": "server/api/mailAccount/index.js",
14870 "groupTitle": "Mail_Accounts"
14874 "url": "/api/mail/accounts/{id}/out_servers",
14875 "title": "Creates a new SMTP server",
14878 "title": "Example usage:",
14879 "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",
14884 "group": "Mail_Accounts",
14892 "field": "description",
14934 "field": "service",
14941 "field": "authentication",
14947 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14948 "version": "0.0.0",
14949 "filename": "server/api/mailAccount/index.js",
14950 "groupTitle": "Mail_Accounts"
14954 "url": "/api/mail/accounts/{id}",
14955 "title": "Deletes a mail account",
14958 "title": "Example usage:",
14959 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14963 "name": "DeleteMailAccounts",
14964 "group": "Mail_Accounts",
14965 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14966 "version": "0.0.0",
14967 "filename": "server/api/mailAccount/index.js",
14968 "groupTitle": "Mail_Accounts"
14972 "url": "/api/mail/accounts/describe",
14973 "title": "Gets table info about Accounts",
14976 "title": "Example usage:",
14977 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14981 "name": "DescribeAccounts",
14982 "group": "Mail_Accounts",
14983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14984 "version": "0.0.0",
14985 "filename": "server/api/mailAccount/index.js",
14986 "groupTitle": "Mail_Accounts"
14990 "url": "/api/mail/accounts",
14991 "title": "Gets a list of Accounts",
14994 "title": "Example usage:",
14995 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14999 "name": "GetAccounts",
15000 "group": "Mail_Accounts",
15001 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15002 "version": "0.0.0",
15003 "filename": "server/api/mailAccount/index.js",
15004 "groupTitle": "Mail_Accounts"
15008 "url": "/api/mail/accounts/{id}/users",
15009 "title": "Gets agents from mail account",
15012 "title": "Example usage:",
15013 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15017 "name": "GetAgents",
15018 "group": "Mail_Accounts",
15019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15020 "version": "0.0.0",
15021 "filename": "server/api/mailAccount/index.js",
15022 "groupTitle": "Mail_Accounts"
15026 "url": "/api/mail/accounts/{id}/in_servers",
15027 "title": "Gets account IMAP server",
15030 "title": "Example usage:",
15031 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15036 "group": "Mail_Accounts",
15037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15038 "version": "0.0.0",
15039 "filename": "server/api/mailAccount/index.js",
15040 "groupTitle": "Mail_Accounts"
15044 "url": "/api/mail/accounts/{id}/out_servers",
15045 "title": "Gets account SMTP server",
15048 "title": "Example usage:",
15049 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15054 "group": "Mail_Accounts",
15055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15056 "version": "0.0.0",
15057 "filename": "server/api/mailAccount/index.js",
15058 "groupTitle": "Mail_Accounts"
15062 "url": "/api/mail/accounts/{id}/users",
15063 "title": "Removes agents from a mail account",
15066 "title": "Example usage:",
15067 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15071 "name": "RemoveAgents",
15072 "group": "Mail_Accounts",
15073 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15074 "version": "0.0.0",
15075 "filename": "server/api/mailAccount/index.js",
15076 "groupTitle": "Mail_Accounts"
15080 "url": "/api/mail/accounts/{id}/canned_answers",
15081 "title": "Removes canned answers from account",
15084 "title": "Example usage:",
15085 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15089 "name": "RemoveAnswers",
15090 "group": "Mail_Accounts",
15091 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15092 "version": "0.0.0",
15093 "filename": "server/api/mailAccount/index.js",
15094 "groupTitle": "Mail_Accounts"
15098 "url": "/api/mail/accounts/{id}/dispositions",
15099 "title": "Removes dispositions from account",
15102 "title": "Example usage:",
15103 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15107 "name": "RemoveDispositions",
15108 "group": "Mail_Accounts",
15109 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15110 "version": "0.0.0",
15111 "filename": "server/api/mailAccount/index.js",
15112 "groupTitle": "Mail_Accounts"
15116 "url": "/api/mail/accounts/{id}/in_servers",
15117 "title": "Removes IMAP server from an account",
15120 "title": "Example usage:",
15121 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15125 "name": "RemoveImmap",
15126 "group": "Mail_Accounts",
15127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15128 "version": "0.0.0",
15129 "filename": "server/api/mailAccount/index.js",
15130 "groupTitle": "Mail_Accounts"
15134 "url": "/api/mail/accounts/{id}/out_servers",
15135 "title": "Removes SMTP server from an account",
15138 "title": "Example usage:",
15139 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15143 "name": "RemoveSmtp",
15144 "group": "Mail_Accounts",
15145 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15146 "version": "0.0.0",
15147 "filename": "server/api/mailAccount/index.js",
15148 "groupTitle": "Mail_Accounts"
15152 "url": "/api/mail/accounts/{id}",
15153 "title": "Gets a single Account",
15156 "title": "Example usage:",
15157 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15161 "name": "ShowAccounts",
15162 "group": "Mail_Accounts",
15163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15164 "version": "0.0.0",
15165 "filename": "server/api/mailAccount/index.js",
15166 "groupTitle": "Mail_Accounts"
15170 "url": "/api/mail/accounts/{id}/canned_answers",
15171 "title": "Creates new canned answer",
15174 "title": "Example usage:",
15175 "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",
15179 "name": "addAnswer",
15180 "group": "Mail_Accounts",
15202 "field": "description",
15215 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15216 "version": "0.0.0",
15217 "filename": "server/api/mailAccount/index.js",
15218 "groupTitle": "Mail_Accounts"
15222 "url": "/api/mail/accounts/{id}/applications",
15223 "title": "Creates new applications",
15226 "title": "Example usage:",
15227 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15231 "name": "addApplications",
15232 "group": "Mail_Accounts",
15240 "field": "priority",
15254 "field": "appdata",
15261 "field": "description",
15268 "field": "interval",
15274 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15275 "version": "0.0.0",
15276 "filename": "server/api/mailAccount/index.js",
15277 "groupTitle": "Mail_Accounts"
15281 "url": "/api/mail/accounts/{id}/dispositions",
15282 "title": "Creates new disposition",
15285 "title": "Example usage:",
15286 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15290 "name": "addDisposition",
15291 "group": "Mail_Accounts",
15318 "field": "description",
15324 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15325 "version": "0.0.0",
15326 "filename": "server/api/mailAccount/index.js",
15327 "groupTitle": "Mail_Accounts"
15331 "url": "/api/mail/accounts/{id}/interactions",
15332 "title": "Creates new interactions",
15335 "title": "Example usage:",
15336 "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",
15340 "name": "addInteraction",
15341 "group": "Mail_Accounts",
15356 "field": "closedAt",
15363 "field": "disposition",
15370 "field": "secondDisposition",
15377 "field": "thirdDisposition",
15391 "field": "inReplyTo",
15412 "field": "subject",
15426 "field": "read1stAt",
15433 "field": "substatus",
15440 "field": "substatusAt",
15451 "field": "firstMsgDirection",
15458 "field": "lastMsgAt",
15469 "field": "lastMsgDirection",
15475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15476 "version": "0.0.0",
15477 "filename": "server/api/mailAccount/index.js",
15478 "groupTitle": "Mail_Accounts"
15482 "url": "/api/mail/accounts",
15483 "title": "Create a mail account",
15486 "title": "Example usage:",
15487 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15492 "group": "Mail_Accounts",
15493 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15494 "version": "0.0.0",
15495 "filename": "server/api/mailAccount/index.js",
15496 "groupTitle": "Mail_Accounts"
15500 "url": "/api/mail/accounts/{id}/canned_answers",
15501 "title": "Gets account canned answers",
15504 "title": "Example usage:",
15505 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15509 "name": "getAnswers",
15510 "group": "Mail_Accounts",
15511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15512 "version": "0.0.0",
15513 "filename": "server/api/mailAccount/index.js",
15514 "groupTitle": "Mail_Accounts"
15518 "url": "/api/mail/accounts/{id}/applications",
15519 "title": "Gets account applications",
15522 "title": "Example usage:",
15523 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15527 "name": "getApplications",
15528 "group": "Mail_Accounts",
15529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15530 "version": "0.0.0",
15531 "filename": "server/api/mailAccount/index.js",
15532 "groupTitle": "Mail_Accounts"
15536 "url": "/api/mail/accounts/{id}/dispositions",
15537 "title": "Gets account dispositions",
15540 "title": "Example usage:",
15541 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15545 "name": "getDispositions",
15546 "group": "Mail_Accounts",
15547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15548 "version": "0.0.0",
15549 "filename": "server/api/mailAccount/index.js",
15550 "groupTitle": "Mail_Accounts"
15554 "url": "/api/mail/accounts/{id}/interactions",
15555 "title": "Gets account interactions",
15558 "title": "Example usage:",
15559 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15563 "name": "getInteraction",
15564 "group": "Mail_Accounts",
15565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15566 "version": "0.0.0",
15567 "filename": "server/api/mailAccount/index.js",
15568 "groupTitle": "Mail_Accounts"
15572 "url": "/api/mail/accounts/{id}/messages",
15573 "title": "Gets account messages",
15576 "title": "Example usage:",
15577 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15581 "name": "getMessages",
15582 "group": "Mail_Accounts",
15583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15584 "version": "0.0.0",
15585 "filename": "server/api/mailAccount/index.js",
15586 "groupTitle": "Mail_Accounts"
15590 "url": "/api/mail/accounts/{id}/send",
15591 "title": "Send new mail",
15594 "title": "Example usage:",
15595 "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",
15599 "name": "sendMail",
15600 "group": "Mail_Accounts",
15601 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15602 "version": "0.0.0",
15603 "filename": "server/api/mailAccount/index.js",
15604 "groupTitle": "Mail_Accounts"
15608 "url": "/api/mail/accounts/{id}",
15609 "title": "Update an existing Account",
15612 "title": "Example usage:",
15613 "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",
15617 "name": "updateAccounts",
15618 "group": "Mail_Accounts",
15619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15620 "version": "0.0.0",
15621 "filename": "server/api/mailAccount/index.js",
15622 "groupTitle": "Mail_Accounts"
15626 "url": "/api/mail/accounts/{id}/verify",
15627 "title": "Verify mail account",
15630 "title": "Example usage:",
15631 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15635 "name": "verifySmtp",
15636 "group": "Mail_Accounts",
15637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15638 "version": "0.0.0",
15639 "filename": "server/api/mailAccount/index.js",
15640 "groupTitle": "Mail_Accounts"
15644 "url": "/api/mail/applications/{id}",
15645 "title": "Deletes a Application",
15648 "title": "Example usage:",
15649 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15653 "name": "DeleteApplications",
15654 "group": "Mail_Applications",
15655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15656 "version": "0.0.0",
15657 "filename": "server/api/mailApplication/index.js",
15658 "groupTitle": "Mail_Applications"
15662 "url": "/api/mail/applications/{id}",
15663 "title": "Gets a single Application",
15666 "title": "Example usage:",
15667 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15671 "name": "ShowApplications",
15672 "group": "Mail_Applications",
15673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15674 "version": "0.0.0",
15675 "filename": "server/api/mailApplication/index.js",
15676 "groupTitle": "Mail_Applications"
15680 "url": "/api/mail/applications/{id}",
15681 "title": "Update an existing Application",
15684 "title": "Example usage:",
15685 "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",
15689 "name": "updateApplications",
15690 "group": "Mail_Applications",
15691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15692 "version": "0.0.0",
15693 "filename": "server/api/mailApplication/index.js",
15694 "groupTitle": "Mail_Applications"
15698 "url": "/api/mail/interactions/{id}/tags",
15699 "title": "Add tags to the interaction",
15702 "title": "Example usage:",
15703 "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",
15708 "group": "Mail_Interactions",
15709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15710 "version": "0.0.0",
15711 "filename": "server/api/mailInteraction/index.js",
15712 "groupTitle": "Mail_Interactions"
15716 "url": "/api/mail/interactions",
15717 "title": "Creates a new Interaction",
15720 "title": "Example usage:",
15721 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15725 "name": "CreateInteractions",
15726 "group": "Mail_Interactions",
15741 "field": "closedAt",
15748 "field": "disposition",
15755 "field": "secondDisposition",
15762 "field": "thirdDisposition",
15776 "field": "inReplyTo",
15797 "field": "subject",
15811 "field": "read1stAt",
15818 "field": "substatus",
15825 "field": "substatusAt",
15836 "field": "firstMsgDirection",
15843 "field": "lastMsgAt",
15854 "field": "lastMsgDirection",
15860 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15861 "version": "0.0.0",
15862 "filename": "server/api/mailInteraction/index.js",
15863 "groupTitle": "Mail_Interactions"
15867 "url": "/api/mail/interactions/{id}",
15868 "title": "Deletes a Interaction",
15871 "title": "Example usage:",
15872 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15876 "name": "DeleteInteractions",
15877 "group": "Mail_Interactions",
15878 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15879 "version": "0.0.0",
15880 "filename": "server/api/mailInteraction/index.js",
15881 "groupTitle": "Mail_Interactions"
15885 "url": "/api/mail/interactions/describe",
15886 "title": "Gets table info about Interactions",
15889 "title": "Example usage:",
15890 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15894 "name": "DescribeInteractions",
15895 "group": "Mail_Interactions",
15896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15897 "version": "0.0.0",
15898 "filename": "server/api/mailInteraction/index.js",
15899 "groupTitle": "Mail_Interactions"
15903 "url": "/api/mail/interactions",
15904 "title": "Gets a list of Interactions",
15907 "title": "Example usage:",
15908 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15912 "name": "GetInteractions",
15913 "group": "Mail_Interactions",
15914 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15915 "version": "0.0.0",
15916 "filename": "server/api/mailInteraction/index.js",
15917 "groupTitle": "Mail_Interactions"
15921 "url": "/api/mail/interactions/{id}/tags",
15922 "title": "Removes tags from interaction",
15925 "title": "Example usage:",
15926 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15930 "name": "RemoveTags",
15931 "group": "Mail_Interactions",
15932 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15933 "version": "0.0.0",
15934 "filename": "server/api/mailInteraction/index.js",
15935 "groupTitle": "Mail_Interactions"
15939 "url": "/api/mail/interactions/{id}",
15940 "title": "Gets a single Interaction",
15943 "title": "Example usage:",
15944 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15948 "name": "ShowInteractions",
15949 "group": "Mail_Interactions",
15950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15951 "version": "0.0.0",
15952 "filename": "server/api/mailInteraction/index.js",
15953 "groupTitle": "Mail_Interactions"
15957 "url": "/api/mail/interactions/{id}/messages",
15958 "title": "Creates new message",
15961 "title": "Example usage:",
15962 "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",
15966 "name": "addMessage",
15967 "group": "Mail_Interactions",
15982 "field": "plainBody",
16000 "field": "direction",
16007 "field": "messageId",
16042 "field": "subject",
16077 "field": "originTo",
16084 "field": "originCc",
16095 "field": "originChannel",
16101 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16102 "version": "0.0.0",
16103 "filename": "server/api/mailInteraction/index.js",
16104 "groupTitle": "Mail_Interactions"
16108 "url": "/api/mail/interactions/{id}/download",
16109 "title": "Gets interaction",
16112 "title": "Example usage:",
16113 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16117 "name": "download",
16118 "group": "Mail_Interactions",
16119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16120 "version": "0.0.0",
16121 "filename": "server/api/mailInteraction/index.js",
16122 "groupTitle": "Mail_Interactions"
16126 "url": "/api/mail/interactions/{id}/messages",
16127 "title": "Gets interaction messages",
16130 "title": "Example usage:",
16131 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16135 "name": "getMessages",
16136 "group": "Mail_Interactions",
16137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16138 "version": "0.0.0",
16139 "filename": "server/api/mailInteraction/index.js",
16140 "groupTitle": "Mail_Interactions"
16144 "url": "/api/mail/interactions/{id}",
16145 "title": "Update an existing Interaction",
16148 "title": "Example usage:",
16149 "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",
16153 "name": "updateInteractions",
16154 "group": "Mail_Interactions",
16155 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16156 "version": "0.0.0",
16157 "filename": "server/api/mailInteraction/index.js",
16158 "groupTitle": "Mail_Interactions"
16162 "url": "/api/mail/messages/{id}",
16163 "title": "Deletes a Message",
16166 "title": "Example usage:",
16167 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16171 "name": "DeleteMessages",
16172 "group": "Mail_Messages",
16173 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16174 "version": "0.0.0",
16175 "filename": "server/api/mailMessage/index.js",
16176 "groupTitle": "Mail_Messages"
16180 "url": "/api/mail/messages/describe",
16181 "title": "Gets table info about Messages",
16184 "title": "Example usage:",
16185 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16189 "name": "DescribeMessages",
16190 "group": "Mail_Messages",
16191 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16192 "version": "0.0.0",
16193 "filename": "server/api/mailMessage/index.js",
16194 "groupTitle": "Mail_Messages"
16198 "url": "/api/mail/messages",
16199 "title": "Gets a list of Messages",
16202 "title": "Example usage:",
16203 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16207 "name": "GetMessages",
16208 "group": "Mail_Messages",
16209 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16210 "version": "0.0.0",
16211 "filename": "server/api/mailMessage/index.js",
16212 "groupTitle": "Mail_Messages"
16216 "url": "/api/mail/messages/{id}",
16217 "title": "Gets a single Message",
16220 "title": "Example usage:",
16221 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16225 "name": "ShowMessages",
16226 "group": "Mail_Messages",
16227 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16228 "version": "0.0.0",
16229 "filename": "server/api/mailMessage/index.js",
16230 "groupTitle": "Mail_Messages"
16234 "url": "/api/mail/messages/{id}/accept",
16235 "title": "Accepts message",
16238 "title": "Example usage:",
16239 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16243 "name": "acceptMessage",
16244 "group": "Mail_Messages",
16245 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16246 "version": "0.0.0",
16247 "filename": "server/api/mailMessage/index.js",
16248 "groupTitle": "Mail_Messages"
16252 "url": "/api/mail/messages",
16253 "title": "Create a message",
16256 "title": "Example usage:",
16257 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16261 "name": "createMessage",
16262 "group": "Mail_Messages",
16263 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16264 "version": "0.0.0",
16265 "filename": "server/api/mailMessage/index.js",
16266 "groupTitle": "Mail_Messages"
16270 "url": "/api/mail/messages/{id}/download",
16271 "title": "Gets message",
16274 "title": "Example usage:",
16275 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16279 "name": "download",
16280 "group": "Mail_Messages",
16281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16282 "version": "0.0.0",
16283 "filename": "server/api/mailMessage/index.js",
16284 "groupTitle": "Mail_Messages"
16288 "url": "/api/mail/messages/{id}/reject",
16289 "title": "Rejects message",
16292 "title": "Example usage:",
16293 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16297 "name": "rejectMessage",
16298 "group": "Mail_Messages",
16299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16300 "version": "0.0.0",
16301 "filename": "server/api/mailMessage/index.js",
16302 "groupTitle": "Mail_Messages"
16306 "url": "/api/mail/messages/{id}",
16307 "title": "Update an existing Message",
16310 "title": "Example usage:",
16311 "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",
16315 "name": "updateMessages",
16316 "group": "Mail_Messages",
16317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16318 "version": "0.0.0",
16319 "filename": "server/api/mailMessage/index.js",
16320 "groupTitle": "Mail_Messages"
16324 "url": "/api/mail/reports/queue",
16325 "title": "Creates a new Mail Queue Report",
16328 "title": "Example usage:",
16329 "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",
16333 "name": "CreateMail_Queue_Reports",
16334 "group": "Mail_Queue_Reports",
16342 "field": "uniqueid",
16363 "field": "leaveAt",
16370 "field": "acceptAt",
16390 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16391 "version": "0.0.0",
16392 "filename": "server/api/mailQueueReport/index.js",
16393 "groupTitle": "Mail_Queue_Reports"
16397 "url": "/api/mail/reports/queue/{id}",
16398 "title": "Deletes a Mail Queue Report",
16401 "title": "Example usage:",
16402 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16406 "name": "DeleteMail_Queue_Reports",
16407 "group": "Mail_Queue_Reports",
16408 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16409 "version": "0.0.0",
16410 "filename": "server/api/mailQueueReport/index.js",
16411 "groupTitle": "Mail_Queue_Reports"
16415 "url": "/api/mail/reports/queue/describe",
16416 "title": "Gets table info about Mail Queue Reports",
16419 "title": "Example usage:",
16420 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16424 "name": "DescribeMail_Queue_Reports",
16425 "group": "Mail_Queue_Reports",
16426 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16427 "version": "0.0.0",
16428 "filename": "server/api/mailQueueReport/index.js",
16429 "groupTitle": "Mail_Queue_Reports"
16433 "url": "/api/mail/reports/queue",
16434 "title": "Gets a list of Mail Queue Reports",
16437 "title": "Example usage:",
16438 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16442 "name": "GetMail_Queue_Reports",
16443 "group": "Mail_Queue_Reports",
16444 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16445 "version": "0.0.0",
16446 "filename": "server/api/mailQueueReport/index.js",
16447 "groupTitle": "Mail_Queue_Reports"
16451 "url": "/api/mail/reports/queue/{id}",
16452 "title": "Gets a single Mail Queue Report",
16455 "title": "Example usage:",
16456 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16460 "name": "ShowMail_Queue_Reports",
16461 "group": "Mail_Queue_Reports",
16462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16463 "version": "0.0.0",
16464 "filename": "server/api/mailQueueReport/index.js",
16465 "groupTitle": "Mail_Queue_Reports"
16469 "url": "/api/mail/reports/queue/{id}",
16470 "title": "Update an existing Mail Queue Report",
16473 "title": "Example usage:",
16474 "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",
16478 "name": "updateMail_Queue_Reports",
16479 "group": "Mail_Queue_Reports",
16480 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16481 "version": "0.0.0",
16482 "filename": "server/api/mailQueueReport/index.js",
16483 "groupTitle": "Mail_Queue_Reports"
16487 "url": "/api/mail/queues/{id}/users",
16488 "title": "Add agents to a queue",
16491 "title": "Example usage:",
16492 "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",
16496 "name": "AddAgents",
16497 "group": "Mail_Queues",
16498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16499 "version": "0.0.0",
16500 "filename": "server/api/mailQueue/index.js",
16501 "groupTitle": "Mail_Queues"
16505 "url": "/api/mail/queues/{id}/teams",
16506 "title": "Add teams to a queue",
16509 "title": "Example usage:",
16510 "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",
16514 "name": "AddTeams",
16515 "group": "Mail_Queues",
16516 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16517 "version": "0.0.0",
16518 "filename": "server/api/mailQueue/index.js",
16519 "groupTitle": "Mail_Queues"
16523 "url": "/api/mail/queues",
16524 "title": "Creates a new Queue",
16527 "title": "Example usage:",
16528 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16532 "name": "CreateQueues",
16533 "group": "Mail_Queues",
16548 "field": "description",
16555 "field": "timeout",
16567 "field": "strategy",
16573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16574 "version": "0.0.0",
16575 "filename": "server/api/mailQueue/index.js",
16576 "groupTitle": "Mail_Queues"
16580 "url": "/api/mail/queues/{id}",
16581 "title": "Deletes a Queue",
16584 "title": "Example usage:",
16585 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16589 "name": "DeleteQueues",
16590 "group": "Mail_Queues",
16591 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16592 "version": "0.0.0",
16593 "filename": "server/api/mailQueue/index.js",
16594 "groupTitle": "Mail_Queues"
16598 "url": "/api/mail/queues/describe",
16599 "title": "Gets table info about Queues",
16602 "title": "Example usage:",
16603 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16607 "name": "DescribeQueues",
16608 "group": "Mail_Queues",
16609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16610 "version": "0.0.0",
16611 "filename": "server/api/mailQueue/index.js",
16612 "groupTitle": "Mail_Queues"
16616 "url": "/api/mail/queues/{id}/users",
16617 "title": "Gets queue agents",
16620 "title": "Example usage:",
16621 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16625 "name": "GetAgents",
16626 "group": "Mail_Queues",
16627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16628 "version": "0.0.0",
16629 "filename": "server/api/mailQueue/index.js",
16630 "groupTitle": "Mail_Queues"
16634 "url": "/api/mail/queues/{id}/members",
16635 "title": "GetMembers",
16638 "title": "Example usage:",
16639 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16643 "name": "GetMembers",
16644 "group": "Mail_Queues",
16645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16646 "version": "0.0.0",
16647 "filename": "server/api/mailQueue/index.js",
16648 "groupTitle": "Mail_Queues"
16652 "url": "/api/mail/queues",
16653 "title": "Gets a list of Queues",
16656 "title": "Example usage:",
16657 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16661 "name": "GetQueues",
16662 "group": "Mail_Queues",
16663 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16664 "version": "0.0.0",
16665 "filename": "server/api/mailQueue/index.js",
16666 "groupTitle": "Mail_Queues"
16670 "url": "/api/mail/queues/{id}/teams",
16671 "title": "Gets queues list",
16674 "title": "Example usage:",
16675 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16679 "name": "GetTeams",
16680 "group": "Mail_Queues",
16681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16682 "version": "0.0.0",
16683 "filename": "server/api/mailQueue/index.js",
16684 "groupTitle": "Mail_Queues"
16688 "url": "/api/mail/queues/{id}/users",
16689 "title": "Removes agents from a queue",
16692 "title": "Example usage:",
16693 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16697 "name": "RemoveAgents",
16698 "group": "Mail_Queues",
16699 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16700 "version": "0.0.0",
16701 "filename": "server/api/mailQueue/index.js",
16702 "groupTitle": "Mail_Queues"
16706 "url": "/api/mail/queues/{id}",
16707 "title": "Gets a single Queue",
16710 "title": "Example usage:",
16711 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16715 "name": "ShowQueues",
16716 "group": "Mail_Queues",
16717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16718 "version": "0.0.0",
16719 "filename": "server/api/mailQueue/index.js",
16720 "groupTitle": "Mail_Queues"
16724 "url": "/api/mail/queues/{id}",
16725 "title": "Update an existing Queue",
16728 "title": "Example usage:",
16729 "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",
16733 "name": "updateQueues",
16734 "group": "Mail_Queues",
16735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16736 "version": "0.0.0",
16737 "filename": "server/api/mailQueue/index.js",
16738 "groupTitle": "Mail_Queues"
16742 "url": "/api/mail/out_servers",
16743 "title": "Creates a new SMTP",
16746 "title": "Example usage:",
16747 "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",
16751 "name": "CreateSMTPs",
16752 "group": "Mail_SMTP",
16760 "field": "description",
16802 "field": "service",
16809 "field": "authentication",
16815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16816 "version": "0.0.0",
16817 "filename": "server/api/mailServerOut/index.js",
16818 "groupTitle": "Mail_SMTP"
16822 "url": "/api/mail/out_servers/{id}",
16823 "title": "Deletes a SMTP",
16826 "title": "Example usage:",
16827 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16831 "name": "DeleteSMTPs",
16832 "group": "Mail_SMTP",
16833 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16834 "version": "0.0.0",
16835 "filename": "server/api/mailServerOut/index.js",
16836 "groupTitle": "Mail_SMTP"
16840 "url": "/api/mail/out_servers",
16841 "title": "Gets a list of SMTPs",
16844 "title": "Example usage:",
16845 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16849 "name": "GetSMTPs",
16850 "group": "Mail_SMTP",
16851 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16852 "version": "0.0.0",
16853 "filename": "server/api/mailServerOut/index.js",
16854 "groupTitle": "Mail_SMTP"
16858 "url": "/api/mail/out_servers/{id}",
16859 "title": "Gets a single SMTP",
16862 "title": "Example usage:",
16863 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16867 "name": "ShowSMTPs",
16868 "group": "Mail_SMTP",
16869 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16870 "version": "0.0.0",
16871 "filename": "server/api/mailServerOut/index.js",
16872 "groupTitle": "Mail_SMTP"
16876 "url": "/api/mail/out_servers/{id}",
16877 "title": "Update an existing SMTP",
16880 "title": "Example usage:",
16881 "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",
16885 "name": "updateSMTPs",
16886 "group": "Mail_SMTP",
16887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16888 "version": "0.0.0",
16889 "filename": "server/api/mailServerOut/index.js",
16890 "groupTitle": "Mail_SMTP"
16894 "url": "/api/mail/substatuses",
16895 "title": "Creates a new Queue",
16898 "title": "Example usage:",
16899 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16903 "name": "CreateSubstatuses",
16904 "group": "Mail_Substatuses",
16919 "field": "description",
16925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16926 "version": "0.0.0",
16927 "filename": "server/api/mailSubstatus/index.js",
16928 "groupTitle": "Mail_Substatuses"
16932 "url": "/api/mail/substatuses/{id}",
16933 "title": "Deletes a Queue",
16936 "title": "Example usage:",
16937 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16941 "name": "DeleteSubstatuses",
16942 "group": "Mail_Substatuses",
16943 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16944 "version": "0.0.0",
16945 "filename": "server/api/mailSubstatus/index.js",
16946 "groupTitle": "Mail_Substatuses"
16950 "url": "/api/mail/substatuses/describe",
16951 "title": "Gets table info about Substatuses",
16954 "title": "Example usage:",
16955 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16959 "name": "DescribeSubstatuses",
16960 "group": "Mail_Substatuses",
16961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16962 "version": "0.0.0",
16963 "filename": "server/api/mailSubstatus/index.js",
16964 "groupTitle": "Mail_Substatuses"
16968 "url": "/api/mail/substatuses",
16969 "title": "Gets a list of Substatuses",
16972 "title": "Example usage:",
16973 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16977 "name": "GetSubstatuses",
16978 "group": "Mail_Substatuses",
16979 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16980 "version": "0.0.0",
16981 "filename": "server/api/mailSubstatus/index.js",
16982 "groupTitle": "Mail_Substatuses"
16986 "url": "/api/mail/substatuses/{id}",
16987 "title": "Gets a single Queue",
16990 "title": "Example usage:",
16991 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16995 "name": "ShowSubstatuses",
16996 "group": "Mail_Substatuses",
16997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16998 "version": "0.0.0",
16999 "filename": "server/api/mailSubstatus/index.js",
17000 "groupTitle": "Mail_Substatuses"
17004 "url": "/api/mail/substatuses/{id}",
17005 "title": "Update an existing Queue",
17008 "title": "Example usage:",
17009 "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",
17013 "name": "updateSubstatuses",
17014 "group": "Mail_Substatuses",
17015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17016 "version": "0.0.0",
17017 "filename": "server/api/mailSubstatus/index.js",
17018 "groupTitle": "Mail_Substatuses"
17022 "url": "/api/mail/reports/transfer",
17023 "title": "Creates a new Mail Transfer Report",
17026 "title": "Example usage:",
17027 "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",
17031 "name": "CreateMail_Transfer_Reports",
17032 "group": "Mail_Transfer_Reports",
17040 "field": "uniqueid",
17059 "field": "transferredAt",
17065 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17066 "version": "0.0.0",
17067 "filename": "server/api/mailTransferReport/index.js",
17068 "groupTitle": "Mail_Transfer_Reports"
17072 "url": "/api/mail/reports/transfer/{id}",
17073 "title": "Deletes a Mail Transfer Report",
17076 "title": "Example usage:",
17077 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17081 "name": "DeleteMail_Transfer_Reports",
17082 "group": "Mail_Transfer_Reports",
17083 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17084 "version": "0.0.0",
17085 "filename": "server/api/mailTransferReport/index.js",
17086 "groupTitle": "Mail_Transfer_Reports"
17090 "url": "/api/mail/reports/transfer/describe",
17091 "title": "Gets table info about Mail Transfer Reports",
17094 "title": "Example usage:",
17095 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17099 "name": "DescribeMail_Transfer_Reports",
17100 "group": "Mail_Transfer_Reports",
17101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17102 "version": "0.0.0",
17103 "filename": "server/api/mailTransferReport/index.js",
17104 "groupTitle": "Mail_Transfer_Reports"
17108 "url": "/api/mail/reports/transfer",
17109 "title": "Gets a list of Mail Transfer Reports",
17112 "title": "Example usage:",
17113 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17117 "name": "GetMail_Transfer_Reports",
17118 "group": "Mail_Transfer_Reports",
17119 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17120 "version": "0.0.0",
17121 "filename": "server/api/mailTransferReport/index.js",
17122 "groupTitle": "Mail_Transfer_Reports"
17126 "url": "/api/mail/reports/transfer/{id}",
17127 "title": "Gets a single Mail Transfer Report",
17130 "title": "Example usage:",
17131 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17135 "name": "ShowMail_Transfer_Reports",
17136 "group": "Mail_Transfer_Reports",
17137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17138 "version": "0.0.0",
17139 "filename": "server/api/mailTransferReport/index.js",
17140 "groupTitle": "Mail_Transfer_Reports"
17144 "url": "/api/mail/reports/transfer/{id}",
17145 "title": "Update an existing Mail Transfer Report",
17148 "title": "Example usage:",
17149 "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",
17153 "name": "updateMail_Transfer_Reports",
17154 "group": "Mail_Transfer_Reports",
17155 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17156 "version": "0.0.0",
17157 "filename": "server/api/mailTransferReport/index.js",
17158 "groupTitle": "Mail_Transfer_Reports"
17162 "url": "/api/members/reports/describe",
17163 "title": "Gets table info about Member Reports",
17166 "title": "Example usage:",
17167 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17171 "name": "DescribeMember_Reports",
17172 "group": "Member_Reports",
17173 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17174 "version": "0.0.0",
17175 "filename": "server/api/memberReport/index.js",
17176 "groupTitle": "Member_Reports"
17180 "url": "/api/members/reports",
17181 "title": "Gets a list of Member Reports",
17184 "title": "Example usage:",
17185 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17189 "name": "GetMember_Reports",
17190 "group": "Member_Reports",
17191 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17192 "version": "0.0.0",
17193 "filename": "server/api/memberReport/index.js",
17194 "groupTitle": "Member_Reports"
17198 "url": "/api/members/reports/{id}",
17199 "title": "Gets a single Member Report",
17202 "title": "Example usage:",
17203 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17207 "name": "ShowMember_Reports",
17208 "group": "Member_Reports",
17209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17210 "version": "0.0.0",
17211 "filename": "server/api/memberReport/index.js",
17212 "groupTitle": "Member_Reports"
17216 "url": "/api/migrations",
17217 "title": "Gets a list of Migrations",
17220 "title": "Example usage:",
17221 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17225 "name": "GetMigrations",
17226 "group": "Migrations",
17227 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17228 "version": "0.0.0",
17229 "filename": "server/api/migration/index.js",
17230 "groupTitle": "Migrations"
17234 "url": "/api/voice/networks",
17235 "title": "Create a new network",
17238 "title": "Example usage:",
17239 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17244 "group": "Networks",
17245 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17246 "version": "0.0.0",
17247 "filename": "server/api/network/index.js",
17248 "groupTitle": "Networks"
17252 "url": "/api/voice/networks/{id}",
17253 "title": "Deletes a network",
17256 "title": "Example usage:",
17257 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17262 "group": "Networks",
17263 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17264 "version": "0.0.0",
17265 "filename": "server/api/network/index.js",
17266 "groupTitle": "Networks"
17270 "url": "/api/networks",
17271 "title": "Gets a list of Networks",
17274 "title": "Example usage:",
17275 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17279 "name": "GetNetworks",
17280 "group": "Networks",
17281 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17282 "version": "0.0.0",
17283 "filename": "server/api/network/index.js",
17284 "groupTitle": "Networks"
17288 "url": "/api/networks/{id}",
17289 "title": "Gets a single Network",
17292 "title": "Example usage:",
17293 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17297 "name": "ShowNetworks",
17298 "group": "Networks",
17299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17300 "version": "0.0.0",
17301 "filename": "server/api/network/index.js",
17302 "groupTitle": "Networks"
17306 "url": "/api/voice/networks/{id}",
17307 "title": "Update an existing network",
17310 "title": "Example usage:",
17311 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17316 "group": "Networks",
17317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17318 "version": "0.0.0",
17319 "filename": "server/api/network/index.js",
17320 "groupTitle": "Networks"
17324 "url": "/api/openchannel/accounts/{id}/users",
17325 "title": "Add agents to a openchannel account",
17328 "title": "Example usage:",
17329 "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",
17333 "name": "AddAgents",
17334 "group": "Openchannel_Accounts",
17335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17336 "version": "0.0.0",
17337 "filename": "server/api/openchannelAccount/index.js",
17338 "groupTitle": "Openchannel_Accounts"
17342 "url": "/api/openchannel/accounts",
17343 "title": "Creates a new Account",
17346 "title": "Example usage:",
17347 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17351 "name": "CreateAccounts",
17352 "group": "Openchannel_Accounts",
17367 "field": "description",
17381 "field": "replyUri",
17395 "field": "notificationTemplate",
17402 "field": "notificationSound",
17409 "field": "notificationShake",
17416 "field": "waitForTheAssignedAgent",
17430 "field": "queueTransfer",
17437 "field": "queueTransferTimeout",
17444 "field": "agentTransfer",
17451 "field": "agentTransferTimeout",
17458 "field": "mandatoryDispositionPauseId",
17459 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17465 "field": "mandatoryDisposition",
17466 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17471 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17472 "version": "0.0.0",
17473 "filename": "server/api/openchannelAccount/index.js",
17474 "groupTitle": "Openchannel_Accounts"
17478 "url": "/api/openchannel/accounts/{id}",
17479 "title": "Deletes a Account",
17482 "title": "Example usage:",
17483 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17487 "name": "DeleteAccounts",
17488 "group": "Openchannel_Accounts",
17489 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17490 "version": "0.0.0",
17491 "filename": "server/api/openchannelAccount/index.js",
17492 "groupTitle": "Openchannel_Accounts"
17496 "url": "/api/openchannel/accounts/describe",
17497 "title": "Gets table info about Accounts",
17500 "title": "Example usage:",
17501 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17505 "name": "DescribeAccounts",
17506 "group": "Openchannel_Accounts",
17507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17508 "version": "0.0.0",
17509 "filename": "server/api/openchannelAccount/index.js",
17510 "groupTitle": "Openchannel_Accounts"
17514 "url": "/api/openchannel/accounts",
17515 "title": "Gets a list of Accounts",
17518 "title": "Example usage:",
17519 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17523 "name": "GetAccounts",
17524 "group": "Openchannel_Accounts",
17525 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17526 "version": "0.0.0",
17527 "filename": "server/api/openchannelAccount/index.js",
17528 "groupTitle": "Openchannel_Accounts"
17532 "url": "/api/openchannel/accounts/{id}/users",
17533 "title": "Gets agents from openchannel account",
17536 "title": "Example usage:",
17537 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17541 "name": "GetAgents",
17542 "group": "Openchannel_Accounts",
17543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17544 "version": "0.0.0",
17545 "filename": "server/api/openchannelAccount/index.js",
17546 "groupTitle": "Openchannel_Accounts"
17550 "url": "/api/openchannel/accounts/{id}/users",
17551 "title": "Removes agents from a openchannel account",
17554 "title": "Example usage:",
17555 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17559 "name": "RemoveAgents",
17560 "group": "Openchannel_Accounts",
17561 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17562 "version": "0.0.0",
17563 "filename": "server/api/openchannelAccount/index.js",
17564 "groupTitle": "Openchannel_Accounts"
17568 "url": "/api/openchannel/accounts/{id}/canned_answers",
17569 "title": "Removes canned answers from account",
17572 "title": "Example usage:",
17573 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17577 "name": "RemoveAnswers",
17578 "group": "Openchannel_Accounts",
17579 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17580 "version": "0.0.0",
17581 "filename": "server/api/openchannelAccount/index.js",
17582 "groupTitle": "Openchannel_Accounts"
17586 "url": "/api/openchannel/accounts/{id}/dispositions",
17587 "title": "Removes dispositions from account",
17590 "title": "Example usage:",
17591 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17595 "name": "RemoveDispositions",
17596 "group": "Openchannel_Accounts",
17597 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17598 "version": "0.0.0",
17599 "filename": "server/api/openchannelAccount/index.js",
17600 "groupTitle": "Openchannel_Accounts"
17604 "url": "/api/openchannel/accounts/{id}",
17605 "title": "Gets a single Account",
17608 "title": "Example usage:",
17609 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17613 "name": "ShowAccounts",
17614 "group": "Openchannel_Accounts",
17615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17616 "version": "0.0.0",
17617 "filename": "server/api/openchannelAccount/index.js",
17618 "groupTitle": "Openchannel_Accounts"
17622 "url": "/api/openchannel/accounts/{id}/canned_answers",
17623 "title": "Creates new canned answer",
17626 "title": "Example usage:",
17627 "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",
17631 "name": "addAnswer",
17632 "group": "Openchannel_Accounts",
17654 "field": "description",
17667 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17668 "version": "0.0.0",
17669 "filename": "server/api/openchannelAccount/index.js",
17670 "groupTitle": "Openchannel_Accounts"
17674 "url": "/api/openchannel/accounts/{id}/applications",
17675 "title": "Creates new applications",
17678 "title": "Example usage:",
17679 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17683 "name": "addApplications",
17684 "group": "Openchannel_Accounts",
17692 "field": "priority",
17706 "field": "appdata",
17713 "field": "description",
17720 "field": "interval",
17726 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17727 "version": "0.0.0",
17728 "filename": "server/api/openchannelAccount/index.js",
17729 "groupTitle": "Openchannel_Accounts"
17733 "url": "/api/openchannel/accounts/{id}/dispositions",
17734 "title": "Creates new disposition",
17737 "title": "Example usage:",
17738 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17742 "name": "addDisposition",
17743 "group": "Openchannel_Accounts",
17770 "field": "description",
17776 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17777 "version": "0.0.0",
17778 "filename": "server/api/openchannelAccount/index.js",
17779 "groupTitle": "Openchannel_Accounts"
17783 "url": "/api/openchannel/accounts/{id}/canned_answers",
17784 "title": "Gets account canned answers",
17787 "title": "Example usage:",
17788 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17792 "name": "getAnswers",
17793 "group": "Openchannel_Accounts",
17794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17795 "version": "0.0.0",
17796 "filename": "server/api/openchannelAccount/index.js",
17797 "groupTitle": "Openchannel_Accounts"
17801 "url": "/api/openchannel/accounts/{id}/applications",
17802 "title": "Gets account applications",
17805 "title": "Example usage:",
17806 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17810 "name": "getApplications",
17811 "group": "Openchannel_Accounts",
17812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17813 "version": "0.0.0",
17814 "filename": "server/api/openchannelAccount/index.js",
17815 "groupTitle": "Openchannel_Accounts"
17819 "url": "/api/openchannel/accounts/{id}/dispositions",
17820 "title": "Gets account dispositions",
17823 "title": "Example usage:",
17824 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17828 "name": "getDispositions",
17829 "group": "Openchannel_Accounts",
17830 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17831 "version": "0.0.0",
17832 "filename": "server/api/openchannelAccount/index.js",
17833 "groupTitle": "Openchannel_Accounts"
17837 "url": "/api/openchannel/accounts/{id}/interactions",
17838 "title": "Gets Openchannel Account Interactions",
17841 "title": "Example usage:",
17842 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17846 "name": "getInteractions",
17847 "group": "Openchannel_Accounts",
17848 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17849 "version": "0.0.0",
17850 "filename": "server/api/openchannelAccount/index.js",
17851 "groupTitle": "Openchannel_Accounts"
17855 "url": "/api/openchannel/accounts/{id}/notify",
17856 "title": "Notify new message",
17859 "title": "Example usage:",
17860 "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",
17865 "group": "Openchannel_Accounts",
17866 "description": "<p>Motion 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>",
17867 "version": "0.0.0",
17868 "filename": "server/api/openchannelAccount/index.js",
17869 "groupTitle": "Openchannel_Accounts"
17873 "url": "/api/openchannel/accounts/{id}/send",
17874 "title": "Send new openchannel message",
17877 "title": "Example usage:",
17878 "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",
17882 "name": "sendOpenchannel",
17883 "group": "Openchannel_Accounts",
17884 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17885 "version": "0.0.0",
17886 "filename": "server/api/openchannelAccount/index.js",
17887 "groupTitle": "Openchannel_Accounts"
17891 "url": "/api/openchannel/accounts/{id}",
17892 "title": "Update an existing Account",
17895 "title": "Example usage:",
17896 "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",
17900 "name": "updateAccounts",
17901 "group": "Openchannel_Accounts",
17902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17903 "version": "0.0.0",
17904 "filename": "server/api/openchannelAccount/index.js",
17905 "groupTitle": "Openchannel_Accounts"
17909 "url": "/api/openchannel/applications",
17910 "title": "Creates a new Application",
17913 "title": "Example usage:",
17914 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17918 "name": "CreateApplications",
17919 "group": "Openchannel_Applications",
17927 "field": "priority",
17941 "field": "appdata",
17948 "field": "description",
17955 "field": "interval",
17961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17962 "version": "0.0.0",
17963 "filename": "server/api/openchannelApplication/index.js",
17964 "groupTitle": "Openchannel_Applications"
17968 "url": "/api/openchannel/applications/{id}",
17969 "title": "Deletes a Application",
17972 "title": "Example usage:",
17973 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17977 "name": "DeleteApplications",
17978 "group": "Openchannel_Applications",
17979 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17980 "version": "0.0.0",
17981 "filename": "server/api/openchannelApplication/index.js",
17982 "groupTitle": "Openchannel_Applications"
17986 "url": "/api/openchannel/applications",
17987 "title": "Gets a list of Applications",
17990 "title": "Example usage:",
17991 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17995 "name": "GetApplications",
17996 "group": "Openchannel_Applications",
17997 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17998 "version": "0.0.0",
17999 "filename": "server/api/openchannelApplication/index.js",
18000 "groupTitle": "Openchannel_Applications"
18004 "url": "/api/openchannel/applications/{id}",
18005 "title": "Gets a single Application",
18008 "title": "Example usage:",
18009 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18013 "name": "ShowApplications",
18014 "group": "Openchannel_Applications",
18015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18016 "version": "0.0.0",
18017 "filename": "server/api/openchannelApplication/index.js",
18018 "groupTitle": "Openchannel_Applications"
18022 "url": "/api/openchannel/applications/{id}",
18023 "title": "Update an existing Application",
18026 "title": "Example usage:",
18027 "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",
18031 "name": "updateApplications",
18032 "group": "Openchannel_Applications",
18033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18034 "version": "0.0.0",
18035 "filename": "server/api/openchannelApplication/index.js",
18036 "groupTitle": "Openchannel_Applications"
18040 "url": "/api/openchannel/interactions/{id}/tags",
18041 "title": "Add tags to the interaction",
18044 "title": "Example usage:",
18045 "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",
18050 "group": "Openchannel_Interactions",
18051 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18052 "version": "0.0.0",
18053 "filename": "server/api/openchannelInteraction/index.js",
18054 "groupTitle": "Openchannel_Interactions"
18058 "url": "/api/openchannel/interactions",
18059 "title": "Creates a new Interaction",
18062 "title": "Example usage:",
18063 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18067 "name": "CreateInteractions",
18068 "group": "Openchannel_Interactions",
18083 "field": "closedAt",
18090 "field": "disposition",
18097 "field": "secondDisposition",
18104 "field": "thirdDisposition",
18118 "field": "read1stAt",
18125 "field": "threadId",
18132 "field": "externalUrl",
18139 "field": "lastMsgAt",
18150 "field": "lastMsgDirection",
18163 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18164 "version": "0.0.0",
18165 "filename": "server/api/openchannelInteraction/index.js",
18166 "groupTitle": "Openchannel_Interactions"
18170 "url": "/api/openchannel/interactions/{id}",
18171 "title": "Deletes a Interaction",
18174 "title": "Example usage:",
18175 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18179 "name": "DeleteInteractions",
18180 "group": "Openchannel_Interactions",
18181 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18182 "version": "0.0.0",
18183 "filename": "server/api/openchannelInteraction/index.js",
18184 "groupTitle": "Openchannel_Interactions"
18188 "url": "/api/openchannel/interactions/describe",
18189 "title": "Gets table info about Interactions",
18192 "title": "Example usage:",
18193 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18197 "name": "DescribeInteractions",
18198 "group": "Openchannel_Interactions",
18199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18200 "version": "0.0.0",
18201 "filename": "server/api/openchannelInteraction/index.js",
18202 "groupTitle": "Openchannel_Interactions"
18206 "url": "/api/openchannel/interactions",
18207 "title": "Gets a list of Interactions",
18210 "title": "Example usage:",
18211 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18215 "name": "GetInteractions",
18216 "group": "Openchannel_Interactions",
18217 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18218 "version": "0.0.0",
18219 "filename": "server/api/openchannelInteraction/index.js",
18220 "groupTitle": "Openchannel_Interactions"
18224 "url": "/api/openchannel/interactions/{id}/tags",
18225 "title": "Removes tags from interaction",
18228 "title": "Example usage:",
18229 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18233 "name": "RemoveTags",
18234 "group": "Openchannel_Interactions",
18235 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18236 "version": "0.0.0",
18237 "filename": "server/api/openchannelInteraction/index.js",
18238 "groupTitle": "Openchannel_Interactions"
18242 "url": "/api/openchannel/interactions/{id}",
18243 "title": "Gets a single Interaction",
18246 "title": "Example usage:",
18247 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18251 "name": "ShowInteractions",
18252 "group": "Openchannel_Interactions",
18253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18254 "version": "0.0.0",
18255 "filename": "server/api/openchannelInteraction/index.js",
18256 "groupTitle": "Openchannel_Interactions"
18260 "url": "/api/openchannel/interactions/{id}/messages",
18261 "title": "Creates new messages",
18264 "title": "Example usage:",
18265 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18269 "name": "addMessage",
18270 "group": "Openchannel_Interactions",
18303 "field": "direction",
18317 "field": "providerName",
18324 "field": "providerResponse",
18330 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18331 "version": "0.0.0",
18332 "filename": "server/api/openchannelInteraction/index.js",
18333 "groupTitle": "Openchannel_Interactions"
18337 "url": "/api/openchannel/interactions/{id}/download",
18338 "title": "Gets interaction",
18341 "title": "Example usage:",
18342 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18346 "name": "download",
18347 "group": "Openchannel_Interactions",
18348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18349 "version": "0.0.0",
18350 "filename": "server/api/openchannelInteraction/index.js",
18351 "groupTitle": "Openchannel_Interactions"
18355 "url": "/api/openchannel/interactions/{id}/messages",
18356 "title": "Gets interaction messages",
18359 "title": "Example usage:",
18360 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18364 "name": "getMessages",
18365 "group": "Openchannel_Interactions",
18366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18367 "version": "0.0.0",
18368 "filename": "server/api/openchannelInteraction/index.js",
18369 "groupTitle": "Openchannel_Interactions"
18373 "url": "/api/openchannel/interactions/{id}",
18374 "title": "Update an existing Interaction",
18377 "title": "Example usage:",
18378 "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",
18382 "name": "updateInteractions",
18383 "group": "Openchannel_Interactions",
18384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18385 "version": "0.0.0",
18386 "filename": "server/api/openchannelInteraction/index.js",
18387 "groupTitle": "Openchannel_Interactions"
18391 "url": "/api/openchannel/messages",
18392 "title": "Creates a new Message",
18395 "title": "Example usage:",
18396 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18400 "name": "CreateMessages",
18401 "group": "Openchannel_Messages",
18434 "field": "direction",
18448 "field": "providerName",
18455 "field": "providerResponse",
18461 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18462 "version": "0.0.0",
18463 "filename": "server/api/openchannelMessage/index.js",
18464 "groupTitle": "Openchannel_Messages"
18468 "url": "/api/openchannel/messages/{id}",
18469 "title": "Deletes a Message",
18472 "title": "Example usage:",
18473 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18477 "name": "DeleteMessages",
18478 "group": "Openchannel_Messages",
18479 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18480 "version": "0.0.0",
18481 "filename": "server/api/openchannelMessage/index.js",
18482 "groupTitle": "Openchannel_Messages"
18486 "url": "/api/openchannel/messages/describe",
18487 "title": "Gets table info about Messages",
18490 "title": "Example usage:",
18491 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18495 "name": "DescribeMessages",
18496 "group": "Openchannel_Messages",
18497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18498 "version": "0.0.0",
18499 "filename": "server/api/openchannelMessage/index.js",
18500 "groupTitle": "Openchannel_Messages"
18504 "url": "/api/openchannel/messages",
18505 "title": "Gets a list of Messages",
18508 "title": "Example usage:",
18509 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18513 "name": "GetMessages",
18514 "group": "Openchannel_Messages",
18515 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18516 "version": "0.0.0",
18517 "filename": "server/api/openchannelMessage/index.js",
18518 "groupTitle": "Openchannel_Messages"
18522 "url": "/api/openchannel/messages/{id}",
18523 "title": "Gets a single Message",
18526 "title": "Example usage:",
18527 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18531 "name": "ShowMessages",
18532 "group": "Openchannel_Messages",
18533 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18534 "version": "0.0.0",
18535 "filename": "server/api/openchannelMessage/index.js",
18536 "groupTitle": "Openchannel_Messages"
18540 "url": "/api/openchannel/messages/{id}/accept",
18541 "title": "Accepts message",
18544 "title": "Example usage:",
18545 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18549 "name": "acceptMessage",
18550 "group": "Openchannel_Messages",
18551 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18552 "version": "0.0.0",
18553 "filename": "server/api/openchannelMessage/index.js",
18554 "groupTitle": "Openchannel_Messages"
18558 "url": "/api/openchannel/messages/{id}/reject",
18559 "title": "Rejects message",
18562 "title": "Example usage:",
18563 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18567 "name": "rejectMessage",
18568 "group": "Openchannel_Messages",
18569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18570 "version": "0.0.0",
18571 "filename": "server/api/openchannelMessage/index.js",
18572 "groupTitle": "Openchannel_Messages"
18576 "url": "/api/openchannel/messages/{id}",
18577 "title": "Update an existing Message",
18580 "title": "Example usage:",
18581 "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",
18585 "name": "updateMessages",
18586 "group": "Openchannel_Messages",
18587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18588 "version": "0.0.0",
18589 "filename": "server/api/openchannelMessage/index.js",
18590 "groupTitle": "Openchannel_Messages"
18594 "url": "/api/openchannel/reports/queue",
18595 "title": "Creates a new Openchannel Queue Report",
18598 "title": "Example usage:",
18599 "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",
18603 "name": "CreateOpenchannel_Queue_Reports",
18604 "group": "Openchannel_Queue_Reports",
18612 "field": "uniqueid",
18633 "field": "leaveAt",
18640 "field": "acceptAt",
18660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18661 "version": "0.0.0",
18662 "filename": "server/api/openchannelQueueReport/index.js",
18663 "groupTitle": "Openchannel_Queue_Reports"
18667 "url": "/api/openchannel/reports/queue/{id}",
18668 "title": "Deletes a Openchannel Queue Report",
18671 "title": "Example usage:",
18672 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18676 "name": "DeleteOpenchannel_Queue_Reports",
18677 "group": "Openchannel_Queue_Reports",
18678 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18679 "version": "0.0.0",
18680 "filename": "server/api/openchannelQueueReport/index.js",
18681 "groupTitle": "Openchannel_Queue_Reports"
18685 "url": "/api/openchannel/reports/queue/describe",
18686 "title": "Gets table info about Openchannel Queue Reports",
18689 "title": "Example usage:",
18690 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18694 "name": "DescribeOpenchannel_Queue_Reports",
18695 "group": "Openchannel_Queue_Reports",
18696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18697 "version": "0.0.0",
18698 "filename": "server/api/openchannelQueueReport/index.js",
18699 "groupTitle": "Openchannel_Queue_Reports"
18703 "url": "/api/openchannel/reports/queue",
18704 "title": "Gets a list of Openchannel Queue Reports",
18707 "title": "Example usage:",
18708 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18712 "name": "GetOpenchannel_Queue_Reports",
18713 "group": "Openchannel_Queue_Reports",
18714 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18715 "version": "0.0.0",
18716 "filename": "server/api/openchannelQueueReport/index.js",
18717 "groupTitle": "Openchannel_Queue_Reports"
18721 "url": "/api/openchannel/reports/queue/{id}",
18722 "title": "Gets a single Openchannel Queue Report",
18725 "title": "Example usage:",
18726 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18730 "name": "ShowOpenchannel_Queue_Reports",
18731 "group": "Openchannel_Queue_Reports",
18732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18733 "version": "0.0.0",
18734 "filename": "server/api/openchannelQueueReport/index.js",
18735 "groupTitle": "Openchannel_Queue_Reports"
18739 "url": "/api/openchannel/reports/queue/{id}",
18740 "title": "Update an existing Openchannel Queue Report",
18743 "title": "Example usage:",
18744 "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",
18748 "name": "updateOpenchannel_Queue_Reports",
18749 "group": "Openchannel_Queue_Reports",
18750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18751 "version": "0.0.0",
18752 "filename": "server/api/openchannelQueueReport/index.js",
18753 "groupTitle": "Openchannel_Queue_Reports"
18757 "url": "/api/openchannel/queues/{id}/users",
18758 "title": "Add agents to a queue",
18761 "title": "Example usage:",
18762 "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",
18766 "name": "AddAgents",
18767 "group": "Openchannel_Queues",
18768 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18769 "version": "0.0.0",
18770 "filename": "server/api/openchannelQueue/index.js",
18771 "groupTitle": "Openchannel_Queues"
18775 "url": "/api/openchannel/queues/{id}/teams",
18776 "title": "Add teams to a queue",
18779 "title": "Example usage:",
18780 "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",
18784 "name": "AddTeams",
18785 "group": "Openchannel_Queues",
18786 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18787 "version": "0.0.0",
18788 "filename": "server/api/openchannelQueue/index.js",
18789 "groupTitle": "Openchannel_Queues"
18793 "url": "/api/openchannel/queues",
18794 "title": "Creates a new Queue",
18797 "title": "Example usage:",
18798 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18802 "name": "CreateQueues",
18803 "group": "Openchannel_Queues",
18818 "field": "description",
18825 "field": "timeout",
18837 "field": "strategy",
18843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18844 "version": "0.0.0",
18845 "filename": "server/api/openchannelQueue/index.js",
18846 "groupTitle": "Openchannel_Queues"
18850 "url": "/api/openchannel/queues/{id}",
18851 "title": "Deletes a Queue",
18854 "title": "Example usage:",
18855 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18859 "name": "DeleteQueues",
18860 "group": "Openchannel_Queues",
18861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18862 "version": "0.0.0",
18863 "filename": "server/api/openchannelQueue/index.js",
18864 "groupTitle": "Openchannel_Queues"
18868 "url": "/api/openchannel/queues/describe",
18869 "title": "Gets table info about Queues",
18872 "title": "Example usage:",
18873 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18877 "name": "DescribeQueues",
18878 "group": "Openchannel_Queues",
18879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18880 "version": "0.0.0",
18881 "filename": "server/api/openchannelQueue/index.js",
18882 "groupTitle": "Openchannel_Queues"
18886 "url": "/api/openchannel/queues/{id}/users",
18887 "title": "Gets queue agents",
18890 "title": "Example usage:",
18891 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18895 "name": "GetAgents",
18896 "group": "Openchannel_Queues",
18897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18898 "version": "0.0.0",
18899 "filename": "server/api/openchannelQueue/index.js",
18900 "groupTitle": "Openchannel_Queues"
18904 "url": "/api/openchannel/queues/{id}/members",
18905 "title": "GetMembers",
18908 "title": "Example usage:",
18909 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18913 "name": "GetMembers",
18914 "group": "Openchannel_Queues",
18915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18916 "version": "0.0.0",
18917 "filename": "server/api/openchannelQueue/index.js",
18918 "groupTitle": "Openchannel_Queues"
18922 "url": "/api/openchannel/queues",
18923 "title": "Gets a list of Queues",
18926 "title": "Example usage:",
18927 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18931 "name": "GetQueues",
18932 "group": "Openchannel_Queues",
18933 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18934 "version": "0.0.0",
18935 "filename": "server/api/openchannelQueue/index.js",
18936 "groupTitle": "Openchannel_Queues"
18940 "url": "/api/openchannel/queues/{id}/teams",
18941 "title": "Gets queues list",
18944 "title": "Example usage:",
18945 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18949 "name": "GetTeams",
18950 "group": "Openchannel_Queues",
18951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18952 "version": "0.0.0",
18953 "filename": "server/api/openchannelQueue/index.js",
18954 "groupTitle": "Openchannel_Queues"
18958 "url": "/api/openchannel/queues/{id}/users",
18959 "title": "Removes agents from a queue",
18962 "title": "Example usage:",
18963 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18967 "name": "RemoveAgents",
18968 "group": "Openchannel_Queues",
18969 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18970 "version": "0.0.0",
18971 "filename": "server/api/openchannelQueue/index.js",
18972 "groupTitle": "Openchannel_Queues"
18976 "url": "/api/openchannel/queues/{id}",
18977 "title": "Gets a single Queue",
18980 "title": "Example usage:",
18981 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18985 "name": "ShowQueues",
18986 "group": "Openchannel_Queues",
18987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18988 "version": "0.0.0",
18989 "filename": "server/api/openchannelQueue/index.js",
18990 "groupTitle": "Openchannel_Queues"
18994 "url": "/api/openchannel/queues/{id}",
18995 "title": "Update an existing Queue",
18998 "title": "Example usage:",
18999 "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",
19003 "name": "updateQueues",
19004 "group": "Openchannel_Queues",
19005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19006 "version": "0.0.0",
19007 "filename": "server/api/openchannelQueue/index.js",
19008 "groupTitle": "Openchannel_Queues"
19012 "url": "/api/openchannel/reports/transfer",
19013 "title": "Creates a new Openchannel Transfer Report",
19016 "title": "Example usage:",
19017 "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",
19021 "name": "CreateOpenchannel_Transfer_Reports",
19022 "group": "Openchannel_Transfer_Reports",
19030 "field": "uniqueid",
19049 "field": "transferredAt",
19055 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19056 "version": "0.0.0",
19057 "filename": "server/api/openchannelTransferReport/index.js",
19058 "groupTitle": "Openchannel_Transfer_Reports"
19062 "url": "/api/openchannel/reports/transfer/{id}",
19063 "title": "Deletes a Openchannel Transfer Report",
19066 "title": "Example usage:",
19067 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19071 "name": "DeleteOpenchannel_Transfer_Reports",
19072 "group": "Openchannel_Transfer_Reports",
19073 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19074 "version": "0.0.0",
19075 "filename": "server/api/openchannelTransferReport/index.js",
19076 "groupTitle": "Openchannel_Transfer_Reports"
19080 "url": "/api/openchannel/reports/transfer/describe",
19081 "title": "Gets table info about Openchannel Transfer Reports",
19084 "title": "Example usage:",
19085 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19089 "name": "DescribeOpenchannel_Transfer_Reports",
19090 "group": "Openchannel_Transfer_Reports",
19091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19092 "version": "0.0.0",
19093 "filename": "server/api/openchannelTransferReport/index.js",
19094 "groupTitle": "Openchannel_Transfer_Reports"
19098 "url": "/api/openchannel/reports/transfer",
19099 "title": "Gets a list of Openchannel Transfer Reports",
19102 "title": "Example usage:",
19103 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19107 "name": "GetOpenchannel_Transfer_Reports",
19108 "group": "Openchannel_Transfer_Reports",
19109 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19110 "version": "0.0.0",
19111 "filename": "server/api/openchannelTransferReport/index.js",
19112 "groupTitle": "Openchannel_Transfer_Reports"
19116 "url": "/api/openchannel/reports/transfer/{id}",
19117 "title": "Gets a single Openchannel Transfer Report",
19120 "title": "Example usage:",
19121 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19125 "name": "ShowOpenchannel_Transfer_Reports",
19126 "group": "Openchannel_Transfer_Reports",
19127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19128 "version": "0.0.0",
19129 "filename": "server/api/openchannelTransferReport/index.js",
19130 "groupTitle": "Openchannel_Transfer_Reports"
19134 "url": "/api/openchannel/reports/transfer/{id}",
19135 "title": "Update an existing Openchannel Transfer Report",
19138 "title": "Example usage:",
19139 "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",
19143 "name": "updateOpenchannel_Transfer_Reports",
19144 "group": "Openchannel_Transfer_Reports",
19145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19146 "version": "0.0.0",
19147 "filename": "server/api/openchannelTransferReport/index.js",
19148 "groupTitle": "Openchannel_Transfer_Reports"
19152 "url": "/api/pauses",
19153 "title": "Creates a new Pause",
19156 "title": "Example usage:",
19157 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19161 "name": "CreatePauses",
19177 "field": "description",
19183 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19184 "version": "0.0.0",
19185 "filename": "server/api/pause/index.js",
19186 "groupTitle": "Pauses"
19190 "url": "/api/pauses/{id}",
19191 "title": "Deletes a Pause",
19194 "title": "Example usage:",
19195 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19199 "name": "DeletePauses",
19201 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19202 "version": "0.0.0",
19203 "filename": "server/api/pause/index.js",
19204 "groupTitle": "Pauses"
19208 "url": "/api/pauses",
19209 "title": "Gets a list of Pauses",
19212 "title": "Example usage:",
19213 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19217 "name": "GetPauses",
19219 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19220 "version": "0.0.0",
19221 "filename": "server/api/pause/index.js",
19222 "groupTitle": "Pauses"
19226 "url": "/api/pauses/{id}",
19227 "title": "Gets a single Pause",
19230 "title": "Example usage:",
19231 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19235 "name": "ShowPauses",
19237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19238 "version": "0.0.0",
19239 "filename": "server/api/pause/index.js",
19240 "groupTitle": "Pauses"
19244 "url": "/api/pauses/{id}",
19245 "title": "Update an existing Pause",
19248 "title": "Example usage:",
19249 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19253 "name": "updatePauses",
19255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19256 "version": "0.0.0",
19257 "filename": "server/api/pause/index.js",
19258 "groupTitle": "Pauses"
19262 "url": "/api/plugins",
19263 "title": "Gets a list of Plugins",
19266 "title": "Example usage:",
19267 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19271 "name": "GetPlugins",
19272 "group": "Plugins",
19273 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19274 "version": "0.0.0",
19275 "filename": "server/api/plugin/index.js",
19276 "groupTitle": "Plugins"
19280 "url": "/api/plugins/{id}",
19281 "title": "Gets a single Plugin",
19284 "title": "Example usage:",
19285 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19289 "name": "ShowPlugins",
19290 "group": "Plugins",
19291 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19292 "version": "0.0.0",
19293 "filename": "server/api/plugin/index.js",
19294 "groupTitle": "Plugins"
19298 "url": "/api/plugins/{id}",
19299 "title": "Delete a plugin",
19302 "title": "Example usage:",
19303 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19307 "name": "destroyPlugin",
19308 "group": "Plugins",
19309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19310 "version": "0.0.0",
19311 "filename": "server/api/plugin/index.js",
19312 "groupTitle": "Plugins"
19316 "url": "/api/plugins/{id}/download",
19317 "title": "Download plugin source code",
19320 "title": "Example usage:",
19321 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19325 "name": "download",
19326 "group": "Plugins",
19327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19328 "version": "0.0.0",
19329 "filename": "server/api/plugin/index.js",
19330 "groupTitle": "Plugins"
19334 "url": "/api/plugins/{id}",
19335 "title": "Update an existing plugin",
19338 "title": "Example usage:",
19339 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19343 "name": "updatePlugin",
19344 "group": "Plugins",
19345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19346 "version": "0.0.0",
19347 "filename": "server/api/plugin/index.js",
19348 "groupTitle": "Plugins"
19352 "url": "/api/plugins",
19353 "title": "Upload new plugin",
19356 "title": "Example usage:",
19357 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19361 "name": "uploadPlugin",
19362 "group": "Plugins",
19363 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19364 "version": "0.0.0",
19365 "filename": "server/api/plugin/index.js",
19366 "groupTitle": "Plugins"
19370 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19371 "title": "Redirect a plugin request to the specified path",
19374 "title": "Example usage:",
19375 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19379 "name": "webhookPlugin",
19380 "group": "Plugins",
19381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19382 "version": "0.0.0",
19383 "filename": "server/api/plugin/index.js",
19384 "groupTitle": "Plugins"
19388 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19389 "title": "Redirect a plugin request to the specified path",
19392 "title": "Example usage:",
19393 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19397 "name": "webhookPlugin",
19398 "group": "Plugins",
19399 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19400 "version": "0.0.0",
19401 "filename": "server/api/plugin/index.js",
19402 "groupTitle": "Plugins"
19406 "url": "/api/pm2/{id}",
19407 "title": "Deletes an existing process",
19410 "title": "Example usage:",
19411 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19415 "name": "DeletePm2Process",
19417 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19418 "version": "0.0.0",
19419 "filename": "server/api/pm2/index.js",
19420 "groupTitle": "Pm2"
19424 "url": "/api/pm2/{id}",
19425 "title": "Gets a single pm2 process",
19428 "title": "Example usage:",
19429 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19433 "name": "GetPm2Process",
19435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19436 "version": "0.0.0",
19437 "filename": "server/api/pm2/index.js",
19438 "groupTitle": "Pm2"
19443 "title": "Gets pm2 processes",
19446 "title": "Example usage:",
19447 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19451 "name": "GetPm2Processes",
19453 "description": "<p>Motion returns the pm2 processes list.</p>",
19454 "version": "0.0.0",
19455 "filename": "server/api/pm2/index.js",
19456 "groupTitle": "Pm2"
19461 "title": "Start a single pm2 process",
19464 "title": "Example usage:",
19465 "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",
19469 "name": "StartPm2Process",
19491 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19492 "version": "0.0.0",
19493 "filename": "server/api/pm2/index.js",
19494 "groupTitle": "Pm2"
19498 "url": "/api/pm2/{id}",
19499 "title": "Update an existing process",
19502 "title": "Example usage:",
19503 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19507 "name": "UpdatePm2Process",
19509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19510 "version": "0.0.0",
19511 "filename": "server/api/pm2/index.js",
19512 "groupTitle": "Pm2"
19516 "url": "/api/rpc/campaigns/",
19517 "title": "Gets a list of campaigns",
19520 "title": "Example usage:",
19521 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19525 "name": "Campaigns",
19526 "group": "RPC_Realtime",
19527 "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>",
19528 "version": "0.0.0",
19529 "filename": "server/api/rpc/index.js",
19530 "groupTitle": "RPC_Realtime"
19534 "url": "/api/rpc/fax/accounts",
19535 "title": "Gets a list of FaxAccounts",
19538 "title": "Example usage:",
19539 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19543 "name": "FaxAccounts",
19544 "group": "RPC_Realtime",
19545 "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>",
19546 "version": "0.0.0",
19547 "filename": "server/api/rpc/index.js",
19548 "groupTitle": "RPC_Realtime"
19552 "url": "/api/rpc/agents/:id/capacity",
19553 "title": "Sets agent capacity",
19556 "title": "Example usage:",
19557 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19561 "name": "RTAgentCapacity",
19562 "group": "RPC_Realtime",
19563 "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>",
19564 "version": "0.0.0",
19565 "filename": "server/api/rpc/index.js",
19566 "groupTitle": "RPC_Realtime"
19570 "url": "/api/rpc/agents",
19571 "title": "Gets a list of RTAgents",
19574 "title": "Example usage:",
19575 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19579 "name": "RTAgents",
19580 "group": "RPC_Realtime",
19581 "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>",
19582 "version": "0.0.0",
19583 "filename": "server/api/rpc/index.js",
19584 "groupTitle": "RPC_Realtime"
19588 "url": "/api/rpc/chat/queues",
19589 "title": "Gets a list of RTChatQueues",
19592 "title": "Example usage:",
19593 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19597 "name": "RTChatQueues",
19598 "group": "RPC_Realtime",
19599 "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>",
19600 "version": "0.0.0",
19601 "filename": "server/api/rpc/index.js",
19602 "groupTitle": "RPC_Realtime"
19606 "url": "/api/rpc/fax/queues",
19607 "title": "Gets a list of RTFaxQueues",
19610 "title": "Example usage:",
19611 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19615 "name": "RTFaxQueues",
19616 "group": "RPC_Realtime",
19617 "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>",
19618 "version": "0.0.0",
19619 "filename": "server/api/rpc/index.js",
19620 "groupTitle": "RPC_Realtime"
19624 "url": "/api/rpc/mail/accounts",
19625 "title": "Gets a list of RTMailAccounts",
19628 "title": "Example usage:",
19629 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19633 "name": "RTMailAccounts",
19634 "group": "RPC_Realtime",
19635 "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>",
19636 "version": "0.0.0",
19637 "filename": "server/api/rpc/index.js",
19638 "groupTitle": "RPC_Realtime"
19642 "url": "/api/rpc/mail/queues",
19643 "title": "Gets a list of RTMailQueues",
19646 "title": "Example usage:",
19647 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19651 "name": "RTMailQueues",
19652 "group": "RPC_Realtime",
19653 "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>",
19654 "version": "0.0.0",
19655 "filename": "server/api/rpc/index.js",
19656 "groupTitle": "RPC_Realtime"
19660 "url": "/api/rpc/openchannel/queues",
19661 "title": "Gets a list of RTOpenchannelQueues",
19664 "title": "Example usage:",
19665 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19669 "name": "RTOpenchannelQueues",
19670 "group": "RPC_Realtime",
19671 "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>",
19672 "version": "0.0.0",
19673 "filename": "server/api/rpc/index.js",
19674 "groupTitle": "RPC_Realtime"
19678 "url": "/api/rpc/outbound/channels",
19679 "title": "Gets a list of RTOutboundChannels",
19682 "title": "Example usage:",
19683 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19687 "name": "RTOutboundChannels",
19688 "group": "RPC_Realtime",
19689 "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>",
19690 "version": "0.0.0",
19691 "filename": "server/api/rpc/index.js",
19692 "groupTitle": "RPC_Realtime"
19696 "url": "/api/rpc/sms/queues",
19697 "title": "Gets a list of RTSmsQueues",
19700 "title": "Example usage:",
19701 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19705 "name": "RTSmsQueues",
19706 "group": "RPC_Realtime",
19707 "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>",
19708 "version": "0.0.0",
19709 "filename": "server/api/rpc/index.js",
19710 "groupTitle": "RPC_Realtime"
19714 "url": "/api/rpc/telephones",
19715 "title": "Gets a list of RTTelephones",
19718 "title": "Example usage:",
19719 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19723 "name": "RTTelephones",
19724 "group": "RPC_Realtime",
19725 "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>",
19726 "version": "0.0.0",
19727 "filename": "server/api/rpc/index.js",
19728 "groupTitle": "RPC_Realtime"
19732 "url": "/api/rpc/trunks",
19733 "title": "Gets a list of RTTrunks",
19736 "title": "Example usage:",
19737 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19741 "name": "RTTrunks",
19742 "group": "RPC_Realtime",
19743 "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>",
19744 "version": "0.0.0",
19745 "filename": "server/api/rpc/index.js",
19746 "groupTitle": "RPC_Realtime"
19750 "url": "/api/rpc/voice/channels",
19751 "title": "Gets a list of RTVoiceChannelMixMonitor",
19754 "title": "Example usage:",
19755 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19759 "name": "RTVoiceChannelMixMonitor",
19760 "group": "RPC_Realtime",
19761 "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>",
19762 "version": "0.0.0",
19763 "filename": "server/api/rpc/index.js",
19764 "groupTitle": "RPC_Realtime"
19768 "url": "/api/rpc/voice/channels",
19769 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19772 "title": "Example usage:",
19773 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19777 "name": "RTVoiceChannelStopMixMonitor",
19778 "group": "RPC_Realtime",
19779 "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>",
19780 "version": "0.0.0",
19781 "filename": "server/api/rpc/index.js",
19782 "groupTitle": "RPC_Realtime"
19786 "url": "/api/rpc/voice/channels",
19787 "title": "Gets a list of RTVoiceChannels",
19790 "title": "Example usage:",
19791 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19795 "name": "RTVoiceChannels",
19796 "group": "RPC_Realtime",
19797 "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>",
19798 "version": "0.0.0",
19799 "filename": "server/api/rpc/index.js",
19800 "groupTitle": "RPC_Realtime"
19804 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19805 "title": "Gets a single RTVoiceQueueChannel",
19808 "title": "Example usage:",
19809 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19813 "name": "RTVoiceQueueChannel",
19814 "group": "RPC_Realtime",
19815 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19816 "version": "0.0.0",
19817 "filename": "server/api/rpc/index.js",
19818 "groupTitle": "RPC_Realtime"
19822 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19823 "title": "Hangup a single RTVoiceQueueChannel",
19826 "title": "Example usage:",
19827 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19831 "name": "RTVoiceQueueChannelHangup",
19832 "group": "RPC_Realtime",
19833 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19834 "version": "0.0.0",
19835 "filename": "server/api/rpc/index.js",
19836 "groupTitle": "RPC_Realtime"
19840 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19841 "title": "Hangup a single RTVoiceQueueChannel",
19844 "title": "Example usage:",
19845 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19849 "name": "RTVoiceQueueChannelRedirect",
19850 "group": "RPC_Realtime",
19851 "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>",
19852 "version": "0.0.0",
19853 "filename": "server/api/rpc/index.js",
19854 "groupTitle": "RPC_Realtime"
19858 "url": "/api/rpc/voice/queues/preview/{id}",
19859 "title": "Gets a single preview contact",
19862 "title": "Example usage:",
19863 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19867 "name": "RTVoiceQueuePreview",
19868 "group": "RPC_Realtime",
19869 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19870 "version": "0.0.0",
19871 "filename": "server/api/rpc/index.js",
19872 "groupTitle": "RPC_Realtime"
19876 "url": "/api/rpc/outbound",
19877 "title": "Gets a list of RTOutbound",
19880 "title": "Example usage:",
19881 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19885 "name": "RTVoiceQueues",
19886 "group": "RPC_Realtime",
19887 "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>",
19888 "version": "0.0.0",
19889 "filename": "server/api/rpc/index.js",
19890 "groupTitle": "RPC_Realtime"
19894 "url": "/api/rpc/voice/queues",
19895 "title": "Gets a list of RTVoiceQueues",
19898 "title": "Example usage:",
19899 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19903 "name": "RTVoiceQueues",
19904 "group": "RPC_Realtime",
19905 "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>",
19906 "version": "0.0.0",
19907 "filename": "server/api/rpc/index.js",
19908 "groupTitle": "RPC_Realtime"
19912 "url": "/api/rpc/voice/queues/channels",
19913 "title": "Gets a list of RTVoiceQueuesChannels",
19916 "title": "Example usage:",
19917 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19921 "name": "RTVoiceQueuesChannels",
19922 "group": "RPC_Realtime",
19923 "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>",
19924 "version": "0.0.0",
19925 "filename": "server/api/rpc/index.js",
19926 "groupTitle": "RPC_Realtime"
19930 "url": "/api/rpc/chat/queues/{id}",
19931 "title": "Gets a single RTChatQueue",
19934 "title": "Example usage:",
19935 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19939 "name": "ShowRTChatQueues",
19940 "group": "RPC_Realtime",
19941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19942 "version": "0.0.0",
19943 "filename": "server/api/rpc/index.js",
19944 "groupTitle": "RPC_Realtime"
19948 "url": "/api/rpc/fax/queues/{id}",
19949 "title": "Gets a single RTFaxQueue",
19952 "title": "Example usage:",
19953 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19957 "name": "ShowRTFaxQueues",
19958 "group": "RPC_Realtime",
19959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19960 "version": "0.0.0",
19961 "filename": "server/api/rpc/index.js",
19962 "groupTitle": "RPC_Realtime"
19966 "url": "/api/rpc/mail/queues/{id}",
19967 "title": "Gets a single RTMailQueue",
19970 "title": "Example usage:",
19971 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19975 "name": "ShowRTMailQueues",
19976 "group": "RPC_Realtime",
19977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19978 "version": "0.0.0",
19979 "filename": "server/api/rpc/index.js",
19980 "groupTitle": "RPC_Realtime"
19984 "url": "/api/rpc/openchannel/queues/{id}",
19985 "title": "Gets a single RTOpenchannelQueue",
19988 "title": "Example usage:",
19989 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19993 "name": "ShowRTOpenchannelQueues",
19994 "group": "RPC_Realtime",
19995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19996 "version": "0.0.0",
19997 "filename": "server/api/rpc/index.js",
19998 "groupTitle": "RPC_Realtime"
20002 "url": "/api/rpc/sms/queues/{id}",
20003 "title": "Gets a single RTSmsQueue",
20006 "title": "Example usage:",
20007 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20011 "name": "ShowRTSmsQueues",
20012 "group": "RPC_Realtime",
20013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20014 "version": "0.0.0",
20015 "filename": "server/api/rpc/index.js",
20016 "groupTitle": "RPC_Realtime"
20020 "url": "/api/rpc/voice/queues/{id}",
20021 "title": "Gets a single RTVoiceQueue",
20024 "title": "Example usage:",
20025 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20029 "name": "ShowRTVoiceQueues",
20030 "group": "RPC_Realtime",
20031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20032 "version": "0.0.0",
20033 "filename": "server/api/rpc/index.js",
20034 "groupTitle": "RPC_Realtime"
20038 "url": "/api/rpc/voice/{id}/queues",
20039 "title": "Updates a single VoiceQueue",
20042 "title": "Example usage:",
20043 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20047 "name": "UpdateVoiceQueues",
20048 "group": "RPC_Realtime",
20049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20050 "version": "0.0.0",
20051 "filename": "server/api/rpc/index.js",
20052 "groupTitle": "RPC_Realtime"
20056 "url": "/api/rpc/agents/:id/notify",
20057 "title": "Notify message to a specific agent",
20060 "title": "Example usage:",
20061 "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",
20065 "name": "agentNotify",
20066 "group": "RPC_Realtime",
20067 "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>",
20068 "version": "0.0.0",
20069 "filename": "server/api/rpc/index.js",
20070 "groupTitle": "RPC_Realtime"
20074 "url": "/api/rpc/chat/queues/:id/notify",
20075 "title": "Notify message to a specific queue",
20078 "title": "Example usage:",
20079 "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",
20083 "name": "chatQueueNotify",
20084 "group": "RPC_Realtime",
20085 "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>",
20086 "version": "0.0.0",
20087 "filename": "server/api/rpc/index.js",
20088 "groupTitle": "RPC_Realtime"
20092 "url": "/api/rpc/chat/queues/waitinginteractions",
20093 "title": "Gets a list of chatQueuesWaitingInteractions",
20096 "title": "Example usage:",
20097 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20101 "name": "chatQueuesWaitingInteractions",
20102 "group": "RPC_Realtime",
20103 "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>",
20104 "version": "0.0.0",
20105 "filename": "server/api/rpc/index.js",
20106 "groupTitle": "RPC_Realtime"
20110 "url": "/api/rpc/fax/queues/:id/notify",
20111 "title": "Notify message to a specific queue",
20114 "title": "Example usage:",
20115 "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",
20119 "name": "faxQueueNotify",
20120 "group": "RPC_Realtime",
20121 "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>",
20122 "version": "0.0.0",
20123 "filename": "server/api/rpc/index.js",
20124 "groupTitle": "RPC_Realtime"
20128 "url": "/api/rpc/fax/queues/waitinginteractions",
20129 "title": "Gets a list of faxQueuesWaitingInteractions",
20132 "title": "Example usage:",
20133 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20137 "name": "faxQueuesWaitingInteractions",
20138 "group": "RPC_Realtime",
20139 "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>",
20140 "version": "0.0.0",
20141 "filename": "server/api/rpc/index.js",
20142 "groupTitle": "RPC_Realtime"
20146 "url": "/api/rpc/mail/queues/:id/notify",
20147 "title": "Notify message to a specific queue",
20150 "title": "Example usage:",
20151 "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",
20155 "name": "mailQueueNotify",
20156 "group": "RPC_Realtime",
20157 "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>",
20158 "version": "0.0.0",
20159 "filename": "server/api/rpc/index.js",
20160 "groupTitle": "RPC_Realtime"
20164 "url": "/api/rpc/mail/queues/waitinginteractions",
20165 "title": "Gets a list of mailQueuesWaitingInteractions",
20168 "title": "Example usage:",
20169 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20173 "name": "mailQueuesWaitingInteractions",
20174 "group": "RPC_Realtime",
20175 "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>",
20176 "version": "0.0.0",
20177 "filename": "server/api/rpc/index.js",
20178 "groupTitle": "RPC_Realtime"
20182 "url": "/api/rpc/openchannel/queues/:id/notify",
20183 "title": "Notify message to a specific queue",
20186 "title": "Example usage:",
20187 "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",
20191 "name": "openchannelQueueNotify",
20192 "group": "RPC_Realtime",
20193 "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>",
20194 "version": "0.0.0",
20195 "filename": "server/api/rpc/index.js",
20196 "groupTitle": "RPC_Realtime"
20200 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20201 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20204 "title": "Example usage:",
20205 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20209 "name": "openchannelQueuesIdWaitingInteractions",
20210 "group": "RPC_Realtime",
20211 "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>",
20212 "version": "0.0.0",
20213 "filename": "server/api/rpc/index.js",
20214 "groupTitle": "RPC_Realtime"
20218 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20219 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20222 "title": "Example usage:",
20223 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20227 "name": "openchannelQueuesWaitingInteractions",
20228 "group": "RPC_Realtime",
20229 "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>",
20230 "version": "0.0.0",
20231 "filename": "server/api/rpc/index.js",
20232 "groupTitle": "RPC_Realtime"
20236 "url": "/api/rpc/sms/queues/:id/notify",
20237 "title": "Notify message to a specific queue",
20240 "title": "Example usage:",
20241 "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",
20245 "name": "smsQueueNotify",
20246 "group": "RPC_Realtime",
20247 "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>",
20248 "version": "0.0.0",
20249 "filename": "server/api/rpc/index.js",
20250 "groupTitle": "RPC_Realtime"
20254 "url": "/api/rpc/sms/queues/waitinginteractions",
20255 "title": "Gets a list of smsQueuesWaitingInteractions",
20258 "title": "Example usage:",
20259 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20263 "name": "smsQueuesWaitingInteractions",
20264 "group": "RPC_Realtime",
20265 "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>",
20266 "version": "0.0.0",
20267 "filename": "server/api/rpc/index.js",
20268 "groupTitle": "RPC_Realtime"
20272 "url": "/api/integrations/salesforce/accounts",
20273 "title": "Creates a new Salesforce Account",
20276 "title": "Example usage:",
20277 "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",
20281 "name": "CreateSalesforce_Accounts",
20282 "group": "Salesforce_Accounts",
20297 "field": "description",
20304 "field": "username",
20311 "field": "remoteUri",
20318 "field": "password",
20325 "field": "clientId",
20332 "field": "clientSecret",
20339 "field": "securityToken",
20346 "field": "serverUrl",
20353 "\"integrationTab\"",
20363 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20364 "version": "0.0.0",
20365 "filename": "server/api/intSalesforceAccount/index.js",
20366 "groupTitle": "Salesforce_Accounts"
20370 "url": "/api/integrations/salesforce/accounts/{id}",
20371 "title": "Deletes a Salesforce Account",
20374 "title": "Example usage:",
20375 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20379 "name": "DeleteSalesforce_Accounts",
20380 "group": "Salesforce_Accounts",
20381 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20382 "version": "0.0.0",
20383 "filename": "server/api/intSalesforceAccount/index.js",
20384 "groupTitle": "Salesforce_Accounts"
20388 "url": "/api/integrations/salesforce/accounts",
20389 "title": "Gets a list of Salesforce Accounts",
20392 "title": "Example usage:",
20393 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20397 "name": "GetSalesforce_Accounts",
20398 "group": "Salesforce_Accounts",
20399 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20400 "version": "0.0.0",
20401 "filename": "server/api/intSalesforceAccount/index.js",
20402 "groupTitle": "Salesforce_Accounts"
20406 "url": "/api/integrations/salesforce/accounts/{id}",
20407 "title": "Gets a single Salesforce Account",
20410 "title": "Example usage:",
20411 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20415 "name": "ShowSalesforce_Accounts",
20416 "group": "Salesforce_Accounts",
20417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20418 "version": "0.0.0",
20419 "filename": "server/api/intSalesforceAccount/index.js",
20420 "groupTitle": "Salesforce_Accounts"
20424 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20425 "title": "Creates new configuration",
20428 "title": "Example usage:",
20429 "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",
20433 "name": "addConfiguration",
20434 "group": "Salesforce_Accounts",
20435 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20436 "version": "0.0.0",
20437 "filename": "server/api/intSalesforceAccount/index.js",
20438 "groupTitle": "Salesforce_Accounts"
20442 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20443 "title": "Gets account configurations",
20446 "title": "Example usage:",
20447 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20451 "name": "getConfigurations",
20452 "group": "Salesforce_Accounts",
20453 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20454 "version": "0.0.0",
20455 "filename": "server/api/intSalesforceAccount/index.js",
20456 "groupTitle": "Salesforce_Accounts"
20460 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20461 "title": "Gets account fields",
20464 "title": "Example usage:",
20465 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20469 "name": "getFields",
20470 "group": "Salesforce_Accounts",
20471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20472 "version": "0.0.0",
20473 "filename": "server/api/intSalesforceAccount/index.js",
20474 "groupTitle": "Salesforce_Accounts"
20478 "url": "/api/integrations/salesforce/accounts/{id}",
20479 "title": "Update an existing Salesforce Account",
20482 "title": "Example usage:",
20483 "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",
20487 "name": "updateSalesforce_Accounts",
20488 "group": "Salesforce_Accounts",
20489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20490 "version": "0.0.0",
20491 "filename": "server/api/intSalesforceAccount/index.js",
20492 "groupTitle": "Salesforce_Accounts"
20496 "url": "/api/integrations/salesforce/configurations",
20497 "title": "Creates a new Salesforce Configuration",
20500 "title": "Example usage:",
20501 "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",
20505 "name": "CreateSalesforce_Configurations",
20506 "group": "Salesforce_Configurations",
20521 "field": "description",
20532 "field": "ticketType",
20539 "\"contact_lead\"",
20542 "\"account_contact_lead\"",
20546 "field": "moduleSearch",
20559 "field": "moduleCreate",
20573 "field": "additionalSearchAccount",
20580 "field": "additionalSearchContact",
20587 "field": "additionalSearchLead",
20593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20594 "version": "0.0.0",
20595 "filename": "server/api/intSalesforceConfiguration/index.js",
20596 "groupTitle": "Salesforce_Configurations"
20600 "url": "/api/integrations/salesforce/configurations/{id}",
20601 "title": "Deletes a Salesforce Configuration",
20604 "title": "Example usage:",
20605 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20609 "name": "DeleteSalesforce_Configurations",
20610 "group": "Salesforce_Configurations",
20611 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20612 "version": "0.0.0",
20613 "filename": "server/api/intSalesforceConfiguration/index.js",
20614 "groupTitle": "Salesforce_Configurations"
20618 "url": "/api/integrations/salesforce/configurations",
20619 "title": "Gets a list of Salesforce Configurations",
20622 "title": "Example usage:",
20623 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20627 "name": "GetSalesforce_Configurations",
20628 "group": "Salesforce_Configurations",
20629 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20630 "version": "0.0.0",
20631 "filename": "server/api/intSalesforceConfiguration/index.js",
20632 "groupTitle": "Salesforce_Configurations"
20636 "url": "/api/integrations/salesforce/configurations/{id}",
20637 "title": "Gets a single Salesforce Configuration",
20640 "title": "Example usage:",
20641 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20645 "name": "ShowSalesforce_Configurations",
20646 "group": "Salesforce_Configurations",
20647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20648 "version": "0.0.0",
20649 "filename": "server/api/intSalesforceConfiguration/index.js",
20650 "groupTitle": "Salesforce_Configurations"
20654 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20655 "title": "Gets configurations descriptions",
20658 "title": "Example usage:",
20659 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20663 "name": "getDescriptions",
20664 "group": "Salesforce_Configurations",
20665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20666 "version": "0.0.0",
20667 "filename": "server/api/intSalesforceConfiguration/index.js",
20668 "groupTitle": "Salesforce_Configurations"
20672 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20673 "title": "Gets configurations fields",
20676 "title": "Example usage:",
20677 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20681 "name": "getFields",
20682 "group": "Salesforce_Configurations",
20683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20684 "version": "0.0.0",
20685 "filename": "server/api/intSalesforceConfiguration/index.js",
20686 "groupTitle": "Salesforce_Configurations"
20690 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20691 "title": "Gets configurations subjects",
20694 "title": "Example usage:",
20695 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20699 "name": "getSubjects",
20700 "group": "Salesforce_Configurations",
20701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20702 "version": "0.0.0",
20703 "filename": "server/api/intSalesforceConfiguration/index.js",
20704 "groupTitle": "Salesforce_Configurations"
20708 "url": "/api/integrations/salesforce/configurations/{id}",
20709 "title": "Update an existing Salesforce Configuration",
20712 "title": "Example usage:",
20713 "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",
20717 "name": "updateSalesforce_Configurations",
20718 "group": "Salesforce_Configurations",
20719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20720 "version": "0.0.0",
20721 "filename": "server/api/intSalesforceConfiguration/index.js",
20722 "groupTitle": "Salesforce_Configurations"
20726 "url": "/api/integrations/salesforce/fields",
20727 "title": "Creates a new Salesforce Field",
20730 "title": "Example usage:",
20731 "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",
20735 "name": "CreateSalesforce_Fields",
20736 "group": "Salesforce_Fields",
20746 "\"customVariable\"",
20758 "field": "content",
20774 "\"customVariable\""
20777 "field": "keyType",
20784 "field": "keyContent",
20791 "field": "idField",
20798 "field": "variableName",
20804 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20805 "version": "0.0.0",
20806 "filename": "server/api/intSalesforceField/index.js",
20807 "groupTitle": "Salesforce_Fields"
20811 "url": "/api/integrations/salesforce/fields/{id}",
20812 "title": "Deletes a Salesforce Field",
20815 "title": "Example usage:",
20816 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20820 "name": "DeleteSalesforce_Fields",
20821 "group": "Salesforce_Fields",
20822 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20823 "version": "0.0.0",
20824 "filename": "server/api/intSalesforceField/index.js",
20825 "groupTitle": "Salesforce_Fields"
20829 "url": "/api/integrations/salesforce/fields",
20830 "title": "Gets a list of Salesforce Fields",
20833 "title": "Example usage:",
20834 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20838 "name": "GetSalesforce_Fields",
20839 "group": "Salesforce_Fields",
20840 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20841 "version": "0.0.0",
20842 "filename": "server/api/intSalesforceField/index.js",
20843 "groupTitle": "Salesforce_Fields"
20847 "url": "/api/integrations/salesforce/fields/{id}",
20848 "title": "Gets a single Salesforce Field",
20851 "title": "Example usage:",
20852 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20856 "name": "ShowSalesforce_Fields",
20857 "group": "Salesforce_Fields",
20858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20859 "version": "0.0.0",
20860 "filename": "server/api/intSalesforceField/index.js",
20861 "groupTitle": "Salesforce_Fields"
20865 "url": "/api/integrations/salesforce/fields/{id}",
20866 "title": "Update an existing Salesforce Field",
20869 "title": "Example usage:",
20870 "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",
20874 "name": "updateSalesforce_Fields",
20875 "group": "Salesforce_Fields",
20876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20877 "version": "0.0.0",
20878 "filename": "server/api/intSalesforceField/index.js",
20879 "groupTitle": "Salesforce_Fields"
20883 "url": "/api/schedules",
20884 "title": "Creates a new Schedule",
20887 "title": "Example usage:",
20888 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20892 "name": "CreateSchedules",
20893 "group": "Schedules",
20908 "field": "description",
20929 "field": "startAt",
20943 "field": "subtractNumber",
20959 "field": "subtractUnit",
20989 "field": "sendMail",
21017 "field": "sendIfEmpty",
21023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21024 "version": "0.0.0",
21025 "filename": "server/api/schedule/index.js",
21026 "groupTitle": "Schedules"
21030 "url": "/api/schedules/{id}",
21031 "title": "Deletes a Schedule",
21034 "title": "Example usage:",
21035 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21039 "name": "DeleteSchedules",
21040 "group": "Schedules",
21041 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21042 "version": "0.0.0",
21043 "filename": "server/api/schedule/index.js",
21044 "groupTitle": "Schedules"
21048 "url": "/api/schedules",
21049 "title": "Gets a list of Schedules",
21052 "title": "Example usage:",
21053 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21057 "name": "GetSchedules",
21058 "group": "Schedules",
21059 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21060 "version": "0.0.0",
21061 "filename": "server/api/schedule/index.js",
21062 "groupTitle": "Schedules"
21066 "url": "/api/schedules/{id}",
21067 "title": "Gets a single Schedule",
21070 "title": "Example usage:",
21071 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21075 "name": "ShowSchedules",
21076 "group": "Schedules",
21077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21078 "version": "0.0.0",
21079 "filename": "server/api/schedule/index.js",
21080 "groupTitle": "Schedules"
21084 "url": "/api/schedules/{id}/run",
21085 "title": "Run Scheduler",
21088 "title": "Example usage:",
21089 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21094 "group": "Schedules",
21095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21096 "version": "0.0.0",
21097 "filename": "server/api/schedule/index.js",
21098 "groupTitle": "Schedules"
21102 "url": "/api/schedules/{id}",
21103 "title": "Update an existing Schedule",
21106 "title": "Example usage:",
21107 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21111 "name": "updateSchedules",
21112 "group": "Schedules",
21113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21114 "version": "0.0.0",
21115 "filename": "server/api/schedule/index.js",
21116 "groupTitle": "Schedules"
21120 "url": "/api/screen/recordings",
21121 "title": "Creates a new Recording",
21124 "title": "Example usage:",
21125 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21129 "name": "CreateRecordings",
21130 "group": "Screen_Recordings",
21145 "field": "interactionid",
21152 "field": "channel",
21173 "field": "duration",
21180 "field": "startedAt",
21187 "field": "closedAt",
21194 "field": "createdAt",
21201 "field": "updatedAt",
21207 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21208 "version": "0.0.0",
21209 "filename": "server/api/screenRecording/index.js",
21210 "groupTitle": "Screen_Recordings"
21214 "url": "/api/screen/recordings/describe",
21215 "title": "Gets table info about Recordings",
21218 "title": "Example usage:",
21219 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21223 "name": "DescribeRecordings",
21224 "group": "Screen_Recordings",
21225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21226 "version": "0.0.0",
21227 "filename": "server/api/screenRecording/index.js",
21228 "groupTitle": "Screen_Recordings"
21232 "url": "/api/screen/recordings",
21233 "title": "Gets a list of Recordings",
21236 "title": "Example usage:",
21237 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21241 "name": "GetRecordings",
21242 "group": "Screen_Recordings",
21243 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21244 "version": "0.0.0",
21245 "filename": "server/api/screenRecording/index.js",
21246 "groupTitle": "Screen_Recordings"
21250 "url": "/api/screen/recordings/{id}",
21251 "title": "Gets a single Recording",
21254 "title": "Example usage:",
21255 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21259 "name": "ShowRecordings",
21260 "group": "Screen_Recordings",
21261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21262 "version": "0.0.0",
21263 "filename": "server/api/screenRecording/index.js",
21264 "groupTitle": "Screen_Recordings"
21268 "url": "/api/screen/recordings/{id}",
21269 "title": "Delete screen recording",
21272 "title": "Example usage:",
21273 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21278 "group": "Screen_Recordings",
21279 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21280 "version": "0.0.0",
21281 "filename": "server/api/screenRecording/index.js",
21282 "groupTitle": "Screen_Recordings"
21286 "url": "/api/screen/recordings/{id}/download",
21287 "title": "Download Recording",
21290 "title": "Example usage:",
21291 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21295 "name": "download",
21296 "group": "Screen_Recordings",
21297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21298 "version": "0.0.0",
21299 "filename": "server/api/screenRecording/index.js",
21300 "groupTitle": "Screen_Recordings"
21304 "url": "/api/screen/recordings/{id}",
21305 "title": "Update an existing Recording",
21308 "title": "Example usage:",
21309 "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",
21313 "name": "updateRecordings",
21314 "group": "Screen_Recordings",
21315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21316 "version": "0.0.0",
21317 "filename": "server/api/screenRecording/index.js",
21318 "groupTitle": "Screen_Recordings"
21322 "url": "/api/integrations/servicenow/accounts",
21323 "title": "Creates a new Servicenow Account",
21326 "title": "Example usage:",
21327 "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",
21331 "name": "CreateServicenow_Accounts",
21332 "group": "Servicenow_Accounts",
21347 "field": "description",
21354 "field": "username",
21361 "field": "password",
21375 "field": "remoteUri",
21382 "field": "serverUrl",
21388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21389 "version": "0.0.0",
21390 "filename": "server/api/intServicenowAccount/index.js",
21391 "groupTitle": "Servicenow_Accounts"
21395 "url": "/api/integrations/servicenow/accounts/{id}",
21396 "title": "Deletes a Servicenow Account",
21399 "title": "Example usage:",
21400 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21404 "name": "DeleteServicenow_Accounts",
21405 "group": "Servicenow_Accounts",
21406 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21407 "version": "0.0.0",
21408 "filename": "server/api/intServicenowAccount/index.js",
21409 "groupTitle": "Servicenow_Accounts"
21413 "url": "/api/integrations/servicenow/accounts",
21414 "title": "Gets a list of Servicenow Accounts",
21417 "title": "Example usage:",
21418 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21422 "name": "GetServicenow_Accounts",
21423 "group": "Servicenow_Accounts",
21424 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21425 "version": "0.0.0",
21426 "filename": "server/api/intServicenowAccount/index.js",
21427 "groupTitle": "Servicenow_Accounts"
21431 "url": "/api/integrations/servicenow/accounts/{id}",
21432 "title": "Gets a single Servicenow Account",
21435 "title": "Example usage:",
21436 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21440 "name": "ShowServicenow_Accounts",
21441 "group": "Servicenow_Accounts",
21442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443 "version": "0.0.0",
21444 "filename": "server/api/intServicenowAccount/index.js",
21445 "groupTitle": "Servicenow_Accounts"
21449 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21450 "title": "Creates new configuration",
21453 "title": "Example usage:",
21454 "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",
21458 "name": "addConfiguration",
21459 "group": "Servicenow_Accounts",
21460 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461 "version": "0.0.0",
21462 "filename": "server/api/intServicenowAccount/index.js",
21463 "groupTitle": "Servicenow_Accounts"
21467 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21468 "title": "Gets account configurations",
21471 "title": "Example usage:",
21472 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21476 "name": "getConfigurations",
21477 "group": "Servicenow_Accounts",
21478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21479 "version": "0.0.0",
21480 "filename": "server/api/intServicenowAccount/index.js",
21481 "groupTitle": "Servicenow_Accounts"
21485 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21486 "title": "Gets account fields",
21489 "title": "Example usage:",
21490 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21494 "name": "getFields",
21495 "group": "Servicenow_Accounts",
21496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21497 "version": "0.0.0",
21498 "filename": "server/api/intServicenowAccount/index.js",
21499 "groupTitle": "Servicenow_Accounts"
21503 "url": "/api/integrations/servicenow/accounts/{id}",
21504 "title": "Update an existing Servicenow Account",
21507 "title": "Example usage:",
21508 "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",
21512 "name": "updateServicenow_Accounts",
21513 "group": "Servicenow_Accounts",
21514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21515 "version": "0.0.0",
21516 "filename": "server/api/intServicenowAccount/index.js",
21517 "groupTitle": "Servicenow_Accounts"
21521 "url": "/api/integrations/servicenow/configurations",
21522 "title": "Creates a new Servicenow Configuration",
21525 "title": "Example usage:",
21526 "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",
21530 "name": "CreateServicenow_Configurations",
21531 "group": "Servicenow_Configurations",
21546 "field": "description",
21552 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21553 "version": "0.0.0",
21554 "filename": "server/api/intServicenowConfiguration/index.js",
21555 "groupTitle": "Servicenow_Configurations"
21559 "url": "/api/integrations/servicenow/configurations/{id}",
21560 "title": "Deletes a Servicenow Configuration",
21563 "title": "Example usage:",
21564 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21568 "name": "DeleteServicenow_Configurations",
21569 "group": "Servicenow_Configurations",
21570 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21571 "version": "0.0.0",
21572 "filename": "server/api/intServicenowConfiguration/index.js",
21573 "groupTitle": "Servicenow_Configurations"
21577 "url": "/api/integrations/servicenow/configurations",
21578 "title": "Gets a list of Servicenow Configurations",
21581 "title": "Example usage:",
21582 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21586 "name": "GetServicenow_Configurations",
21587 "group": "Servicenow_Configurations",
21588 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21589 "version": "0.0.0",
21590 "filename": "server/api/intServicenowConfiguration/index.js",
21591 "groupTitle": "Servicenow_Configurations"
21595 "url": "/api/integrations/servicenow/configurations/{id}",
21596 "title": "Gets a single Servicenow Configuration",
21599 "title": "Example usage:",
21600 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21604 "name": "ShowServicenow_Configurations",
21605 "group": "Servicenow_Configurations",
21606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21607 "version": "0.0.0",
21608 "filename": "server/api/intServicenowConfiguration/index.js",
21609 "groupTitle": "Servicenow_Configurations"
21613 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21614 "title": "Gets configurations descriptions",
21617 "title": "Example usage:",
21618 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21622 "name": "getDescriptions",
21623 "group": "Servicenow_Configurations",
21624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21625 "version": "0.0.0",
21626 "filename": "server/api/intServicenowConfiguration/index.js",
21627 "groupTitle": "Servicenow_Configurations"
21631 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21632 "title": "Gets configurations fields",
21635 "title": "Example usage:",
21636 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21640 "name": "getFields",
21641 "group": "Servicenow_Configurations",
21642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21643 "version": "0.0.0",
21644 "filename": "server/api/intServicenowConfiguration/index.js",
21645 "groupTitle": "Servicenow_Configurations"
21649 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21650 "title": "Gets configurations subjects",
21653 "title": "Example usage:",
21654 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21658 "name": "getSubjects",
21659 "group": "Servicenow_Configurations",
21660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21661 "version": "0.0.0",
21662 "filename": "server/api/intServicenowConfiguration/index.js",
21663 "groupTitle": "Servicenow_Configurations"
21667 "url": "/api/integrations/servicenow/configurations/{id}",
21668 "title": "Update an existing Servicenow Configuration",
21671 "title": "Example usage:",
21672 "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",
21676 "name": "updateServicenow_Configurations",
21677 "group": "Servicenow_Configurations",
21678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21679 "version": "0.0.0",
21680 "filename": "server/api/intServicenowConfiguration/index.js",
21681 "groupTitle": "Servicenow_Configurations"
21685 "url": "/api/integrations/servicenow/fields",
21686 "title": "Creates a new Servicenow Field",
21689 "title": "Example usage:",
21690 "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",
21694 "name": "CreateServicenow_Fields",
21695 "group": "Servicenow_Fields",
21705 "\"customVariable\"",
21717 "field": "content",
21733 "\"customVariable\""
21736 "field": "keyType",
21743 "field": "keyContent",
21750 "field": "idField",
21757 "field": "nameField",
21764 "field": "customField",
21771 "field": "variableName",
21777 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21778 "version": "0.0.0",
21779 "filename": "server/api/intServicenowField/index.js",
21780 "groupTitle": "Servicenow_Fields"
21784 "url": "/api/integrations/servicenow/fields/{id}",
21785 "title": "Deletes a Servicenow Field",
21788 "title": "Example usage:",
21789 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21793 "name": "DeleteServicenow_Fields",
21794 "group": "Servicenow_Fields",
21795 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21796 "version": "0.0.0",
21797 "filename": "server/api/intServicenowField/index.js",
21798 "groupTitle": "Servicenow_Fields"
21802 "url": "/api/integrations/servicenow/fields",
21803 "title": "Gets a list of Servicenow Fields",
21806 "title": "Example usage:",
21807 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21811 "name": "GetServicenow_Fields",
21812 "group": "Servicenow_Fields",
21813 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21814 "version": "0.0.0",
21815 "filename": "server/api/intServicenowField/index.js",
21816 "groupTitle": "Servicenow_Fields"
21820 "url": "/api/integrations/servicenow/fields/{id}",
21821 "title": "Gets a single Servicenow Field",
21824 "title": "Example usage:",
21825 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21829 "name": "ShowServicenow_Fields",
21830 "group": "Servicenow_Fields",
21831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21832 "version": "0.0.0",
21833 "filename": "server/api/intServicenowField/index.js",
21834 "groupTitle": "Servicenow_Fields"
21838 "url": "/api/integrations/servicenow/fields/{id}",
21839 "title": "Update an existing Servicenow Field",
21842 "title": "Example usage:",
21843 "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",
21847 "name": "updateServicenow_Fields",
21848 "group": "Servicenow_Fields",
21849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21850 "version": "0.0.0",
21851 "filename": "server/api/intServicenowField/index.js",
21852 "groupTitle": "Servicenow_Fields"
21856 "url": "/api/settings",
21857 "title": "Gets a list of Settings",
21860 "title": "Example usage:",
21861 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21865 "name": "GetSettings",
21866 "group": "Settings",
21867 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
21868 "version": "0.0.0",
21869 "filename": "server/api/setting/index.js",
21870 "groupTitle": "Settings"
21874 "url": "/api/settings/{id}",
21875 "title": "Gets a single Setting",
21878 "title": "Example usage:",
21879 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21883 "name": "ShowSettings",
21884 "group": "Settings",
21885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21886 "version": "0.0.0",
21887 "filename": "server/api/setting/index.js",
21888 "groupTitle": "Settings"
21892 "url": "/api/settings/{id}/favicon",
21893 "title": "Add Favicon",
21896 "title": "Example usage:",
21897 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21901 "name": "addFavicon",
21902 "group": "Settings",
21903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21904 "version": "0.0.0",
21905 "filename": "server/api/setting/index.js",
21906 "groupTitle": "Settings"
21910 "url": "/api/settings/{id}/logo",
21911 "title": "Add logo",
21914 "title": "Example usage:",
21915 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21920 "group": "Settings",
21921 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21922 "version": "0.0.0",
21923 "filename": "server/api/setting/index.js",
21924 "groupTitle": "Settings"
21928 "url": "/api/settings/{id}/logo_login",
21929 "title": "Add logo login",
21932 "title": "Example usage:",
21933 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21937 "name": "addLogoLogin",
21938 "group": "Settings",
21939 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21940 "version": "0.0.0",
21941 "filename": "server/api/setting/index.js",
21942 "groupTitle": "Settings"
21946 "url": "/api/settings/{id}/preferred",
21947 "title": "Add Preferred",
21950 "title": "Example usage:",
21951 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21955 "name": "addPreferred",
21956 "group": "Settings",
21957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21958 "version": "0.0.0",
21959 "filename": "server/api/setting/index.js",
21960 "groupTitle": "Settings"
21964 "url": "/api/settings/now",
21965 "title": "Get Server Current Date",
21968 "title": "Example usage:",
21969 "content": "curl https://{domain}/api/settings/now -v -X GET",
21974 "group": "Settings",
21975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21976 "version": "0.0.0",
21977 "filename": "server/api/setting/index.js",
21978 "groupTitle": "Settings"
21982 "url": "/api/settings/{id}/favicon",
21983 "title": "Get Favicon",
21986 "title": "Example usage:",
21987 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21991 "name": "getFavicon",
21992 "group": "Settings",
21993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21994 "version": "0.0.0",
21995 "filename": "server/api/setting/index.js",
21996 "groupTitle": "Settings"
22000 "url": "/api/settings/{id}/gdpr",
22001 "title": "Get gdpr settings",
22004 "title": "Example usage:",
22005 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22010 "group": "Settings",
22011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22012 "version": "0.0.0",
22013 "filename": "server/api/setting/index.js",
22014 "groupTitle": "Settings"
22018 "url": "/api/settings/{id}/logo",
22019 "title": "Get logo",
22022 "title": "Example usage:",
22023 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22028 "group": "Settings",
22029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22030 "version": "0.0.0",
22031 "filename": "server/api/setting/index.js",
22032 "groupTitle": "Settings"
22036 "url": "/api/settings/{id}/logo_login",
22037 "title": "Get logo login",
22040 "title": "Example usage:",
22041 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22045 "name": "getLogoLogin",
22046 "group": "Settings",
22047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22048 "version": "0.0.0",
22049 "filename": "server/api/setting/index.js",
22050 "groupTitle": "Settings"
22054 "url": "/api/settings/{id}/preferred",
22055 "title": "Get Preferred",
22058 "title": "Example usage:",
22059 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22063 "name": "getPreferred",
22064 "group": "Settings",
22065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22066 "version": "0.0.0",
22067 "filename": "server/api/setting/index.js",
22068 "groupTitle": "Settings"
22072 "url": "/api/settings/{id}",
22073 "title": "Update an existing Setting",
22076 "title": "Example usage:",
22077 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22081 "name": "updateSettings",
22082 "group": "Settings",
22083 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22084 "version": "0.0.0",
22085 "filename": "server/api/setting/index.js",
22086 "groupTitle": "Settings"
22090 "url": "/api/sms/accounts/{id}/users",
22091 "title": "Add agents to a sms account",
22094 "title": "Example usage:",
22095 "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",
22099 "name": "AddAgents",
22100 "group": "Sms_Accounts",
22101 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22102 "version": "0.0.0",
22103 "filename": "server/api/smsAccount/index.js",
22104 "groupTitle": "Sms_Accounts"
22108 "url": "/api/sms/accounts",
22109 "title": "Creates a new Account",
22112 "title": "Example usage:",
22113 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22117 "name": "CreateAccounts",
22118 "group": "Sms_Accounts",
22180 "field": "accountSid",
22194 "field": "authToken",
22206 "field": "smsMethod",
22213 "field": "username",
22220 "field": "password",
22234 "field": "applicationId",
22241 "field": "accountId",
22248 "field": "senderString",
22255 "field": "deliveryReport",
22262 "field": "description",
22269 "field": "notificationTemplate",
22276 "field": "notificationSound",
22283 "field": "notificationShake",
22290 "field": "waitForTheAssignedAgent",
22297 "field": "queueTransfer",
22304 "field": "queueTransferTimeout",
22311 "field": "agentTransfer",
22318 "field": "agentTransferTimeout",
22325 "field": "baseUrl",
22332 "field": "mandatoryDispositionPauseId",
22333 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22339 "field": "mandatoryDisposition",
22340 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22345 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22346 "version": "0.0.0",
22347 "filename": "server/api/smsAccount/index.js",
22348 "groupTitle": "Sms_Accounts"
22352 "url": "/api/sms/accounts/{id}",
22353 "title": "Deletes a Account",
22356 "title": "Example usage:",
22357 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22361 "name": "DeleteAccounts",
22362 "group": "Sms_Accounts",
22363 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22364 "version": "0.0.0",
22365 "filename": "server/api/smsAccount/index.js",
22366 "groupTitle": "Sms_Accounts"
22370 "url": "/api/sms/accounts/describe",
22371 "title": "Gets table info about Accounts",
22374 "title": "Example usage:",
22375 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22379 "name": "DescribeAccounts",
22380 "group": "Sms_Accounts",
22381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22382 "version": "0.0.0",
22383 "filename": "server/api/smsAccount/index.js",
22384 "groupTitle": "Sms_Accounts"
22388 "url": "/api/sms/accounts",
22389 "title": "Gets a list of Accounts",
22392 "title": "Example usage:",
22393 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22397 "name": "GetAccounts",
22398 "group": "Sms_Accounts",
22399 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22400 "version": "0.0.0",
22401 "filename": "server/api/smsAccount/index.js",
22402 "groupTitle": "Sms_Accounts"
22406 "url": "/api/sms/accounts/{id}/users",
22407 "title": "Gets agents from sms account",
22410 "title": "Example usage:",
22411 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22415 "name": "GetAgents",
22416 "group": "Sms_Accounts",
22417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22418 "version": "0.0.0",
22419 "filename": "server/api/smsAccount/index.js",
22420 "groupTitle": "Sms_Accounts"
22424 "url": "/api/sms/accounts/{id}/users",
22425 "title": "Removes agents from a sms account",
22428 "title": "Example usage:",
22429 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22433 "name": "RemoveAgents",
22434 "group": "Sms_Accounts",
22435 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22436 "version": "0.0.0",
22437 "filename": "server/api/smsAccount/index.js",
22438 "groupTitle": "Sms_Accounts"
22442 "url": "/api/sms/accounts/{id}/canned_answers",
22443 "title": "Removes canned answers from account",
22446 "title": "Example usage:",
22447 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22451 "name": "RemoveAnswers",
22452 "group": "Sms_Accounts",
22453 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22454 "version": "0.0.0",
22455 "filename": "server/api/smsAccount/index.js",
22456 "groupTitle": "Sms_Accounts"
22460 "url": "/api/sms/accounts/{id}/dispositions",
22461 "title": "Removes dispositions from account",
22464 "title": "Example usage:",
22465 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22469 "name": "RemoveDispositions",
22470 "group": "Sms_Accounts",
22471 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22472 "version": "0.0.0",
22473 "filename": "server/api/smsAccount/index.js",
22474 "groupTitle": "Sms_Accounts"
22478 "url": "/api/sms/accounts/{id}",
22479 "title": "Gets a single Account",
22482 "title": "Example usage:",
22483 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22487 "name": "ShowAccounts",
22488 "group": "Sms_Accounts",
22489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22490 "version": "0.0.0",
22491 "filename": "server/api/smsAccount/index.js",
22492 "groupTitle": "Sms_Accounts"
22496 "url": "/api/sms/messages/{id}/accept",
22497 "title": "Accepts message",
22500 "title": "Example usage:",
22501 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22505 "name": "acceptMessage",
22506 "group": "Sms_Accounts",
22507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22508 "version": "0.0.0",
22509 "filename": "server/api/smsMessage/index.js",
22510 "groupTitle": "Sms_Accounts"
22514 "url": "/api/sms/accounts/{id}/canned_answers",
22515 "title": "Creates new canned answer",
22518 "title": "Example usage:",
22519 "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",
22523 "name": "addAnswer",
22524 "group": "Sms_Accounts",
22546 "field": "description",
22559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22560 "version": "0.0.0",
22561 "filename": "server/api/smsAccount/index.js",
22562 "groupTitle": "Sms_Accounts"
22566 "url": "/api/sms/accounts/{id}/applications",
22567 "title": "Creates new applications",
22570 "title": "Example usage:",
22571 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22575 "name": "addApplications",
22576 "group": "Sms_Accounts",
22584 "field": "priority",
22598 "field": "appdata",
22605 "field": "description",
22612 "field": "interval",
22618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22619 "version": "0.0.0",
22620 "filename": "server/api/smsAccount/index.js",
22621 "groupTitle": "Sms_Accounts"
22625 "url": "/api/sms/accounts/{id}/dispositions",
22626 "title": "Creates new disposition",
22629 "title": "Example usage:",
22630 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22634 "name": "addDisposition",
22635 "group": "Sms_Accounts",
22662 "field": "description",
22668 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22669 "version": "0.0.0",
22670 "filename": "server/api/smsAccount/index.js",
22671 "groupTitle": "Sms_Accounts"
22675 "url": "/api/sms/accounts/{id}/canned_answers",
22676 "title": "Gets account canned answers",
22679 "title": "Example usage:",
22680 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22684 "name": "getAnswers",
22685 "group": "Sms_Accounts",
22686 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22687 "version": "0.0.0",
22688 "filename": "server/api/smsAccount/index.js",
22689 "groupTitle": "Sms_Accounts"
22693 "url": "/api/sms/accounts/{id}/applications",
22694 "title": "Gets account applications",
22697 "title": "Example usage:",
22698 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22702 "name": "getApplications",
22703 "group": "Sms_Accounts",
22704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22705 "version": "0.0.0",
22706 "filename": "server/api/smsAccount/index.js",
22707 "groupTitle": "Sms_Accounts"
22711 "url": "/api/sms/accounts/{id}/dispositions",
22712 "title": "Gets account dispositions",
22715 "title": "Example usage:",
22716 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22720 "name": "getDispositions",
22721 "group": "Sms_Accounts",
22722 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22723 "version": "0.0.0",
22724 "filename": "server/api/smsAccount/index.js",
22725 "groupTitle": "Sms_Accounts"
22729 "url": "/api/sms/accounts/{id}/interactions",
22730 "title": "Gets Sms Account interactions",
22733 "title": "Example usage:",
22734 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22738 "name": "getInteractions",
22739 "group": "Sms_Accounts",
22740 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22741 "version": "0.0.0",
22742 "filename": "server/api/smsAccount/index.js",
22743 "groupTitle": "Sms_Accounts"
22747 "url": "/api/sms/accounts/{id}/notify",
22748 "title": "Notify new message",
22751 "title": "Example usage:",
22752 "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",
22757 "group": "Sms_Accounts",
22758 "description": "<p>Motion 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>",
22759 "version": "0.0.0",
22760 "filename": "server/api/smsAccount/index.js",
22761 "groupTitle": "Sms_Accounts"
22765 "url": "/api/sms/messages/{id}/reject",
22766 "title": "Rejects message",
22769 "title": "Example usage:",
22770 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22774 "name": "rejectMessage",
22775 "group": "Sms_Accounts",
22776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22777 "version": "0.0.0",
22778 "filename": "server/api/smsMessage/index.js",
22779 "groupTitle": "Sms_Accounts"
22783 "url": "/api/sms/accounts/{id}/send",
22784 "title": "Send new sms message",
22787 "title": "Example usage:",
22788 "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",
22793 "group": "Sms_Accounts",
22794 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22795 "version": "0.0.0",
22796 "filename": "server/api/smsAccount/index.js",
22797 "groupTitle": "Sms_Accounts"
22801 "url": "/api/sms/accounts/{id}/status",
22802 "title": "Receive message status as get request",
22805 "title": "Example usage:",
22806 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22810 "name": "statusMessage",
22811 "group": "Sms_Accounts",
22812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22813 "version": "0.0.0",
22814 "filename": "server/api/smsAccount/index.js",
22815 "groupTitle": "Sms_Accounts"
22819 "url": "/api/sms/messages/{id}/status",
22820 "title": "Receive message status",
22823 "title": "Example usage:",
22824 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22828 "name": "statusMessage",
22829 "group": "Sms_Accounts",
22830 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22831 "version": "0.0.0",
22832 "filename": "server/api/smsMessage/index.js",
22833 "groupTitle": "Sms_Accounts"
22837 "url": "/api/sms/accounts/{id}/status",
22838 "title": "Receive message status",
22841 "title": "Example usage:",
22842 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22846 "name": "statusMessage",
22847 "group": "Sms_Accounts",
22848 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22849 "version": "0.0.0",
22850 "filename": "server/api/smsAccount/index.js",
22851 "groupTitle": "Sms_Accounts"
22855 "url": "/api/sms/accounts/{id}",
22856 "title": "Update an existing Account",
22859 "title": "Example usage:",
22860 "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",
22864 "name": "updateAccounts",
22865 "group": "Sms_Accounts",
22866 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22867 "version": "0.0.0",
22868 "filename": "server/api/smsAccount/index.js",
22869 "groupTitle": "Sms_Accounts"
22873 "url": "/api/sms/applications",
22874 "title": "Creates a new Application",
22877 "title": "Example usage:",
22878 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22882 "name": "CreateApplications",
22883 "group": "Sms_Applications",
22891 "field": "priority",
22905 "field": "appdata",
22912 "field": "description",
22919 "field": "interval",
22925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22926 "version": "0.0.0",
22927 "filename": "server/api/smsApplication/index.js",
22928 "groupTitle": "Sms_Applications"
22932 "url": "/api/sms/applications/{id}",
22933 "title": "Deletes a Application",
22936 "title": "Example usage:",
22937 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22941 "name": "DeleteApplications",
22942 "group": "Sms_Applications",
22943 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22944 "version": "0.0.0",
22945 "filename": "server/api/smsApplication/index.js",
22946 "groupTitle": "Sms_Applications"
22950 "url": "/api/sms/applications",
22951 "title": "Gets a list of Applications",
22954 "title": "Example usage:",
22955 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22959 "name": "GetApplications",
22960 "group": "Sms_Applications",
22961 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22962 "version": "0.0.0",
22963 "filename": "server/api/smsApplication/index.js",
22964 "groupTitle": "Sms_Applications"
22968 "url": "/api/sms/applications/{id}",
22969 "title": "Gets a single Application",
22972 "title": "Example usage:",
22973 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22977 "name": "ShowApplications",
22978 "group": "Sms_Applications",
22979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22980 "version": "0.0.0",
22981 "filename": "server/api/smsApplication/index.js",
22982 "groupTitle": "Sms_Applications"
22986 "url": "/api/sms/applications/{id}",
22987 "title": "Update an existing Application",
22990 "title": "Example usage:",
22991 "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",
22995 "name": "updateApplications",
22996 "group": "Sms_Applications",
22997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22998 "version": "0.0.0",
22999 "filename": "server/api/smsApplication/index.js",
23000 "groupTitle": "Sms_Applications"
23004 "url": "/api/sms/interactions/{id}/tags",
23005 "title": "Add tags to the interaction",
23008 "title": "Example usage:",
23009 "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",
23014 "group": "Sms_Interactions",
23015 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23016 "version": "0.0.0",
23017 "filename": "server/api/smsInteraction/index.js",
23018 "groupTitle": "Sms_Interactions"
23022 "url": "/api/sms/interactions",
23023 "title": "Creates a new Interaction",
23026 "title": "Example usage:",
23027 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23031 "name": "CreateInteractions",
23032 "group": "Sms_Interactions",
23047 "field": "closedAt",
23054 "field": "disposition",
23061 "field": "secondDisposition",
23068 "field": "thirdDisposition",
23089 "field": "read1stAt",
23100 "field": "firstMsgDirection",
23107 "field": "lastMsgAt",
23118 "field": "lastMsgDirection",
23124 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23125 "version": "0.0.0",
23126 "filename": "server/api/smsInteraction/index.js",
23127 "groupTitle": "Sms_Interactions"
23131 "url": "/api/sms/interactions/{id}",
23132 "title": "Deletes a Interaction",
23135 "title": "Example usage:",
23136 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23140 "name": "DeleteInteractions",
23141 "group": "Sms_Interactions",
23142 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23143 "version": "0.0.0",
23144 "filename": "server/api/smsInteraction/index.js",
23145 "groupTitle": "Sms_Interactions"
23149 "url": "/api/sms/interactions/describe",
23150 "title": "Gets table info about Interactions",
23153 "title": "Example usage:",
23154 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23158 "name": "DescribeInteractions",
23159 "group": "Sms_Interactions",
23160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161 "version": "0.0.0",
23162 "filename": "server/api/smsInteraction/index.js",
23163 "groupTitle": "Sms_Interactions"
23167 "url": "/api/sms/interactions",
23168 "title": "Gets a list of Interactions",
23171 "title": "Example usage:",
23172 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23176 "name": "GetInteractions",
23177 "group": "Sms_Interactions",
23178 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23179 "version": "0.0.0",
23180 "filename": "server/api/smsInteraction/index.js",
23181 "groupTitle": "Sms_Interactions"
23185 "url": "/api/sms/interactions/{id}/tags",
23186 "title": "Removes tags from interaction",
23189 "title": "Example usage:",
23190 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23194 "name": "RemoveTags",
23195 "group": "Sms_Interactions",
23196 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23197 "version": "0.0.0",
23198 "filename": "server/api/smsInteraction/index.js",
23199 "groupTitle": "Sms_Interactions"
23203 "url": "/api/sms/interactions/{id}",
23204 "title": "Gets a single Interaction",
23207 "title": "Example usage:",
23208 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23212 "name": "ShowInteractions",
23213 "group": "Sms_Interactions",
23214 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23215 "version": "0.0.0",
23216 "filename": "server/api/smsInteraction/index.js",
23217 "groupTitle": "Sms_Interactions"
23221 "url": "/api/sms/interactions/{id}/messages",
23222 "title": "Creates new messages",
23225 "title": "Example usage:",
23226 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23230 "name": "addMessage",
23231 "group": "Sms_Interactions",
23257 "field": "direction",
23264 "field": "messageId",
23292 "field": "providerName",
23299 "field": "providerResponse",
23305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23306 "version": "0.0.0",
23307 "filename": "server/api/smsInteraction/index.js",
23308 "groupTitle": "Sms_Interactions"
23312 "url": "/api/sms/interactions/{id}/download",
23313 "title": "Gets interaction",
23316 "title": "Example usage:",
23317 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23321 "name": "download",
23322 "group": "Sms_Interactions",
23323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23324 "version": "0.0.0",
23325 "filename": "server/api/smsInteraction/index.js",
23326 "groupTitle": "Sms_Interactions"
23330 "url": "/api/sms/interactions/{id}/messages",
23331 "title": "Gets interaction messages",
23334 "title": "Example usage:",
23335 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23339 "name": "getMessages",
23340 "group": "Sms_Interactions",
23341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23342 "version": "0.0.0",
23343 "filename": "server/api/smsInteraction/index.js",
23344 "groupTitle": "Sms_Interactions"
23348 "url": "/api/sms/interactions/{id}",
23349 "title": "Update an existing Interaction",
23352 "title": "Example usage:",
23353 "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",
23357 "name": "updateInteractions",
23358 "group": "Sms_Interactions",
23359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23360 "version": "0.0.0",
23361 "filename": "server/api/smsInteraction/index.js",
23362 "groupTitle": "Sms_Interactions"
23366 "url": "/api/sms/messages",
23367 "title": "Creates a new Message",
23370 "title": "Example usage:",
23371 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23375 "name": "CreateMessages",
23376 "group": "Sms_Messages",
23402 "field": "direction",
23409 "field": "messageId",
23437 "field": "providerName",
23444 "field": "providerResponse",
23450 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23451 "version": "0.0.0",
23452 "filename": "server/api/smsMessage/index.js",
23453 "groupTitle": "Sms_Messages"
23457 "url": "/api/sms/messages/{id}",
23458 "title": "Deletes a Message",
23461 "title": "Example usage:",
23462 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23466 "name": "DeleteMessages",
23467 "group": "Sms_Messages",
23468 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23469 "version": "0.0.0",
23470 "filename": "server/api/smsMessage/index.js",
23471 "groupTitle": "Sms_Messages"
23475 "url": "/api/sms/messages/describe",
23476 "title": "Gets table info about Messages",
23479 "title": "Example usage:",
23480 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23484 "name": "DescribeMessages",
23485 "group": "Sms_Messages",
23486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23487 "version": "0.0.0",
23488 "filename": "server/api/smsMessage/index.js",
23489 "groupTitle": "Sms_Messages"
23493 "url": "/api/sms/messages",
23494 "title": "Gets a list of Messages",
23497 "title": "Example usage:",
23498 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23502 "name": "GetMessages",
23503 "group": "Sms_Messages",
23504 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23505 "version": "0.0.0",
23506 "filename": "server/api/smsMessage/index.js",
23507 "groupTitle": "Sms_Messages"
23511 "url": "/api/sms/messages/{id}",
23512 "title": "Gets a single Message",
23515 "title": "Example usage:",
23516 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23520 "name": "ShowMessages",
23521 "group": "Sms_Messages",
23522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23523 "version": "0.0.0",
23524 "filename": "server/api/smsMessage/index.js",
23525 "groupTitle": "Sms_Messages"
23529 "url": "/api/sms/messages/{id}",
23530 "title": "Update an existing Message",
23533 "title": "Example usage:",
23534 "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",
23538 "name": "updateMessages",
23539 "group": "Sms_Messages",
23540 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23541 "version": "0.0.0",
23542 "filename": "server/api/smsMessage/index.js",
23543 "groupTitle": "Sms_Messages"
23547 "url": "/api/sms/reports/queue",
23548 "title": "Creates a new Sms Queue Report",
23551 "title": "Example usage:",
23552 "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",
23556 "name": "CreateSms_Queue_Reports",
23557 "group": "Sms_Queue_Reports",
23565 "field": "uniqueid",
23586 "field": "leaveAt",
23593 "field": "acceptAt",
23613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23614 "version": "0.0.0",
23615 "filename": "server/api/smsQueueReport/index.js",
23616 "groupTitle": "Sms_Queue_Reports"
23620 "url": "/api/sms/reports/queue/{id}",
23621 "title": "Deletes a Sms Queue Report",
23624 "title": "Example usage:",
23625 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23629 "name": "DeleteSms_Queue_Reports",
23630 "group": "Sms_Queue_Reports",
23631 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23632 "version": "0.0.0",
23633 "filename": "server/api/smsQueueReport/index.js",
23634 "groupTitle": "Sms_Queue_Reports"
23638 "url": "/api/sms/reports/queue/describe",
23639 "title": "Gets table info about Sms Queue Reports",
23642 "title": "Example usage:",
23643 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23647 "name": "DescribeSms_Queue_Reports",
23648 "group": "Sms_Queue_Reports",
23649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23650 "version": "0.0.0",
23651 "filename": "server/api/smsQueueReport/index.js",
23652 "groupTitle": "Sms_Queue_Reports"
23656 "url": "/api/sms/reports/queue",
23657 "title": "Gets a list of Sms Queue Reports",
23660 "title": "Example usage:",
23661 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23665 "name": "GetSms_Queue_Reports",
23666 "group": "Sms_Queue_Reports",
23667 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23668 "version": "0.0.0",
23669 "filename": "server/api/smsQueueReport/index.js",
23670 "groupTitle": "Sms_Queue_Reports"
23674 "url": "/api/sms/reports/queue/{id}",
23675 "title": "Gets a single Sms Queue Report",
23678 "title": "Example usage:",
23679 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23683 "name": "ShowSms_Queue_Reports",
23684 "group": "Sms_Queue_Reports",
23685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23686 "version": "0.0.0",
23687 "filename": "server/api/smsQueueReport/index.js",
23688 "groupTitle": "Sms_Queue_Reports"
23692 "url": "/api/sms/reports/queue/{id}",
23693 "title": "Update an existing Sms Queue Report",
23696 "title": "Example usage:",
23697 "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",
23701 "name": "updateSms_Queue_Reports",
23702 "group": "Sms_Queue_Reports",
23703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23704 "version": "0.0.0",
23705 "filename": "server/api/smsQueueReport/index.js",
23706 "groupTitle": "Sms_Queue_Reports"
23710 "url": "/api/sms/queues/{id}/users",
23711 "title": "Add agents to a queue",
23714 "title": "Example usage:",
23715 "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",
23719 "name": "AddAgents",
23720 "group": "Sms_Queues",
23721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23722 "version": "0.0.0",
23723 "filename": "server/api/smsQueue/index.js",
23724 "groupTitle": "Sms_Queues"
23728 "url": "/api/sms/queues/{id}/teams",
23729 "title": "Add teams to a queue",
23732 "title": "Example usage:",
23733 "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",
23737 "name": "AddTeams",
23738 "group": "Sms_Queues",
23739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23740 "version": "0.0.0",
23741 "filename": "server/api/smsQueue/index.js",
23742 "groupTitle": "Sms_Queues"
23746 "url": "/api/sms/queues",
23747 "title": "Creates a new Queue",
23750 "title": "Example usage:",
23751 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23755 "name": "CreateQueues",
23756 "group": "Sms_Queues",
23771 "field": "description",
23778 "field": "timeout",
23790 "field": "strategy",
23796 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23797 "version": "0.0.0",
23798 "filename": "server/api/smsQueue/index.js",
23799 "groupTitle": "Sms_Queues"
23803 "url": "/api/sms/queues/{id}",
23804 "title": "Deletes a Queue",
23807 "title": "Example usage:",
23808 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23812 "name": "DeleteQueues",
23813 "group": "Sms_Queues",
23814 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23815 "version": "0.0.0",
23816 "filename": "server/api/smsQueue/index.js",
23817 "groupTitle": "Sms_Queues"
23821 "url": "/api/sms/queues/describe",
23822 "title": "Gets table info about Queues",
23825 "title": "Example usage:",
23826 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23830 "name": "DescribeQueues",
23831 "group": "Sms_Queues",
23832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23833 "version": "0.0.0",
23834 "filename": "server/api/smsQueue/index.js",
23835 "groupTitle": "Sms_Queues"
23839 "url": "/api/sms/queues/{id}/users",
23840 "title": "Gets queue agents",
23843 "title": "Example usage:",
23844 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23848 "name": "GetAgents",
23849 "group": "Sms_Queues",
23850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23851 "version": "0.0.0",
23852 "filename": "server/api/smsQueue/index.js",
23853 "groupTitle": "Sms_Queues"
23857 "url": "/api/sms/queues/{id}/members",
23858 "title": "GetMembers",
23861 "title": "Example usage:",
23862 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23866 "name": "GetMembers",
23867 "group": "Sms_Queues",
23868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23869 "version": "0.0.0",
23870 "filename": "server/api/smsQueue/index.js",
23871 "groupTitle": "Sms_Queues"
23875 "url": "/api/sms/queues",
23876 "title": "Gets a list of Queues",
23879 "title": "Example usage:",
23880 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23884 "name": "GetQueues",
23885 "group": "Sms_Queues",
23886 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23887 "version": "0.0.0",
23888 "filename": "server/api/smsQueue/index.js",
23889 "groupTitle": "Sms_Queues"
23893 "url": "/api/sms/queues/{id}/teams",
23894 "title": "Gets queues list",
23897 "title": "Example usage:",
23898 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23902 "name": "GetTeams",
23903 "group": "Sms_Queues",
23904 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23905 "version": "0.0.0",
23906 "filename": "server/api/smsQueue/index.js",
23907 "groupTitle": "Sms_Queues"
23911 "url": "/api/sms/queues/{id}/users",
23912 "title": "Removes agents from a queue",
23915 "title": "Example usage:",
23916 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23920 "name": "RemoveAgents",
23921 "group": "Sms_Queues",
23922 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23923 "version": "0.0.0",
23924 "filename": "server/api/smsQueue/index.js",
23925 "groupTitle": "Sms_Queues"
23929 "url": "/api/sms/queues/{id}",
23930 "title": "Gets a single Queue",
23933 "title": "Example usage:",
23934 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23938 "name": "ShowQueues",
23939 "group": "Sms_Queues",
23940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23941 "version": "0.0.0",
23942 "filename": "server/api/smsQueue/index.js",
23943 "groupTitle": "Sms_Queues"
23947 "url": "/api/sms/queues/{id}",
23948 "title": "Update an existing Queue",
23951 "title": "Example usage:",
23952 "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",
23956 "name": "updateQueues",
23957 "group": "Sms_Queues",
23958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23959 "version": "0.0.0",
23960 "filename": "server/api/smsQueue/index.js",
23961 "groupTitle": "Sms_Queues"
23965 "url": "/api/sms/reports/transfer",
23966 "title": "Creates a new Sms Transfer Report",
23969 "title": "Example usage:",
23970 "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",
23974 "name": "CreateSms_Transfer_Reports",
23975 "group": "Sms_Transfer_Reports",
23983 "field": "uniqueid",
24002 "field": "transferredAt",
24008 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24009 "version": "0.0.0",
24010 "filename": "server/api/smsTransferReport/index.js",
24011 "groupTitle": "Sms_Transfer_Reports"
24015 "url": "/api/sms/reports/transfer/{id}",
24016 "title": "Deletes a Sms Transfer Report",
24019 "title": "Example usage:",
24020 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24024 "name": "DeleteSms_Transfer_Reports",
24025 "group": "Sms_Transfer_Reports",
24026 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24027 "version": "0.0.0",
24028 "filename": "server/api/smsTransferReport/index.js",
24029 "groupTitle": "Sms_Transfer_Reports"
24033 "url": "/api/sms/reports/transfer/describe",
24034 "title": "Gets table info about Sms Transfer Reports",
24037 "title": "Example usage:",
24038 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24042 "name": "DescribeSms_Transfer_Reports",
24043 "group": "Sms_Transfer_Reports",
24044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24045 "version": "0.0.0",
24046 "filename": "server/api/smsTransferReport/index.js",
24047 "groupTitle": "Sms_Transfer_Reports"
24051 "url": "/api/sms/reports/transfer",
24052 "title": "Gets a list of Sms Transfer Reports",
24055 "title": "Example usage:",
24056 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24060 "name": "GetSms_Transfer_Reports",
24061 "group": "Sms_Transfer_Reports",
24062 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24063 "version": "0.0.0",
24064 "filename": "server/api/smsTransferReport/index.js",
24065 "groupTitle": "Sms_Transfer_Reports"
24069 "url": "/api/sms/reports/transfer/{id}",
24070 "title": "Gets a single Sms Transfer Report",
24073 "title": "Example usage:",
24074 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24078 "name": "ShowSms_Transfer_Reports",
24079 "group": "Sms_Transfer_Reports",
24080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24081 "version": "0.0.0",
24082 "filename": "server/api/smsTransferReport/index.js",
24083 "groupTitle": "Sms_Transfer_Reports"
24087 "url": "/api/sms/reports/transfer/{id}",
24088 "title": "Update an existing Sms Transfer Report",
24091 "title": "Example usage:",
24092 "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",
24096 "name": "updateSms_Transfer_Reports",
24097 "group": "Sms_Transfer_Reports",
24098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24099 "version": "0.0.0",
24100 "filename": "server/api/smsTransferReport/index.js",
24101 "groupTitle": "Sms_Transfer_Reports"
24105 "url": "/api/sounds",
24106 "title": "Gets a list of Sounds",
24109 "title": "Example usage:",
24110 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24114 "name": "GetSounds",
24116 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24117 "version": "0.0.0",
24118 "filename": "server/api/sound/index.js",
24119 "groupTitle": "Sounds"
24123 "url": "/api/sounds/{id}",
24124 "title": "Gets a single Sound",
24127 "title": "Example usage:",
24128 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24132 "name": "ShowSounds",
24134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24135 "version": "0.0.0",
24136 "filename": "server/api/sound/index.js",
24137 "groupTitle": "Sounds"
24141 "url": "/api/sounds",
24142 "title": "Create a new sound",
24145 "title": "Example usage:",
24146 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24150 "name": "addSound",
24152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24153 "version": "0.0.0",
24154 "filename": "server/api/sound/index.js",
24155 "groupTitle": "Sounds"
24159 "url": "/api/sounds/{id}",
24160 "title": "Deletes a sound",
24163 "title": "Example usage:",
24164 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24168 "name": "destroySound",
24170 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24171 "version": "0.0.0",
24172 "filename": "server/api/sound/index.js",
24173 "groupTitle": "Sounds"
24177 "url": "/api/sounds/{id}/download",
24178 "title": "Download Sound",
24181 "title": "Example usage:",
24182 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24186 "name": "download",
24188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24189 "version": "0.0.0",
24190 "filename": "server/api/sound/index.js",
24191 "groupTitle": "Sounds"
24195 "url": "/api/sounds",
24196 "title": "Update an existing new sound",
24199 "title": "Example usage:",
24200 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24204 "name": "updateSound",
24206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24207 "version": "0.0.0",
24208 "filename": "server/api/sound/index.js",
24209 "groupTitle": "Sounds"
24213 "url": "/api/square/details/reports",
24214 "title": "Creates a new Square Detail Report",
24217 "title": "Example usage:",
24218 "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",
24222 "name": "CreateSquare_Detail_Reports",
24223 "group": "Square_Details_Reports",
24231 "field": "uniqueid",
24245 "field": "application",
24259 "field": "project_name",
24266 "field": "callerid",
24272 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24273 "version": "0.0.0",
24274 "filename": "server/api/squareReportDetail/index.js",
24275 "groupTitle": "Square_Details_Reports"
24279 "url": "/api/square/details/reports/{id}",
24280 "title": "Deletes a Square Detail Report",
24283 "title": "Example usage:",
24284 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24288 "name": "DeleteSquare_Detail_Reports",
24289 "group": "Square_Details_Reports",
24290 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24291 "version": "0.0.0",
24292 "filename": "server/api/squareReportDetail/index.js",
24293 "groupTitle": "Square_Details_Reports"
24297 "url": "/api/square/details/reports/describe",
24298 "title": "Gets table info about Square Detail Reports",
24301 "title": "Example usage:",
24302 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24306 "name": "DescribeSquare_Detail_Reports",
24307 "group": "Square_Details_Reports",
24308 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24309 "version": "0.0.0",
24310 "filename": "server/api/squareReportDetail/index.js",
24311 "groupTitle": "Square_Details_Reports"
24315 "url": "/api/square/details/reports",
24316 "title": "Gets a list of Square Detail Reports",
24319 "title": "Example usage:",
24320 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24324 "name": "GetSquare_Detail_Reports",
24325 "group": "Square_Details_Reports",
24326 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24327 "version": "0.0.0",
24328 "filename": "server/api/squareReportDetail/index.js",
24329 "groupTitle": "Square_Details_Reports"
24333 "url": "/api/square/details/reports/{id}",
24334 "title": "Gets a single Square Detail Report",
24337 "title": "Example usage:",
24338 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24342 "name": "ShowSquare_Detail_Reports",
24343 "group": "Square_Details_Reports",
24344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24345 "version": "0.0.0",
24346 "filename": "server/api/squareReportDetail/index.js",
24347 "groupTitle": "Square_Details_Reports"
24351 "url": "/api/square/details/reports/{id}",
24352 "title": "Update an existing Square Detail Report",
24355 "title": "Example usage:",
24356 "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",
24360 "name": "updateSquare_Detail_Reports",
24361 "group": "Square_Details_Reports",
24362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24363 "version": "0.0.0",
24364 "filename": "server/api/squareReportDetail/index.js",
24365 "groupTitle": "Square_Details_Reports"
24369 "url": "/api/square/messages",
24370 "title": "Creates a new Message",
24373 "title": "Example usage:",
24374 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24378 "name": "CreateMessages",
24379 "group": "Square_Messages",
24387 "field": "uniqueid",
24405 "field": "direction",
24412 "field": "providerName",
24419 "field": "providerResponse",
24425 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24426 "version": "0.0.0",
24427 "filename": "server/api/squareMessage/index.js",
24428 "groupTitle": "Square_Messages"
24432 "url": "/api/square/messages/{id}",
24433 "title": "Deletes a Message",
24436 "title": "Example usage:",
24437 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24441 "name": "DeleteMessages",
24442 "group": "Square_Messages",
24443 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24444 "version": "0.0.0",
24445 "filename": "server/api/squareMessage/index.js",
24446 "groupTitle": "Square_Messages"
24450 "url": "/api/square/messages",
24451 "title": "Gets a list of Messages",
24454 "title": "Example usage:",
24455 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24459 "name": "GetMessages",
24460 "group": "Square_Messages",
24461 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24462 "version": "0.0.0",
24463 "filename": "server/api/squareMessage/index.js",
24464 "groupTitle": "Square_Messages"
24468 "url": "/api/square/messages/{id}",
24469 "title": "Gets a single Message",
24472 "title": "Example usage:",
24473 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24477 "name": "ShowMessages",
24478 "group": "Square_Messages",
24479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24480 "version": "0.0.0",
24481 "filename": "server/api/squareMessage/index.js",
24482 "groupTitle": "Square_Messages"
24486 "url": "/api/square/messages/{id}",
24487 "title": "Update an existing Message",
24490 "title": "Example usage:",
24491 "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",
24495 "name": "updateMessages",
24496 "group": "Square_Messages",
24497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24498 "version": "0.0.0",
24499 "filename": "server/api/squareMessage/index.js",
24500 "groupTitle": "Square_Messages"
24504 "url": "/api/square/odbc",
24505 "title": "Creates a new ODBC",
24508 "title": "Example usage:",
24509 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24513 "name": "CreateODBCs",
24514 "group": "Square_ODBC",
24536 "field": "description",
24542 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24543 "version": "0.0.0",
24544 "filename": "server/api/squareOdbc/index.js",
24545 "groupTitle": "Square_ODBC"
24549 "url": "/api/square/odbc/{id}",
24550 "title": "Deletes a ODBC",
24553 "title": "Example usage:",
24554 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24558 "name": "DeleteODBCs",
24559 "group": "Square_ODBC",
24560 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24561 "version": "0.0.0",
24562 "filename": "server/api/squareOdbc/index.js",
24563 "groupTitle": "Square_ODBC"
24567 "url": "/api/square/odbc",
24568 "title": "Gets a list of ODBCs",
24571 "title": "Example usage:",
24572 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24576 "name": "GetODBCs",
24577 "group": "Square_ODBC",
24578 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24579 "version": "0.0.0",
24580 "filename": "server/api/squareOdbc/index.js",
24581 "groupTitle": "Square_ODBC"
24585 "url": "/api/square/odbc/{id}",
24586 "title": "Gets a single ODBC",
24589 "title": "Example usage:",
24590 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24594 "name": "ShowODBCs",
24595 "group": "Square_ODBC",
24596 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24597 "version": "0.0.0",
24598 "filename": "server/api/squareOdbc/index.js",
24599 "groupTitle": "Square_ODBC"
24603 "url": "/api/square/odbc/{id}/test",
24604 "title": "Test Odbc",
24607 "title": "Example usage:",
24608 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24613 "group": "Square_ODBC",
24614 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24615 "version": "0.0.0",
24616 "filename": "server/api/squareOdbc/index.js",
24617 "groupTitle": "Square_ODBC"
24621 "url": "/api/square/odbc/{id}",
24622 "title": "Update an existing ODBC",
24625 "title": "Example usage:",
24626 "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",
24630 "name": "updateODBCs",
24631 "group": "Square_ODBC",
24632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24633 "version": "0.0.0",
24634 "filename": "server/api/squareOdbc/index.js",
24635 "groupTitle": "Square_ODBC"
24639 "url": "/api/square/projects",
24640 "title": "Creates a new Project",
24643 "title": "Example usage:",
24644 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24648 "name": "CreateProjects",
24649 "group": "Square_Projects",
24664 "field": "description",
24678 "field": "preproduction",
24685 "field": "production",
24692 "field": "savedAt",
24699 "field": "publishedAt",
24705 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24706 "version": "0.0.0",
24707 "filename": "server/api/squareProject/index.js",
24708 "groupTitle": "Square_Projects"
24712 "url": "/api/square/projects/{id}",
24713 "title": "Deletes a Project",
24716 "title": "Example usage:",
24717 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24721 "name": "DeleteProjects",
24722 "group": "Square_Projects",
24723 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24724 "version": "0.0.0",
24725 "filename": "server/api/squareProject/index.js",
24726 "groupTitle": "Square_Projects"
24730 "url": "/api/square/projects",
24731 "title": "Gets a list of Projects",
24734 "title": "Example usage:",
24735 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24739 "name": "GetProjects",
24740 "group": "Square_Projects",
24741 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24742 "version": "0.0.0",
24743 "filename": "server/api/squareProject/index.js",
24744 "groupTitle": "Square_Projects"
24748 "url": "/api/square/projects/{id}",
24749 "title": "Gets a single Project",
24752 "title": "Example usage:",
24753 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24757 "name": "ShowProjects",
24758 "group": "Square_Projects",
24759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24760 "version": "0.0.0",
24761 "filename": "server/api/squareProject/index.js",
24762 "groupTitle": "Square_Projects"
24766 "url": "/api/square/projects/{id}/users",
24767 "title": "Adds user permissions to a Project",
24770 "title": "Example usage:",
24771 "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",
24775 "name": "addUsers",
24776 "group": "Square_Projects",
24777 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24778 "version": "0.0.0",
24779 "filename": "server/api/squareProject/index.js",
24780 "groupTitle": "Square_Projects"
24784 "url": "/api/square/projects/{id}/users",
24785 "title": "Gets users permissions from Project",
24788 "title": "Example usage:",
24789 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24793 "name": "getUsers",
24794 "group": "Square_Projects",
24795 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24796 "version": "0.0.0",
24797 "filename": "server/api/squareProject/index.js",
24798 "groupTitle": "Square_Projects"
24802 "url": "/api/square/projects/{id}/users",
24803 "title": "Removes user permissions from a Project",
24806 "title": "Example usage:",
24807 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24811 "name": "removeUsers",
24812 "group": "Square_Projects",
24813 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24814 "version": "0.0.0",
24815 "filename": "server/api/squareProject/index.js",
24816 "groupTitle": "Square_Projects"
24820 "url": "/api/square/projects/{id}",
24821 "title": "Update an existing Project",
24824 "title": "Example usage:",
24825 "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",
24829 "name": "updateProjects",
24830 "group": "Square_Projects",
24831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24832 "version": "0.0.0",
24833 "filename": "server/api/squareProject/index.js",
24834 "groupTitle": "Square_Projects"
24838 "url": "/api/square/recordings",
24839 "title": "Creates a new Recording",
24842 "title": "Example usage:",
24843 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24847 "name": "CreateRecordings",
24848 "group": "Square_Recordings",
24856 "field": "uniqueid",
24863 "field": "callerid",
24870 "field": "calleridname",
24877 "field": "context",
24884 "field": "extension",
24891 "field": "priority",
24898 "field": "accountcode",
24912 "field": "projectName",
24919 "field": "saveName",
24926 "field": "filename",
24933 "field": "savePath",
24946 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24947 "version": "0.0.0",
24948 "filename": "server/api/squareRecording/index.js",
24949 "groupTitle": "Square_Recordings"
24953 "url": "/api/square/recordings",
24954 "title": "Gets a list of Recordings",
24957 "title": "Example usage:",
24958 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24962 "name": "GetRecordings",
24963 "group": "Square_Recordings",
24964 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24965 "version": "0.0.0",
24966 "filename": "server/api/squareRecording/index.js",
24967 "groupTitle": "Square_Recordings"
24971 "url": "/api/square/recordings/{id}",
24972 "title": "Gets a single Recording",
24975 "title": "Example usage:",
24976 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24980 "name": "ShowRecordings",
24981 "group": "Square_Recordings",
24982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24983 "version": "0.0.0",
24984 "filename": "server/api/squareRecording/index.js",
24985 "groupTitle": "Square_Recordings"
24989 "url": "/api/square/recordings/{id}",
24990 "title": "Delete recording",
24993 "title": "Example usage:",
24994 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
24999 "group": "Square_Recordings",
25000 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25001 "version": "0.0.0",
25002 "filename": "server/api/squareRecording/index.js",
25003 "groupTitle": "Square_Recordings"
25007 "url": "/api/square/recordings/{id}/download",
25008 "title": "Download Recording",
25011 "title": "Example usage:",
25012 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25016 "name": "download",
25017 "group": "Square_Recordings",
25018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25019 "version": "0.0.0",
25020 "filename": "server/api/squareRecording/index.js",
25021 "groupTitle": "Square_Recordings"
25025 "url": "/api/square/recordings/{id}",
25026 "title": "Update an existing Recording",
25029 "title": "Example usage:",
25030 "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",
25034 "name": "updateRecordings",
25035 "group": "Square_Recordings",
25036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25037 "version": "0.0.0",
25038 "filename": "server/api/squareRecording/index.js",
25039 "groupTitle": "Square_Recordings"
25043 "url": "/api/square/reports",
25044 "title": "Creates a new Square Report",
25047 "title": "Example usage:",
25048 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25052 "name": "CreateSquare_Reports",
25053 "group": "Square_Reports",
25061 "field": "network",
25068 "field": "network_script",
25075 "field": "request",
25082 "field": "channel",
25089 "field": "language",
25103 "field": "uniqueid",
25110 "field": "version",
25117 "field": "callerid",
25124 "field": "calleridname",
25131 "field": "callingpres",
25138 "field": "callingani2",
25145 "field": "callington",
25152 "field": "callingtns",
25173 "field": "context",
25180 "field": "extension",
25187 "field": "priority",
25194 "field": "enhanced",
25201 "field": "accountcode",
25208 "field": "threadid",
25215 "field": "project_name",
25229 "field": "leaveAt",
25242 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25243 "version": "0.0.0",
25244 "filename": "server/api/squareReport/index.js",
25245 "groupTitle": "Square_Reports"
25249 "url": "/api/square/reports/{id}",
25250 "title": "Deletes a Square Report",
25253 "title": "Example usage:",
25254 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25258 "name": "DeleteSquare_Reports",
25259 "group": "Square_Reports",
25260 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25261 "version": "0.0.0",
25262 "filename": "server/api/squareReport/index.js",
25263 "groupTitle": "Square_Reports"
25267 "url": "/api/square/reports/describe",
25268 "title": "Gets table info about Square Reports",
25271 "title": "Example usage:",
25272 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25276 "name": "DescribeSquare_Reports",
25277 "group": "Square_Reports",
25278 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25279 "version": "0.0.0",
25280 "filename": "server/api/squareReport/index.js",
25281 "groupTitle": "Square_Reports"
25285 "url": "/api/square/reports",
25286 "title": "Gets a list of Square Reports",
25289 "title": "Example usage:",
25290 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25294 "name": "GetSquare_Reports",
25295 "group": "Square_Reports",
25296 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25297 "version": "0.0.0",
25298 "filename": "server/api/squareReport/index.js",
25299 "groupTitle": "Square_Reports"
25303 "url": "/api/square/reports/{id}",
25304 "title": "Gets a single Square Report",
25307 "title": "Example usage:",
25308 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25312 "name": "ShowSquare_Reports",
25313 "group": "Square_Reports",
25314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25315 "version": "0.0.0",
25316 "filename": "server/api/squareReport/index.js",
25317 "groupTitle": "Square_Reports"
25321 "url": "/api/square/reports/{id}",
25322 "title": "Update an existing Square Report",
25325 "title": "Example usage:",
25326 "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",
25330 "name": "updateSquare_Reports",
25331 "group": "Square_Reports",
25332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25333 "version": "0.0.0",
25334 "filename": "server/api/squareReport/index.js",
25335 "groupTitle": "Square_Reports"
25339 "url": "/api/integrations/sugarcrm/configurations",
25340 "title": "Creates a new SugarCRM Configuration",
25343 "title": "Example usage:",
25344 "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",
25348 "name": "CreateSugarCRM_Configurations",
25349 "group": "SugarCRM_Configurations",
25364 "field": "description",
25370 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25371 "version": "0.0.0",
25372 "filename": "server/api/intSugarcrmConfiguration/index.js",
25373 "groupTitle": "SugarCRM_Configurations"
25377 "url": "/api/integrations/sugarcrm/configurations/{id}",
25378 "title": "Deletes a SugarCRM Configuration",
25381 "title": "Example usage:",
25382 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25386 "name": "DeleteSugarCRM_Configurations",
25387 "group": "SugarCRM_Configurations",
25388 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25389 "version": "0.0.0",
25390 "filename": "server/api/intSugarcrmConfiguration/index.js",
25391 "groupTitle": "SugarCRM_Configurations"
25395 "url": "/api/integrations/sugarcrm/configurations",
25396 "title": "Gets a list of SugarCRM Configurations",
25399 "title": "Example usage:",
25400 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25404 "name": "GetSugarCRM_Configurations",
25405 "group": "SugarCRM_Configurations",
25406 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25407 "version": "0.0.0",
25408 "filename": "server/api/intSugarcrmConfiguration/index.js",
25409 "groupTitle": "SugarCRM_Configurations"
25413 "url": "/api/integrations/sugarcrm/configurations/{id}",
25414 "title": "Gets a single SugarCRM Configuration",
25417 "title": "Example usage:",
25418 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25422 "name": "ShowSugarCRM_Configurations",
25423 "group": "SugarCRM_Configurations",
25424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25425 "version": "0.0.0",
25426 "filename": "server/api/intSugarcrmConfiguration/index.js",
25427 "groupTitle": "SugarCRM_Configurations"
25431 "url": "/api/integrations/sugarcrm/configurations/{id}",
25432 "title": "Update an existing SugarCRM Configuration",
25435 "title": "Example usage:",
25436 "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",
25440 "name": "updateSugarCRM_Configurations",
25441 "group": "SugarCRM_Configurations",
25442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25443 "version": "0.0.0",
25444 "filename": "server/api/intSugarcrmConfiguration/index.js",
25445 "groupTitle": "SugarCRM_Configurations"
25449 "url": "/api/integrations/sugarcrm/accounts",
25450 "title": "Creates a new Sugarcrm Account",
25453 "title": "Example usage:",
25454 "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",
25458 "name": "CreateSugarcrm_Accounts",
25459 "group": "Sugarcrm_Accounts",
25474 "field": "description",
25481 "field": "username",
25488 "field": "password",
25495 "field": "remoteUri",
25502 "field": "serverUrl",
25508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25509 "version": "0.0.0",
25510 "filename": "server/api/intSugarcrmAccount/index.js",
25511 "groupTitle": "Sugarcrm_Accounts"
25515 "url": "/api/integrations/sugarcrm/accounts/{id}",
25516 "title": "Deletes a Sugarcrm Account",
25519 "title": "Example usage:",
25520 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25524 "name": "DeleteSugarcrm_Accounts",
25525 "group": "Sugarcrm_Accounts",
25526 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25527 "version": "0.0.0",
25528 "filename": "server/api/intSugarcrmAccount/index.js",
25529 "groupTitle": "Sugarcrm_Accounts"
25533 "url": "/api/integrations/sugarcrm/accounts",
25534 "title": "Gets a list of Sugarcrm Accounts",
25537 "title": "Example usage:",
25538 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25542 "name": "GetSugarcrm_Accounts",
25543 "group": "Sugarcrm_Accounts",
25544 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25545 "version": "0.0.0",
25546 "filename": "server/api/intSugarcrmAccount/index.js",
25547 "groupTitle": "Sugarcrm_Accounts"
25551 "url": "/api/integrations/sugarcrm/accounts/{id}",
25552 "title": "Gets a single Sugarcrm Account",
25555 "title": "Example usage:",
25556 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25560 "name": "ShowSugarcrm_Accounts",
25561 "group": "Sugarcrm_Accounts",
25562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25563 "version": "0.0.0",
25564 "filename": "server/api/intSugarcrmAccount/index.js",
25565 "groupTitle": "Sugarcrm_Accounts"
25569 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25570 "title": "Creates new configuration",
25573 "title": "Example usage:",
25574 "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",
25578 "name": "addConfiguration",
25579 "group": "Sugarcrm_Accounts",
25580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25581 "version": "0.0.0",
25582 "filename": "server/api/intSugarcrmAccount/index.js",
25583 "groupTitle": "Sugarcrm_Accounts"
25587 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25588 "title": "Gets account configurations",
25591 "title": "Example usage:",
25592 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25596 "name": "getConfigurations",
25597 "group": "Sugarcrm_Accounts",
25598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25599 "version": "0.0.0",
25600 "filename": "server/api/intSugarcrmAccount/index.js",
25601 "groupTitle": "Sugarcrm_Accounts"
25605 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25606 "title": "Gets account fields",
25609 "title": "Example usage:",
25610 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25614 "name": "getFields",
25615 "group": "Sugarcrm_Accounts",
25616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25617 "version": "0.0.0",
25618 "filename": "server/api/intSugarcrmAccount/index.js",
25619 "groupTitle": "Sugarcrm_Accounts"
25623 "url": "/api/integrations/sugarcrm/accounts/{id}",
25624 "title": "Update an existing Sugarcrm Account",
25627 "title": "Example usage:",
25628 "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",
25632 "name": "updateSugarcrm_Accounts",
25633 "group": "Sugarcrm_Accounts",
25634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25635 "version": "0.0.0",
25636 "filename": "server/api/intSugarcrmAccount/index.js",
25637 "groupTitle": "Sugarcrm_Accounts"
25641 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25642 "title": "Gets configurations descriptions",
25645 "title": "Example usage:",
25646 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25650 "name": "getDescriptions",
25651 "group": "Sugarcrm_Configurations",
25652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25653 "version": "0.0.0",
25654 "filename": "server/api/intSugarcrmConfiguration/index.js",
25655 "groupTitle": "Sugarcrm_Configurations"
25659 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25660 "title": "Gets configurations fields",
25663 "title": "Example usage:",
25664 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25668 "name": "getFields",
25669 "group": "Sugarcrm_Configurations",
25670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25671 "version": "0.0.0",
25672 "filename": "server/api/intSugarcrmConfiguration/index.js",
25673 "groupTitle": "Sugarcrm_Configurations"
25677 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25678 "title": "Gets configurations subjects",
25681 "title": "Example usage:",
25682 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25686 "name": "getSubjects",
25687 "group": "Sugarcrm_Configurations",
25688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25689 "version": "0.0.0",
25690 "filename": "server/api/intSugarcrmConfiguration/index.js",
25691 "groupTitle": "Sugarcrm_Configurations"
25695 "url": "/api/integrations/sugarcrm/fields",
25696 "title": "Creates a new Sugarcrm Field",
25699 "title": "Example usage:",
25700 "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",
25704 "name": "CreateSugarcrm_Fields",
25705 "group": "Sugarcrm_Fields",
25715 "\"customVariable\"",
25727 "field": "content",
25743 "\"customVariable\""
25746 "field": "keyType",
25753 "field": "keyContent",
25760 "field": "idField",
25767 "field": "nameField",
25774 "field": "customField",
25781 "field": "variableName",
25787 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25788 "version": "0.0.0",
25789 "filename": "server/api/intSugarcrmField/index.js",
25790 "groupTitle": "Sugarcrm_Fields"
25794 "url": "/api/integrations/sugarcrm/fields/{id}",
25795 "title": "Deletes a Sugarcrm Field",
25798 "title": "Example usage:",
25799 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25803 "name": "DeleteSugarcrm_Fields",
25804 "group": "Sugarcrm_Fields",
25805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25806 "version": "0.0.0",
25807 "filename": "server/api/intSugarcrmField/index.js",
25808 "groupTitle": "Sugarcrm_Fields"
25812 "url": "/api/integrations/sugarcrm/fields",
25813 "title": "Gets a list of Sugarcrm Fields",
25816 "title": "Example usage:",
25817 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25821 "name": "GetSugarcrm_Fields",
25822 "group": "Sugarcrm_Fields",
25823 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25824 "version": "0.0.0",
25825 "filename": "server/api/intSugarcrmField/index.js",
25826 "groupTitle": "Sugarcrm_Fields"
25830 "url": "/api/integrations/sugarcrm/fields/{id}",
25831 "title": "Gets a single Sugarcrm Field",
25834 "title": "Example usage:",
25835 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25839 "name": "ShowSugarcrm_Fields",
25840 "group": "Sugarcrm_Fields",
25841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25842 "version": "0.0.0",
25843 "filename": "server/api/intSugarcrmField/index.js",
25844 "groupTitle": "Sugarcrm_Fields"
25848 "url": "/api/integrations/sugarcrm/fields/{id}",
25849 "title": "Update an existing Sugarcrm Field",
25852 "title": "Example usage:",
25853 "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",
25857 "name": "updateSugarcrm_Fields",
25858 "group": "Sugarcrm_Fields",
25859 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25860 "version": "0.0.0",
25861 "filename": "server/api/intSugarcrmField/index.js",
25862 "groupTitle": "Sugarcrm_Fields"
25866 "url": "/api/system",
25867 "title": "Gets system information",
25870 "title": "Example usage:",
25871 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25875 "name": "GetSystemInformation",
25876 "group": "System_Information",
25877 "description": "<p>Motion returns the system information.</p>",
25878 "version": "0.0.0",
25879 "filename": "server/api/system/index.js",
25880 "groupTitle": "System_Information"
25884 "url": "/api/system/process",
25885 "title": "Gets system information",
25888 "title": "Example usage:",
25889 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25893 "name": "GetSystemInformation",
25894 "group": "System_Information",
25895 "description": "<p>Motion returns the system information.</p>",
25896 "version": "0.0.0",
25897 "filename": "server/api/system/index.js",
25898 "groupTitle": "System_Information"
25902 "url": "/api/tags",
25903 "title": "Creates a new Tag",
25906 "title": "Example usage:",
25907 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25911 "name": "CreateTags",
25934 "field": "description",
25940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25941 "version": "0.0.0",
25942 "filename": "server/api/tag/index.js",
25943 "groupTitle": "Tags"
25947 "url": "/api/tags/{id}",
25948 "title": "Deletes a Tag",
25951 "title": "Example usage:",
25952 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25956 "name": "DeleteTags",
25958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25959 "version": "0.0.0",
25960 "filename": "server/api/tag/index.js",
25961 "groupTitle": "Tags"
25965 "url": "/api/tags",
25966 "title": "Gets a list of Tags",
25969 "title": "Example usage:",
25970 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25976 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25977 "version": "0.0.0",
25978 "filename": "server/api/tag/index.js",
25979 "groupTitle": "Tags"
25983 "url": "/api/tags/{id}",
25984 "title": "Gets a single Tag",
25987 "title": "Example usage:",
25988 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25992 "name": "ShowTags",
25994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25995 "version": "0.0.0",
25996 "filename": "server/api/tag/index.js",
25997 "groupTitle": "Tags"
26001 "url": "/api/tags/{id}",
26002 "title": "Update an existing Tag",
26005 "title": "Example usage:",
26006 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26010 "name": "updateTags",
26012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26013 "version": "0.0.0",
26014 "filename": "server/api/tag/index.js",
26015 "groupTitle": "Tags"
26019 "url": "/api/teams/{id}/queues",
26020 "title": "Add queues to a team",
26023 "title": "Example usage:",
26024 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26028 "name": "AddQueues",
26030 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26031 "version": "0.0.0",
26032 "filename": "server/api/team/index.js",
26033 "groupTitle": "Teams"
26037 "url": "/api/teams",
26038 "title": "Creates a new Team",
26041 "title": "Example usage:",
26042 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26046 "name": "CreateTeams",
26062 "field": "description",
26068 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26069 "version": "0.0.0",
26070 "filename": "server/api/team/index.js",
26071 "groupTitle": "Teams"
26075 "url": "/api/teams/{id}",
26076 "title": "Deletes a Team",
26079 "title": "Example usage:",
26080 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26084 "name": "DeleteTeams",
26086 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26087 "version": "0.0.0",
26088 "filename": "server/api/team/index.js",
26089 "groupTitle": "Teams"
26093 "url": "/api/teams/{id}/users",
26094 "title": "Gets agents from team",
26097 "title": "Example usage:",
26098 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26102 "name": "GetAgents",
26104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26105 "version": "0.0.0",
26106 "filename": "server/api/team/index.js",
26107 "groupTitle": "Teams"
26111 "url": "/api/teams/{id}/queues?channel={channel}",
26112 "title": "Gets Queues list",
26115 "title": "Example usage:",
26116 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26120 "name": "GetQueues",
26122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26123 "version": "0.0.0",
26124 "filename": "server/api/team/index.js",
26125 "groupTitle": "Teams"
26129 "url": "/api/teams",
26130 "title": "Gets a list of Teams",
26133 "title": "Example usage:",
26134 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26138 "name": "GetTeams",
26140 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26141 "version": "0.0.0",
26142 "filename": "server/api/team/index.js",
26143 "groupTitle": "Teams"
26147 "url": "/api/teams/{id}/users",
26148 "title": "Removes agents from a team",
26151 "title": "Example usage:",
26152 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26156 "name": "RemoveAgents",
26158 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26159 "version": "0.0.0",
26160 "filename": "server/api/team/index.js",
26161 "groupTitle": "Teams"
26165 "url": "/api/teams/{id}/queues",
26166 "title": "Remove queues to a team",
26169 "title": "Example usage:",
26170 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26174 "name": "RemoveQueues",
26176 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26177 "version": "0.0.0",
26178 "filename": "server/api/team/index.js",
26179 "groupTitle": "Teams"
26183 "url": "/api/chat/queues/{id}/teams",
26184 "title": "Remove teams from a queue",
26187 "title": "Example usage:",
26188 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26192 "name": "RemoveTeams",
26194 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26195 "version": "0.0.0",
26196 "filename": "server/api/chatQueue/index.js",
26197 "groupTitle": "Teams"
26201 "url": "/api/fax/queues/{id}/teams",
26202 "title": "Remove teams from a queue",
26205 "title": "Example usage:",
26206 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26210 "name": "RemoveTeams",
26212 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26213 "version": "0.0.0",
26214 "filename": "server/api/faxQueue/index.js",
26215 "groupTitle": "Teams"
26219 "url": "/api/mail/queues/{id}/teams",
26220 "title": "Remove teams from a queue",
26223 "title": "Example usage:",
26224 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26228 "name": "RemoveTeams",
26230 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26231 "version": "0.0.0",
26232 "filename": "server/api/mailQueue/index.js",
26233 "groupTitle": "Teams"
26237 "url": "/api/sms/queues/{id}/teams",
26238 "title": "Remove teams from a queue",
26241 "title": "Example usage:",
26242 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26246 "name": "RemoveTeams",
26248 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26249 "version": "0.0.0",
26250 "filename": "server/api/smsQueue/index.js",
26251 "groupTitle": "Teams"
26255 "url": "/api/whatsapp/queues/{id}/teams",
26256 "title": "Remove teams from a queue",
26259 "title": "Example usage:",
26260 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26264 "name": "RemoveTeams",
26266 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26267 "version": "0.0.0",
26268 "filename": "server/api/whatsappQueue/index.js",
26269 "groupTitle": "Teams"
26273 "url": "/api/openchannel/queues/{id}/teams",
26274 "title": "Remove teams from a queue",
26277 "title": "Example usage:",
26278 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26282 "name": "RemoveTeams",
26284 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26285 "version": "0.0.0",
26286 "filename": "server/api/openchannelQueue/index.js",
26287 "groupTitle": "Teams"
26291 "url": "/api/voice/queues/{id}/teams",
26292 "title": "Remove teams from a queue",
26295 "title": "Example usage:",
26296 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26300 "name": "RemoveTeams",
26302 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26303 "version": "0.0.0",
26304 "filename": "server/api/voiceQueue/index.js",
26305 "groupTitle": "Teams"
26309 "url": "/api/teams/{id}",
26310 "title": "Gets a single Team",
26313 "title": "Example usage:",
26314 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26318 "name": "ShowTeams",
26320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26321 "version": "0.0.0",
26322 "filename": "server/api/team/index.js",
26323 "groupTitle": "Teams"
26327 "url": "/api/teams/{id}/users",
26328 "title": "Adds agents to a team",
26331 "title": "Example usage:",
26332 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26336 "name": "addAgents",
26338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26339 "version": "0.0.0",
26340 "filename": "server/api/team/index.js",
26341 "groupTitle": "Teams"
26345 "url": "/api/teams/{id}",
26346 "title": "Update an existing Team",
26349 "title": "Example usage:",
26350 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26354 "name": "updateTeams",
26356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26357 "version": "0.0.0",
26358 "filename": "server/api/team/index.js",
26359 "groupTitle": "Teams"
26363 "url": "/api/templates",
26364 "title": "Creates a new Template",
26367 "title": "Example usage:",
26368 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26372 "name": "CreateTemplates",
26373 "group": "Templates",
26388 "field": "description",
26401 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26402 "version": "0.0.0",
26403 "filename": "server/api/template/index.js",
26404 "groupTitle": "Templates"
26408 "url": "/api/templates/{id}",
26409 "title": "Deletes a Template",
26412 "title": "Example usage:",
26413 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26417 "name": "DeleteTemplates",
26418 "group": "Templates",
26419 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26420 "version": "0.0.0",
26421 "filename": "server/api/template/index.js",
26422 "groupTitle": "Templates"
26426 "url": "/api/templates",
26427 "title": "Gets a list of Templates",
26430 "title": "Example usage:",
26431 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26435 "name": "GetTemplates",
26436 "group": "Templates",
26437 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26438 "version": "0.0.0",
26439 "filename": "server/api/template/index.js",
26440 "groupTitle": "Templates"
26444 "url": "/api/templates/{id}",
26445 "title": "Gets a single Template",
26448 "title": "Example usage:",
26449 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26453 "name": "ShowTemplates",
26454 "group": "Templates",
26455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26456 "version": "0.0.0",
26457 "filename": "server/api/template/index.js",
26458 "groupTitle": "Templates"
26462 "url": "/api/templates/{id}",
26463 "title": "Update an existing Template",
26466 "title": "Example usage:",
26467 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26471 "name": "updateTemplates",
26472 "group": "Templates",
26473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26474 "version": "0.0.0",
26475 "filename": "server/api/template/index.js",
26476 "groupTitle": "Templates"
26480 "url": "/api/triggers",
26481 "title": "Creates a new Trigger",
26484 "title": "Example usage:",
26485 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26489 "name": "CreateTriggers",
26490 "group": "Triggers",
26505 "field": "channel",
26512 "field": "description",
26525 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26526 "version": "0.0.0",
26527 "filename": "server/api/trigger/index.js",
26528 "groupTitle": "Triggers"
26532 "url": "/api/triggers/{id}",
26533 "title": "Deletes a Trigger",
26536 "title": "Example usage:",
26537 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26541 "name": "DeleteTriggers",
26542 "group": "Triggers",
26543 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26544 "version": "0.0.0",
26545 "filename": "server/api/trigger/index.js",
26546 "groupTitle": "Triggers"
26550 "url": "/api/triggers",
26551 "title": "Gets a list of Triggers",
26554 "title": "Example usage:",
26555 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26559 "name": "GetTriggers",
26560 "group": "Triggers",
26561 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26562 "version": "0.0.0",
26563 "filename": "server/api/trigger/index.js",
26564 "groupTitle": "Triggers"
26568 "url": "/api/triggers/{id}",
26569 "title": "Gets a single Trigger",
26572 "title": "Example usage:",
26573 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26577 "name": "ShowTriggers",
26578 "group": "Triggers",
26579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26580 "version": "0.0.0",
26581 "filename": "server/api/trigger/index.js",
26582 "groupTitle": "Triggers"
26586 "url": "/api/triggers/{id}/actions",
26587 "title": "Creates new actions",
26590 "title": "Example usage:",
26591 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26595 "name": "addAction",
26596 "group": "Triggers",
26612 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26619 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26626 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26633 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26666 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26667 "version": "0.0.0",
26668 "filename": "server/api/trigger/index.js",
26669 "groupTitle": "Triggers"
26673 "url": "/api/triggers/{id}/all_conditions",
26674 "title": "Creates a new \"AND\"condition",
26677 "title": "Example usage:",
26678 "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",
26682 "name": "addAllCondition",
26683 "group": "Triggers",
26705 "field": "operator",
26718 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26719 "version": "0.0.0",
26720 "filename": "server/api/trigger/index.js",
26721 "groupTitle": "Triggers"
26725 "url": "/api/triggers/{id}/any_conditions",
26726 "title": "Creates a new \"OR\"condition",
26729 "title": "Example usage:",
26730 "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",
26734 "name": "addAnyCondition",
26735 "group": "Triggers",
26757 "field": "operator",
26770 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26771 "version": "0.0.0",
26772 "filename": "server/api/trigger/index.js",
26773 "groupTitle": "Triggers"
26777 "url": "/api/triggers/{id}/actions",
26778 "title": "Gets Trigger Actions",
26781 "title": "Example usage:",
26782 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26786 "name": "getActions",
26787 "group": "Triggers",
26788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26789 "version": "0.0.0",
26790 "filename": "server/api/trigger/index.js",
26791 "groupTitle": "Triggers"
26795 "url": "/api/triggers/{id}/all_conditions",
26796 "title": "Gets \"AND\" Trigger Conditions",
26799 "title": "Example usage:",
26800 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26804 "name": "getAllConditions",
26805 "group": "Triggers",
26806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26807 "version": "0.0.0",
26808 "filename": "server/api/trigger/index.js",
26809 "groupTitle": "Triggers"
26813 "url": "/api/triggers/{id}/any_conditions",
26814 "title": "Gets \"OR\" Trigger Conditions",
26817 "title": "Example usage:",
26818 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26822 "name": "getAnyConditions",
26823 "group": "Triggers",
26824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26825 "version": "0.0.0",
26826 "filename": "server/api/trigger/index.js",
26827 "groupTitle": "Triggers"
26831 "url": "/api/triggers/{id}",
26832 "title": "Update an existing Trigger",
26835 "title": "Example usage:",
26836 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26840 "name": "updateTriggers",
26841 "group": "Triggers",
26842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26843 "version": "0.0.0",
26844 "filename": "server/api/trigger/index.js",
26845 "groupTitle": "Triggers"
26849 "url": "/api/trunks/clone",
26850 "title": "Clone an existing Trunk",
26853 "title": "Example usage:",
26854 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26858 "name": "CloneTrunks",
26860 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26861 "version": "0.0.0",
26862 "filename": "server/api/trunk/index.js",
26863 "groupTitle": "Trunks"
26867 "url": "/api/trunks",
26868 "title": "Create a new trunk",
26871 "title": "Example usage:",
26872 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26904 "field": "context",
26911 "\"ALLOWED_NOT_SCREENED\"",
26912 "\"ALLOWED_PASSED_SCREEN\"",
26913 "\"ALLOWED_FAILED_SCREEN\"",
26915 "\"PROHIB_NOT_SCREENED\"",
26916 "\"PROHIB_PASSED_SCREEN\"",
26917 "\"PROHIB_FAILED_SCREEN\"",
26921 "field": "callingpres",
26949 "field": "md5secret",
26956 "field": "remotesecret",
26963 "field": "transport",
26964 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26977 "field": "dtmfmode",
26991 "field": "directmedia",
27002 "field": "directrtpsetup",
27009 "field": "directmediapermit",
27016 "field": "directmediadeny",
27024 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27030 "field": "callgroup",
27037 "field": "namedcallgroup",
27044 "field": "pickupgroup",
27051 "field": "namedpickupgroup",
27058 "field": "language",
27065 "field": "tonezone",
27072 "field": "disallow",
27080 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27090 "field": "autoframing",
27097 "field": "insecure",
27098 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27108 "field": "trustrpid",
27119 "field": "trust_id_outbound",
27131 "field": "progressinband",
27142 "field": "promiscredir",
27153 "field": "useclientcode",
27160 "field": "accountcode",
27174 "field": "callerid",
27181 "field": "amaflags",
27192 "field": "callcounter",
27199 "field": "busylevel",
27210 "field": "allowoverlap",
27221 "field": "allowsubscribe",
27232 "field": "allowtransfer",
27243 "field": "ignoresdpversion",
27250 "field": "subscribecontext",
27257 "field": "template",
27269 "field": "videosupport",
27276 "field": "maxcallbitrate",
27287 "field": "rfc2833compensate",
27294 "field": "mailbox",
27306 "field": "session_timers",
27313 "field": "session_expires",
27320 "field": "session_minse",
27331 "field": "session_refresher",
27338 "field": "t38pt_usertpsource",
27345 "field": "regexten",
27352 "field": "fromdomain",
27359 "field": "fromuser",
27377 "field": "qualify",
27384 "field": "keepalive",
27391 "field": "defaultip",
27398 "field": "defaultuser",
27405 "field": "rtptimeout",
27412 "field": "rtpholdtimeout",
27419 "field": "rtpkeepalive",
27431 "field": "sendrpid",
27438 "field": "outboundproxy",
27445 "field": "callbackextension",
27452 "field": "timert1",
27466 "field": "qualifyfreq",
27473 "field": "contactpermit",
27480 "field": "contactdeny",
27487 "field": "contactacl",
27494 "field": "unsolicited_mailbox",
27501 "field": "use_q850_reason",
27508 "field": "maxforwards",
27519 "field": "encryption",
27541 "field": "force_avp",
27552 "field": "icesupport",
27563 "field": "dtlsenable",
27576 "field": "dtlsverify",
27583 "field": "dtlsrekey",
27590 "field": "dtlscertfile",
27597 "field": "dtlsprivatekey",
27604 "field": "dtlscipher",
27611 "field": "dtlscafile",
27618 "field": "dtlscapath",
27630 "field": "dtlssetup",
27637 "field": "dtlsfingerprint",
27648 "field": "usereqphone",
27655 "field": "recordonfeature",
27662 "field": "recordofffeature",
27669 "field": "call_limit",
27680 "field": "registertrying",
27691 "field": "subscribemwi",
27698 "field": "vmexten",
27705 "field": "mohinterpret",
27712 "field": "mohsuggest",
27719 "field": "parkinglot",
27726 "field": "description",
27747 "field": "canreinvite",
27754 "field": "registry",
27761 "field": "otherFields",
27775 "field": "t38pt_udptl",
27781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27782 "version": "0.0.0",
27783 "filename": "server/api/trunk/index.js",
27784 "groupTitle": "Trunks"
27788 "url": "/api/trunks/{id}",
27789 "title": "Deletes a trunk",
27792 "title": "Example usage:",
27793 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27799 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27800 "version": "0.0.0",
27801 "filename": "server/api/trunk/index.js",
27802 "groupTitle": "Trunks"
27806 "url": "/api/trunks",
27807 "title": "Gets a list of Trunks",
27810 "title": "Example usage:",
27811 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27815 "name": "GetTrunks",
27817 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27818 "version": "0.0.0",
27819 "filename": "server/api/trunk/index.js",
27820 "groupTitle": "Trunks"
27824 "url": "/api/trunks/{id}",
27825 "title": "Gets a single Trunk",
27828 "title": "Example usage:",
27829 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27833 "name": "ShowTrunks",
27835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27836 "version": "0.0.0",
27837 "filename": "server/api/trunk/index.js",
27838 "groupTitle": "Trunks"
27842 "url": "/api/trunks/{id}",
27843 "title": "Update an existing trunk",
27846 "title": "Example usage:",
27847 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27854 "version": "0.0.0",
27855 "filename": "server/api/trunk/index.js",
27856 "groupTitle": "Trunks"
27860 "url": "/api/userNotifications",
27861 "title": "Send notification to user",
27864 "title": "Example usage:",
27865 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27870 "group": "UserNotifications",
27871 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27872 "version": "0.0.0",
27873 "filename": "server/api/userNotification/index.js",
27874 "groupTitle": "UserNotifications"
27878 "url": "/api/userProfile/resources",
27879 "title": "Creates a new User Profile Resource",
27882 "title": "Example usage:",
27883 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27887 "name": "CreateUser_Profile_Resources",
27888 "group": "User_Profile_Resources",
27903 "field": "resourceId",
27916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27917 "version": "0.0.0",
27918 "filename": "server/api/userProfileResource/index.js",
27919 "groupTitle": "User_Profile_Resources"
27923 "url": "/api/userProfile/resources/{id}",
27924 "title": "Deletes a User Profile Resource",
27927 "title": "Example usage:",
27928 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27932 "name": "DeleteUser_Profile_Resources",
27933 "group": "User_Profile_Resources",
27934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27935 "version": "0.0.0",
27936 "filename": "server/api/userProfileResource/index.js",
27937 "groupTitle": "User_Profile_Resources"
27941 "url": "/api/userProfile/resources/describe",
27942 "title": "Gets table info about User Profile Resources",
27945 "title": "Example usage:",
27946 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27950 "name": "DescribeUser_Profile_Resources",
27951 "group": "User_Profile_Resources",
27952 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27953 "version": "0.0.0",
27954 "filename": "server/api/userProfileResource/index.js",
27955 "groupTitle": "User_Profile_Resources"
27959 "url": "/api/userProfile/resources",
27960 "title": "Gets a list of User Profile Resources",
27963 "title": "Example usage:",
27964 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27968 "name": "GetUser_Profile_Resources",
27969 "group": "User_Profile_Resources",
27970 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27971 "version": "0.0.0",
27972 "filename": "server/api/userProfileResource/index.js",
27973 "groupTitle": "User_Profile_Resources"
27977 "url": "/api/userProfile/resources/{id}",
27978 "title": "Gets a single User Profile Resource",
27981 "title": "Example usage:",
27982 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27986 "name": "ShowUser_Profile_Resources",
27987 "group": "User_Profile_Resources",
27988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27989 "version": "0.0.0",
27990 "filename": "server/api/userProfileResource/index.js",
27991 "groupTitle": "User_Profile_Resources"
27995 "url": "/api/userProfile/resources/{id}",
27996 "title": "Update an existing User Profile Resource",
27999 "title": "Example usage:",
28000 "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",
28004 "name": "updateUser_Profile_Resources",
28005 "group": "User_Profile_Resources",
28006 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28007 "version": "0.0.0",
28008 "filename": "server/api/userProfileResource/index.js",
28009 "groupTitle": "User_Profile_Resources"
28013 "url": "/api/userProfile/sections",
28014 "title": "Creates a new User Profile Section",
28017 "title": "Example usage:",
28018 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28022 "name": "CreateUser_Profile_Sections",
28023 "group": "User_Profile_Sections",
28038 "field": "category",
28045 "field": "sectionId",
28052 "field": "enabled",
28059 "field": "autoAssociation",
28066 "field": "crudPermissions",
28072 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28073 "version": "0.0.0",
28074 "filename": "server/api/userProfileSection/index.js",
28075 "groupTitle": "User_Profile_Sections"
28079 "url": "/api/userProfile/sections/{id}",
28080 "title": "Deletes a User Profile Section",
28083 "title": "Example usage:",
28084 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28088 "name": "DeleteUser_Profile_Sections",
28089 "group": "User_Profile_Sections",
28090 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28091 "version": "0.0.0",
28092 "filename": "server/api/userProfileSection/index.js",
28093 "groupTitle": "User_Profile_Sections"
28097 "url": "/api/userProfile/sections/describe",
28098 "title": "Gets table info about User Profile Sections",
28101 "title": "Example usage:",
28102 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28106 "name": "DescribeUser_Profile_Sections",
28107 "group": "User_Profile_Sections",
28108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28109 "version": "0.0.0",
28110 "filename": "server/api/userProfileSection/index.js",
28111 "groupTitle": "User_Profile_Sections"
28115 "url": "/api/userProfile/sections",
28116 "title": "Gets a list of User Profile Sections",
28119 "title": "Example usage:",
28120 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28124 "name": "GetUser_Profile_Sections",
28125 "group": "User_Profile_Sections",
28126 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28127 "version": "0.0.0",
28128 "filename": "server/api/userProfileSection/index.js",
28129 "groupTitle": "User_Profile_Sections"
28133 "url": "/api/userProfile/sections/{id}",
28134 "title": "Gets a single User Profile Section",
28137 "title": "Example usage:",
28138 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28142 "name": "ShowUser_Profile_Sections",
28143 "group": "User_Profile_Sections",
28144 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28145 "version": "0.0.0",
28146 "filename": "server/api/userProfileSection/index.js",
28147 "groupTitle": "User_Profile_Sections"
28151 "url": "/api/userProfile/sections/{id}",
28152 "title": "Update an existing User Profile Section",
28155 "title": "Example usage:",
28156 "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",
28160 "name": "updateUser_Profile_Sections",
28161 "group": "User_Profile_Sections",
28162 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28163 "version": "0.0.0",
28164 "filename": "server/api/userProfileSection/index.js",
28165 "groupTitle": "User_Profile_Sections"
28169 "url": "/api/userProfiles/{id}/resources",
28170 "title": "Add resources' permissions to User Profile",
28173 "title": "Example usage:",
28174 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28178 "name": "AddResources",
28179 "group": "User_Profiles",
28180 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28181 "version": "0.0.0",
28182 "filename": "server/api/userProfile/index.js",
28183 "groupTitle": "User_Profiles"
28187 "url": "/api/userProfiles/{id}/sections",
28188 "title": "Add sections' permissions to User Profile",
28191 "title": "Example usage:",
28192 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28196 "name": "AddSections",
28197 "group": "User_Profiles",
28198 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28199 "version": "0.0.0",
28200 "filename": "server/api/userProfile/index.js",
28201 "groupTitle": "User_Profiles"
28205 "url": "/api/userProfiles/clone",
28206 "title": "Clone an existing User Profile",
28209 "title": "Example usage:",
28210 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28214 "name": "CloneUser_Profiles",
28215 "group": "User_Profiles",
28216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28217 "version": "0.0.0",
28218 "filename": "server/api/userProfile/index.js",
28219 "groupTitle": "User_Profiles"
28223 "url": "/api/userProfiles",
28224 "title": "Creates a new User Profile",
28227 "title": "Example usage:",
28228 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28232 "name": "CreateUser_Profiles",
28233 "group": "User_Profiles",
28248 "field": "crudPermissions",
28255 "field": "description",
28262 "field": "privacyEnabled",
28269 "field": "downloadAttachments",
28276 "field": "downloadCallySquareRecordings",
28283 "field": "downloadContactManagerLists",
28290 "field": "downloadJscriptySessions",
28297 "field": "downloadOmnichannelInteractions",
28304 "field": "downloadScreenRecordings",
28311 "field": "downloadVoiceRecordings",
28317 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28318 "version": "0.0.0",
28319 "filename": "server/api/userProfile/index.js",
28320 "groupTitle": "User_Profiles"
28324 "url": "/api/userProfiles/{id}",
28325 "title": "Deletes a User Profile",
28328 "title": "Example usage:",
28329 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28333 "name": "DeleteUser_Profiles",
28334 "group": "User_Profiles",
28335 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28336 "version": "0.0.0",
28337 "filename": "server/api/userProfile/index.js",
28338 "groupTitle": "User_Profiles"
28342 "url": "/api/userProfiles/describe",
28343 "title": "Gets table info about User Profiles",
28346 "title": "Example usage:",
28347 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28351 "name": "DescribeUser_Profiles",
28352 "group": "User_Profiles",
28353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28354 "version": "0.0.0",
28355 "filename": "server/api/userProfile/index.js",
28356 "groupTitle": "User_Profiles"
28360 "url": "/api/userProfiles/{id}/resources?section={section}",
28361 "title": "Get Resources assigned to a Section",
28364 "title": "Example usage:",
28365 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28369 "name": "GetResources",
28370 "group": "User_Profiles",
28371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28372 "version": "0.0.0",
28373 "filename": "server/api/userProfile/index.js",
28374 "groupTitle": "User_Profiles"
28378 "url": "/api/userProfiles/{id}/sections",
28379 "title": "Get sections associated to a User Profile",
28382 "title": "Example usage:",
28383 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28387 "name": "GetSections",
28388 "group": "User_Profiles",
28389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28390 "version": "0.0.0",
28391 "filename": "server/api/userProfile/index.js",
28392 "groupTitle": "User_Profiles"
28396 "url": "/api/userProfiles",
28397 "title": "Gets a list of User Profiles",
28400 "title": "Example usage:",
28401 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28405 "name": "GetUser_Profiles",
28406 "group": "User_Profiles",
28407 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28408 "version": "0.0.0",
28409 "filename": "server/api/userProfile/index.js",
28410 "groupTitle": "User_Profiles"
28414 "url": "/api/userProfiles/{id}/resources",
28415 "title": "Removes resources' permissions from User Profile",
28418 "title": "Example usage:",
28419 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28423 "name": "RemoveResources",
28424 "group": "User_Profiles",
28425 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28426 "version": "0.0.0",
28427 "filename": "server/api/userProfile/index.js",
28428 "groupTitle": "User_Profiles"
28432 "url": "/api/userProfiles/{id}/sections",
28433 "title": "Removes sections' permissions from User Profile",
28436 "title": "Example usage:",
28437 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28441 "name": "RemoveSections",
28442 "group": "User_Profiles",
28443 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28444 "version": "0.0.0",
28445 "filename": "server/api/userProfile/index.js",
28446 "groupTitle": "User_Profiles"
28450 "url": "/api/userProfiles/{id}",
28451 "title": "Gets a single User Profile",
28454 "title": "Example usage:",
28455 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28459 "name": "ShowUser_Profiles",
28460 "group": "User_Profiles",
28461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28462 "version": "0.0.0",
28463 "filename": "server/api/userProfile/index.js",
28464 "groupTitle": "User_Profiles"
28468 "url": "/api/userProfiles/{id}",
28469 "title": "Update an existing User Profile",
28472 "title": "Example usage:",
28473 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28477 "name": "updateUser_Profiles",
28478 "group": "User_Profiles",
28479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28480 "version": "0.0.0",
28481 "filename": "server/api/userProfile/index.js",
28482 "groupTitle": "User_Profiles"
28486 "url": "/api/users/{id}/chat_interactions",
28487 "title": "Add chat interaction tabs to an agent",
28490 "title": "Example usage:",
28491 "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",
28495 "name": "AddChatInteractions",
28497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28498 "version": "0.0.0",
28499 "filename": "server/api/user/index.js",
28500 "groupTitle": "Users"
28504 "url": "/api/users/{id}/chat_websites",
28505 "title": "Add a Chat Website to a user",
28508 "title": "Example usage:",
28509 "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",
28513 "name": "AddChatWebsites",
28515 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28516 "version": "0.0.0",
28517 "filename": "server/api/user/index.js",
28518 "groupTitle": "Users"
28522 "url": "/api/users/{id}/contacts",
28523 "title": "Add contacts to a user",
28526 "title": "Example usage:",
28527 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28531 "name": "AddContacts",
28533 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28534 "version": "0.0.0",
28535 "filename": "server/api/user/index.js",
28536 "groupTitle": "Users"
28540 "url": "/api/users/{id}/fax_accounts",
28541 "title": "Add a Fax Account to a user",
28544 "title": "Example usage:",
28545 "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",
28549 "name": "AddFaxAccounts",
28551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28552 "version": "0.0.0",
28553 "filename": "server/api/user/index.js",
28554 "groupTitle": "Users"
28558 "url": "/api/users/{id}/fax_interactions",
28559 "title": "Add fax interaction tabs to an agent",
28562 "title": "Example usage:",
28563 "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",
28567 "name": "AddFaxInteractions",
28569 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28570 "version": "0.0.0",
28571 "filename": "server/api/user/index.js",
28572 "groupTitle": "Users"
28576 "url": "/api/users/{id}/mail_accounts",
28577 "title": "Add a Mail Account to a user",
28580 "title": "Example usage:",
28581 "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",
28585 "name": "AddMailAccounts",
28587 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28588 "version": "0.0.0",
28589 "filename": "server/api/user/index.js",
28590 "groupTitle": "Users"
28594 "url": "/api/users/{id}/mail_interactions",
28595 "title": "Add mail interaction tabs to an agent",
28598 "title": "Example usage:",
28599 "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",
28603 "name": "AddMailInteractions",
28605 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28606 "version": "0.0.0",
28607 "filename": "server/api/user/index.js",
28608 "groupTitle": "Users"
28612 "url": "/api/users/{id}/openchannel_accounts",
28613 "title": "Add a Open Channel Account to a user",
28616 "title": "Example usage:",
28617 "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",
28621 "name": "AddOpenchannelAccounts",
28623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28624 "version": "0.0.0",
28625 "filename": "server/api/user/index.js",
28626 "groupTitle": "Users"
28630 "url": "/api/users/{id}/openchannel_interactions",
28631 "title": "Add openchannel interaction tabs to an agent",
28634 "title": "Example usage:",
28635 "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",
28639 "name": "AddOpenchannelInteractions",
28641 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28642 "version": "0.0.0",
28643 "filename": "server/api/user/index.js",
28644 "groupTitle": "Users"
28648 "url": "/api/users/{id}/queues",
28649 "title": "Add queues to an agent",
28652 "title": "Example usage:",
28653 "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",
28657 "name": "AddQueues",
28659 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28660 "version": "0.0.0",
28661 "filename": "server/api/user/index.js",
28662 "groupTitle": "Users"
28666 "url": "/api/users/{id}/sms_accounts",
28667 "title": "Add a Sms Account to a user",
28670 "title": "Example usage:",
28671 "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",
28675 "name": "AddSmsAccounts",
28677 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28678 "version": "0.0.0",
28679 "filename": "server/api/user/index.js",
28680 "groupTitle": "Users"
28684 "url": "/api/users/{id}/sms_interactions",
28685 "title": "Add sms interaction tabs to an agent",
28688 "title": "Example usage:",
28689 "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",
28693 "name": "AddSmsInteractions",
28695 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28696 "version": "0.0.0",
28697 "filename": "server/api/user/index.js",
28698 "groupTitle": "Users"
28702 "url": "/api/users/{id}/square_projects",
28703 "title": "Add a Square Project to a user",
28706 "title": "Example usage:",
28707 "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",
28711 "name": "AddSquareProjects",
28713 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28714 "version": "0.0.0",
28715 "filename": "server/api/user/index.js",
28716 "groupTitle": "Users"
28720 "url": "/api/users/{id}/teams",
28721 "title": "Add teams to an agent",
28724 "title": "Example usage:",
28725 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28729 "name": "AddTeams",
28731 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28732 "version": "0.0.0",
28733 "filename": "server/api/user/index.js",
28734 "groupTitle": "Users"
28738 "url": "/api/users/{id}/whatsapp_accounts",
28739 "title": "Add a Whatsapp Account to a user",
28742 "title": "Example usage:",
28743 "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",
28747 "name": "AddWhatsappAccounts",
28749 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28750 "version": "0.0.0",
28751 "filename": "server/api/user/index.js",
28752 "groupTitle": "Users"
28756 "url": "/api/users/{id}/whatsapp_interactions",
28757 "title": "Add Whatsapp interaction tabs to an agent",
28760 "title": "Example usage:",
28761 "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",
28765 "name": "AddWhatsappInteractions",
28767 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28768 "version": "0.0.0",
28769 "filename": "server/api/user/index.js",
28770 "groupTitle": "Users"
28774 "url": "/api/users/{id}/password",
28775 "title": "Change user password",
28778 "title": "Example usage:",
28779 "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",
28783 "name": "ChangePwd",
28785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28786 "version": "0.0.0",
28787 "filename": "server/api/user/index.js",
28788 "groupTitle": "Users"
28792 "url": "/api/users",
28793 "title": "Create a new user",
28796 "title": "Example usage:",
28797 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28803 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28804 "version": "0.0.0",
28805 "filename": "server/api/user/index.js",
28806 "groupTitle": "Users"
28810 "url": "/api/users/{id}/api_key",
28811 "title": "Create a new API access key for the user",
28814 "title": "Example usage:",
28815 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28819 "name": "CreateApiKey",
28821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28822 "version": "0.0.0",
28823 "filename": "server/api/user/index.js",
28824 "groupTitle": "Users"
28828 "url": "/api/users/{id}",
28829 "title": "Deletes a user",
28832 "title": "Example usage:",
28833 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28839 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28840 "version": "0.0.0",
28841 "filename": "server/api/user/index.js",
28842 "groupTitle": "Users"
28846 "url": "/api/users/describe",
28847 "title": "Gets table info about Users",
28850 "title": "Example usage:",
28851 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28855 "name": "DescribeUsers",
28857 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28858 "version": "0.0.0",
28859 "filename": "server/api/user/index.js",
28860 "groupTitle": "Users"
28864 "url": "/api/users/{id}/agents",
28865 "title": "GetAgents",
28868 "title": "Example usage:",
28869 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28873 "name": "GetAgents",
28875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28876 "version": "0.0.0",
28877 "filename": "server/api/user/index.js",
28878 "groupTitle": "Users"
28882 "url": "/api/users/{id}/api_key",
28883 "title": "Get the API access key for the user",
28886 "title": "Example usage:",
28887 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28891 "name": "GetApiKey",
28893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28894 "version": "0.0.0",
28895 "filename": "server/api/user/index.js",
28896 "groupTitle": "Users"
28900 "url": "/api/users/{id}/groups",
28901 "title": "GetChatGroups",
28904 "title": "Example usage:",
28905 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28909 "name": "GetChatGroups",
28911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28912 "version": "0.0.0",
28913 "filename": "server/api/user/index.js",
28914 "groupTitle": "Users"
28918 "url": "/api/users/{id}/chat/interactions",
28919 "title": "GetChatInteractions",
28922 "title": "Example usage:",
28923 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28927 "name": "GetChatInteractions",
28929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28930 "version": "0.0.0",
28931 "filename": "server/api/user/index.js",
28932 "groupTitle": "Users"
28936 "url": "/api/users/{id}/chat_websites",
28937 "title": "GetChatWebsites",
28940 "title": "Example usage:",
28941 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28945 "name": "GetChatWebsites",
28947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28948 "version": "0.0.0",
28949 "filename": "server/api/user/index.js",
28950 "groupTitle": "Users"
28954 "url": "/api/users/{id}/contacts",
28955 "title": "GetContacts",
28958 "title": "Example usage:",
28959 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28963 "name": "GetContacts",
28965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28966 "version": "0.0.0",
28967 "filename": "server/api/user/index.js",
28968 "groupTitle": "Users"
28972 "url": "/api/users/{id}/fax_accounts",
28973 "title": "GetFaxAccounts",
28976 "title": "Example usage:",
28977 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28981 "name": "GetFaxAccounts",
28983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28984 "version": "0.0.0",
28985 "filename": "server/api/user/index.js",
28986 "groupTitle": "Users"
28990 "url": "/api/users/{id}/fax/interactions",
28991 "title": "GetFaxInteractions",
28994 "title": "Example usage:",
28995 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28999 "name": "GetFaxInteractions",
29001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29002 "version": "0.0.0",
29003 "filename": "server/api/user/index.js",
29004 "groupTitle": "Users"
29008 "url": "/api/users/{id}/lists",
29009 "title": "GetLists",
29012 "title": "Example usage:",
29013 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29017 "name": "GetLists",
29019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29020 "version": "0.0.0",
29021 "filename": "server/api/user/index.js",
29022 "groupTitle": "Users"
29026 "url": "/api/users/{id}/mail_accounts",
29027 "title": "GetMailAccounts",
29030 "title": "Example usage:",
29031 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29035 "name": "GetMailAccounts",
29037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29038 "version": "0.0.0",
29039 "filename": "server/api/user/index.js",
29040 "groupTitle": "Users"
29044 "url": "/api/users/{id}/mail/interactions",
29045 "title": "GetMailInteractions",
29048 "title": "Example usage:",
29049 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29053 "name": "GetMailInteractions",
29055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29056 "version": "0.0.0",
29057 "filename": "server/api/user/index.js",
29058 "groupTitle": "Users"
29062 "url": "/api/users/{id}/openchannel_accounts",
29063 "title": "GetOpenchannelAccounts",
29066 "title": "Example usage:",
29067 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29071 "name": "GetOpenchannelAccounts",
29073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29074 "version": "0.0.0",
29075 "filename": "server/api/user/index.js",
29076 "groupTitle": "Users"
29080 "url": "/api/users/{id}/openchannel/interactions",
29081 "title": "GetOpenchannelInteractions",
29084 "title": "Example usage:",
29085 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29089 "name": "GetOpenchannelInteractions",
29091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29092 "version": "0.0.0",
29093 "filename": "server/api/user/index.js",
29094 "groupTitle": "Users"
29098 "url": "/api/users/{id}/prefixes",
29099 "title": "GetPrefixes",
29102 "title": "Example usage:",
29103 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29107 "name": "GetPrefixes",
29109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29110 "version": "0.0.0",
29111 "filename": "server/api/user/index.js",
29112 "groupTitle": "Users"
29116 "url": "/api/users/{id}/queues?channel={channel}",
29117 "title": "Gets Queues list",
29120 "title": "Example usage:",
29121 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29125 "name": "GetQueues",
29127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29128 "version": "0.0.0",
29129 "filename": "server/api/user/index.js",
29130 "groupTitle": "Users"
29134 "url": "/api/users/{id}/recordings",
29135 "title": "GetRecordings",
29138 "title": "Example usage:",
29139 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29143 "name": "GetRecordings",
29145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29146 "version": "0.0.0",
29147 "filename": "server/api/user/index.js",
29148 "groupTitle": "Users"
29152 "url": "/api/users/{id}/scheduled_calls",
29153 "title": "GetScheduledCalls",
29156 "title": "Example usage:",
29157 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29161 "name": "GetScheduledCalls",
29163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29164 "version": "0.0.0",
29165 "filename": "server/api/user/index.js",
29166 "groupTitle": "Users"
29170 "url": "/api/users/{id}/screen_recordings",
29171 "title": "GetScreenRecordings",
29174 "title": "Example usage:",
29175 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29179 "name": "GetScreenRecordings",
29181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29182 "version": "0.0.0",
29183 "filename": "server/api/user/index.js",
29184 "groupTitle": "Users"
29188 "url": "/api/users/{id}/sms_accounts",
29189 "title": "GetSmsAccounts",
29192 "title": "Example usage:",
29193 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29197 "name": "GetSmsAccounts",
29199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29200 "version": "0.0.0",
29201 "filename": "server/api/user/index.js",
29202 "groupTitle": "Users"
29206 "url": "/api/users/{id}/sms/interactions",
29207 "title": "GetSmsInteractions",
29210 "title": "Example usage:",
29211 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29215 "name": "GetSmsInteractions",
29217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29218 "version": "0.0.0",
29219 "filename": "server/api/user/index.js",
29220 "groupTitle": "Users"
29224 "url": "/api/users/{id}/square_projects",
29225 "title": "GetSquareProjects",
29228 "title": "Example usage:",
29229 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29233 "name": "GetSquareProjects",
29235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29236 "version": "0.0.0",
29237 "filename": "server/api/user/index.js",
29238 "groupTitle": "Users"
29242 "url": "/api/users/{id}/teams",
29243 "title": "GetTeams",
29246 "title": "Example usage:",
29247 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29251 "name": "GetTeams",
29253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29254 "version": "0.0.0",
29255 "filename": "server/api/user/index.js",
29256 "groupTitle": "Users"
29260 "url": "/api/users",
29261 "title": "Gets a list of Users",
29264 "title": "Example usage:",
29265 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29269 "name": "GetUsers",
29271 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29272 "version": "0.0.0",
29273 "filename": "server/api/user/index.js",
29274 "groupTitle": "Users"
29278 "url": "/api/users/{id}/queues_rt",
29279 "title": "GetVoiceQueuesRt",
29282 "title": "Example usage:",
29283 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29287 "name": "GetVoiceQueuesRt",
29289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29290 "version": "0.0.0",
29291 "filename": "server/api/user/index.js",
29292 "groupTitle": "Users"
29296 "url": "/api/users/{id}/whatsapp_accounts",
29297 "title": "GetWhatsappAccounts",
29300 "title": "Example usage:",
29301 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29305 "name": "GetWhatsappAccounts",
29307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29308 "version": "0.0.0",
29309 "filename": "server/api/user/index.js",
29310 "groupTitle": "Users"
29314 "url": "/api/users/{id}/whatsapp/interactions",
29315 "title": "GetWhatsappInteractions",
29318 "title": "Example usage:",
29319 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29323 "name": "GetWhatsappInteractions",
29325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29326 "version": "0.0.0",
29327 "filename": "server/api/user/index.js",
29328 "groupTitle": "Users"
29332 "url": "/api/users/{id}/login",
29336 "title": "Example usage:",
29337 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29343 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29344 "version": "0.0.0",
29345 "filename": "server/api/user/index.js",
29346 "groupTitle": "Users"
29350 "url": "/api/users/{id}/logout",
29354 "title": "Example usage:",
29355 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29361 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29362 "version": "0.0.0",
29363 "filename": "server/api/user/index.js",
29364 "groupTitle": "Users"
29368 "url": "/api/users/{id}/pause",
29372 "title": "Example usage:",
29373 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29380 "version": "0.0.0",
29381 "filename": "server/api/user/index.js",
29382 "groupTitle": "Users"
29386 "url": "/api/users/{id}/api_key",
29387 "title": "Remove API access key for the user",
29390 "title": "Example usage:",
29391 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29395 "name": "RemoveApiKey",
29397 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29398 "version": "0.0.0",
29399 "filename": "server/api/user/index.js",
29400 "groupTitle": "Users"
29404 "url": "/api/users/{id}/chat_interactions",
29405 "title": "Removes interactions from an agent",
29408 "title": "Example usage:",
29409 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29413 "name": "RemoveChatInteractions",
29415 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29416 "version": "0.0.0",
29417 "filename": "server/api/user/index.js",
29418 "groupTitle": "Users"
29422 "url": "/api/users/{id}/chat_websites",
29423 "title": "Removes a Chat Website from a user",
29426 "title": "Example usage:",
29427 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29431 "name": "RemoveChatWebsites",
29433 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29434 "version": "0.0.0",
29435 "filename": "server/api/user/index.js",
29436 "groupTitle": "Users"
29440 "url": "/api/users/{id}/fax_accounts",
29441 "title": "Removes a Fax Account from a user",
29444 "title": "Example usage:",
29445 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29449 "name": "RemoveFaxAccounts",
29451 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29452 "version": "0.0.0",
29453 "filename": "server/api/user/index.js",
29454 "groupTitle": "Users"
29458 "url": "/api/users/{id}/fax_interactions",
29459 "title": "Removes interactions from an agent",
29462 "title": "Example usage:",
29463 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29467 "name": "RemoveFaxInteractions",
29469 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29470 "version": "0.0.0",
29471 "filename": "server/api/user/index.js",
29472 "groupTitle": "Users"
29476 "url": "/api/users/{id}/mail_accounts",
29477 "title": "Removes a Mail Account from a user",
29480 "title": "Example usage:",
29481 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29485 "name": "RemoveMailAccounts",
29487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29488 "version": "0.0.0",
29489 "filename": "server/api/user/index.js",
29490 "groupTitle": "Users"
29494 "url": "/api/users/{id}/mail_interactions",
29495 "title": "Removes interactions from an agent",
29498 "title": "Example usage:",
29499 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29503 "name": "RemoveMailInteractions",
29505 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29506 "version": "0.0.0",
29507 "filename": "server/api/user/index.js",
29508 "groupTitle": "Users"
29512 "url": "/api/users/{id}/openchannel_accounts",
29513 "title": "Removes a Open Channel Account from a user",
29516 "title": "Example usage:",
29517 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29521 "name": "RemoveOpenchannelAccounts",
29523 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29524 "version": "0.0.0",
29525 "filename": "server/api/user/index.js",
29526 "groupTitle": "Users"
29530 "url": "/api/users/{id}/openchannel_interactions",
29531 "title": "Removes openchannel interactions from an agent",
29534 "title": "Example usage:",
29535 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29539 "name": "RemoveOpenchannelInteractions",
29541 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29542 "version": "0.0.0",
29543 "filename": "server/api/user/index.js",
29544 "groupTitle": "Users"
29548 "url": "/api/users/{id}/queues",
29549 "title": "Remove queues to an agent",
29552 "title": "Example usage:",
29553 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29557 "name": "RemoveQueues",
29559 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29560 "version": "0.0.0",
29561 "filename": "server/api/user/index.js",
29562 "groupTitle": "Users"
29566 "url": "/api/users/{id}/sms_accounts",
29567 "title": "Removes a Sms Account from a user",
29570 "title": "Example usage:",
29571 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29575 "name": "RemoveSmsAccounts",
29577 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29578 "version": "0.0.0",
29579 "filename": "server/api/user/index.js",
29580 "groupTitle": "Users"
29584 "url": "/api/users/{id}/sms_interactions",
29585 "title": "Removes interactions from an agent",
29588 "title": "Example usage:",
29589 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29593 "name": "RemoveSmsInteractions",
29595 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29596 "version": "0.0.0",
29597 "filename": "server/api/user/index.js",
29598 "groupTitle": "Users"
29602 "url": "/api/users/{id}/square_projects",
29603 "title": "Removes a Square Project from a user",
29606 "title": "Example usage:",
29607 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29611 "name": "RemoveSquareProjects",
29613 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29614 "version": "0.0.0",
29615 "filename": "server/api/user/index.js",
29616 "groupTitle": "Users"
29620 "url": "/api/users/{id}/teams",
29621 "title": "Removes teams from an agent",
29624 "title": "Example usage:",
29625 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29629 "name": "RemoveTeams",
29631 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29632 "version": "0.0.0",
29633 "filename": "server/api/user/index.js",
29634 "groupTitle": "Users"
29638 "url": "/api/users/{id}/whatsapp_accounts",
29639 "title": "Removes a Whatsapp Account from a user",
29642 "title": "Example usage:",
29643 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29647 "name": "RemoveWhatsappAccounts",
29649 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29650 "version": "0.0.0",
29651 "filename": "server/api/user/index.js",
29652 "groupTitle": "Users"
29656 "url": "/api/users/{id}/whatsapp_interactions",
29657 "title": "Removes Whatsapp interactions from an agent",
29660 "title": "Example usage:",
29661 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29665 "name": "RemoveWhatsappInteractions",
29667 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29668 "version": "0.0.0",
29669 "filename": "server/api/user/index.js",
29670 "groupTitle": "Users"
29674 "url": "/api/users/{id}",
29675 "title": "Gets a single User",
29678 "title": "Example usage:",
29679 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29683 "name": "ShowUsers",
29685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29686 "version": "0.0.0",
29687 "filename": "server/api/user/index.js",
29688 "groupTitle": "Users"
29692 "url": "/api/users/{id}/unpause",
29693 "title": "Unpause",
29696 "title": "Example usage:",
29697 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29703 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29704 "version": "0.0.0",
29705 "filename": "server/api/user/index.js",
29706 "groupTitle": "Users"
29710 "url": "/api/users/whoami",
29714 "title": "Example usage:",
29715 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29722 "version": "0.0.0",
29723 "filename": "server/api/user/index.js",
29724 "groupTitle": "Users"
29728 "url": "/api/users/{id}/avatar",
29729 "title": "Add avatar",
29732 "title": "Example usage:",
29733 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29737 "name": "addAvatar",
29739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29740 "version": "0.0.0",
29741 "filename": "server/api/user/index.js",
29742 "groupTitle": "Users"
29746 "url": "/api/users/create_many",
29747 "title": "Create Users",
29750 "title": "Example usage:",
29751 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29755 "name": "bulkCreate",
29757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29758 "version": "0.0.0",
29759 "filename": "server/api/user/index.js",
29760 "groupTitle": "Users"
29764 "url": "/api/users/{id}/avatar",
29765 "title": "Get avatar",
29768 "title": "Example usage:",
29769 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29773 "name": "getAvatar",
29775 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29776 "version": "0.0.0",
29777 "filename": "server/api/user/index.js",
29778 "groupTitle": "Users"
29782 "url": "/api/users/{id}/open_tabs",
29783 "title": "Get interactions opened tabs",
29786 "title": "Example usage:",
29787 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29791 "name": "getOpenTabs",
29793 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29794 "version": "0.0.0",
29795 "filename": "server/api/user/index.js",
29796 "groupTitle": "Users"
29800 "url": "/api/users/presence",
29801 "title": "Gets agent presence",
29804 "title": "Example usage:",
29805 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
29809 "name": "getPresence",
29811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29812 "version": "0.0.0",
29813 "filename": "server/api/user/index.js",
29814 "groupTitle": "Users"
29818 "url": "/api/users/{id}",
29819 "title": "Update an existing User",
29822 "title": "Example usage:",
29823 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29827 "name": "updateUsers",
29829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29830 "version": "0.0.0",
29831 "filename": "server/api/user/index.js",
29832 "groupTitle": "Users"
29836 "url": "/api/variables",
29837 "title": "Creates a new Variable",
29840 "title": "Example usage:",
29841 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29845 "name": "CreateVariables",
29846 "group": "Variables",
29861 "field": "description",
29867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29868 "version": "0.0.0",
29869 "filename": "server/api/variable/index.js",
29870 "groupTitle": "Variables"
29874 "url": "/api/variables/{id}",
29875 "title": "Deletes a Variable",
29878 "title": "Example usage:",
29879 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29883 "name": "DeleteVariables",
29884 "group": "Variables",
29885 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29886 "version": "0.0.0",
29887 "filename": "server/api/variable/index.js",
29888 "groupTitle": "Variables"
29892 "url": "/api/variables",
29893 "title": "Gets a list of Variables",
29896 "title": "Example usage:",
29897 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29901 "name": "GetVariables",
29902 "group": "Variables",
29903 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29904 "version": "0.0.0",
29905 "filename": "server/api/variable/index.js",
29906 "groupTitle": "Variables"
29910 "url": "/api/variables/{id}",
29911 "title": "Gets a single Variable",
29914 "title": "Example usage:",
29915 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29919 "name": "ShowVariables",
29920 "group": "Variables",
29921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29922 "version": "0.0.0",
29923 "filename": "server/api/variable/index.js",
29924 "groupTitle": "Variables"
29928 "url": "/api/variables/{id}",
29929 "title": "Update an existing Variable",
29932 "title": "Example usage:",
29933 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29937 "name": "updateVariables",
29938 "group": "Variables",
29939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29940 "version": "0.0.0",
29941 "filename": "server/api/variable/index.js",
29942 "groupTitle": "Variables"
29946 "url": "/api/version/fetch",
29947 "title": "Fetch git version",
29950 "title": "Example usage:",
29951 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29955 "name": "FetchVersion",
29956 "group": "Version",
29957 "description": "<p>Motion run the following command: git fetch origin master</p>",
29958 "version": "0.0.0",
29959 "filename": "server/api/version/index.js",
29960 "groupTitle": "Version"
29964 "url": "/api/version",
29965 "title": "Gets version",
29968 "title": "Example usage:",
29969 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29973 "name": "GetVersion",
29974 "group": "Version",
29975 "description": "<p>Motion returns the current and latest motion version.</p>",
29976 "version": "0.0.0",
29977 "filename": "server/api/version/index.js",
29978 "groupTitle": "Version"
29982 "url": "/api/version/migrations",
29983 "title": "Launch database migrations",
29986 "title": "Example usage:",
29987 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29991 "name": "MigrateVersion",
29992 "group": "Version",
29993 "description": "<p>Motion launch the database migrations, according to the application version</p>",
29994 "version": "0.0.0",
29995 "filename": "server/api/version/index.js",
29996 "groupTitle": "Version"
30000 "url": "/api/version/pull",
30001 "title": "Pull git version",
30004 "title": "Example usage:",
30005 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30009 "name": "PullVersion",
30010 "group": "Version",
30011 "description": "<p>Motion run the following command: git pull</p>",
30012 "version": "0.0.0",
30013 "filename": "server/api/version/index.js",
30014 "groupTitle": "Version"
30018 "url": "/api/version/reset",
30019 "title": "Reset git version",
30022 "title": "Example usage:",
30023 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30027 "name": "ResetVersion",
30028 "group": "Version",
30029 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30030 "version": "0.0.0",
30031 "filename": "server/api/version/index.js",
30032 "groupTitle": "Version"
30036 "url": "/api/version/restart",
30037 "title": "Restart motion2 after update",
30040 "title": "Example usage:",
30041 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30045 "name": "RestartVersion",
30046 "group": "Version",
30047 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30048 "version": "0.0.0",
30049 "filename": "server/api/version/index.js",
30050 "groupTitle": "Version"
30054 "url": "/api/voice/agents/reports/describe",
30055 "title": "Gets table info about Agent Reports",
30058 "title": "Example usage:",
30059 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30063 "name": "DescribeAgent_Reports",
30064 "group": "Voice_Agent_Reports",
30065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30066 "version": "0.0.0",
30067 "filename": "server/api/voiceAgentReport/index.js",
30068 "groupTitle": "Voice_Agent_Reports"
30072 "url": "/api/voice/agents/reports",
30073 "title": "Gets a list of Agent Reports",
30076 "title": "Example usage:",
30077 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30081 "name": "GetAgent_Reports",
30082 "group": "Voice_Agent_Reports",
30083 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30084 "version": "0.0.0",
30085 "filename": "server/api/voiceAgentReport/index.js",
30086 "groupTitle": "Voice_Agent_Reports"
30090 "url": "/api/voice/agents/reports/{id}",
30091 "title": "Gets a single Agent Report",
30094 "title": "Example usage:",
30095 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30099 "name": "ShowAgent_Reports",
30100 "group": "Voice_Agent_Reports",
30101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30102 "version": "0.0.0",
30103 "filename": "server/api/voiceAgentReport/index.js",
30104 "groupTitle": "Voice_Agent_Reports"
30108 "url": "/api/voice/calls/reports/describe",
30109 "title": "Gets table info about Call Reports",
30112 "title": "Example usage:",
30113 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30117 "name": "DescribeCall_Reports",
30118 "group": "Voice_Call_Reports",
30119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30120 "version": "0.0.0",
30121 "filename": "server/api/voiceCallReport/index.js",
30122 "groupTitle": "Voice_Call_Reports"
30126 "url": "/api/voice/calls/reports",
30127 "title": "Gets a list of Call Reports",
30130 "title": "Example usage:",
30131 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30135 "name": "GetCall_Reports",
30136 "group": "Voice_Call_Reports",
30137 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30138 "version": "0.0.0",
30139 "filename": "server/api/voiceCallReport/index.js",
30140 "groupTitle": "Voice_Call_Reports"
30144 "url": "/api/voice/calls/reports/{id}",
30145 "title": "Gets a single Call Report",
30148 "title": "Example usage:",
30149 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30153 "name": "ShowCall_Reports",
30154 "group": "Voice_Call_Reports",
30155 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30156 "version": "0.0.0",
30157 "filename": "server/api/voiceCallReport/index.js",
30158 "groupTitle": "Voice_Call_Reports"
30162 "url": "/api/voice/calls/reports/{id}",
30163 "title": "Update a single cdr",
30166 "title": "Example usage:",
30167 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30172 "group": "Voice_Call_Reports",
30173 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30174 "version": "0.0.0",
30175 "filename": "server/api/voiceCallReport/index.js",
30176 "groupTitle": "Voice_Call_Reports"
30180 "url": "/api/voice/chanspy",
30181 "title": "Creates a new ChanSpy",
30184 "title": "Example usage:",
30185 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30189 "name": "CreateChanSpy",
30190 "group": "Voice_ChanSpy",
30212 "field": "options",
30226 "field": "password",
30240 "field": "recordingFormat",
30247 "field": "description",
30253 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30254 "version": "0.0.0",
30255 "filename": "server/api/voiceChanSpy/index.js",
30256 "groupTitle": "Voice_ChanSpy"
30260 "url": "/api/voice/chanspy/{id}",
30261 "title": "Deletes a ChanSpy",
30264 "title": "Example usage:",
30265 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30269 "name": "DeleteChanSpy",
30270 "group": "Voice_ChanSpy",
30271 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30272 "version": "0.0.0",
30273 "filename": "server/api/voiceChanSpy/index.js",
30274 "groupTitle": "Voice_ChanSpy"
30278 "url": "/api/voice/chanspy",
30279 "title": "Gets a list of ChanSpy",
30282 "title": "Example usage:",
30283 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30287 "name": "GetChanSpy",
30288 "group": "Voice_ChanSpy",
30289 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30290 "version": "0.0.0",
30291 "filename": "server/api/voiceChanSpy/index.js",
30292 "groupTitle": "Voice_ChanSpy"
30296 "url": "/api/voice/chanspy/{id}",
30297 "title": "Gets a single ChanSpy",
30300 "title": "Example usage:",
30301 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30305 "name": "ShowChanSpy",
30306 "group": "Voice_ChanSpy",
30307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30308 "version": "0.0.0",
30309 "filename": "server/api/voiceChanSpy/index.js",
30310 "groupTitle": "Voice_ChanSpy"
30314 "url": "/api/voice/chanspy/{id}",
30315 "title": "Update an existing ChanSpy",
30318 "title": "Example usage:",
30319 "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",
30323 "name": "updateChanSpy",
30324 "group": "Voice_ChanSpy",
30325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30326 "version": "0.0.0",
30327 "filename": "server/api/voiceChanSpy/index.js",
30328 "groupTitle": "Voice_ChanSpy"
30332 "url": "/api/voice/contexts",
30333 "title": "Create a new context",
30336 "title": "Example usage:",
30337 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30342 "group": "Voice_Contexts",
30357 "field": "description",
30364 "field": "defaultEntry",
30370 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30371 "version": "0.0.0",
30372 "filename": "server/api/voiceContext/index.js",
30373 "groupTitle": "Voice_Contexts"
30377 "url": "/api/voice/contexts/{id}",
30378 "title": "Deletes a context",
30381 "title": "Example usage:",
30382 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30387 "group": "Voice_Contexts",
30388 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30389 "version": "0.0.0",
30390 "filename": "server/api/voiceContext/index.js",
30391 "groupTitle": "Voice_Contexts"
30395 "url": "/api/voice/contexts",
30396 "title": "Gets a list of Contexts",
30399 "title": "Example usage:",
30400 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30404 "name": "GetContexts",
30405 "group": "Voice_Contexts",
30406 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30407 "version": "0.0.0",
30408 "filename": "server/api/voiceContext/index.js",
30409 "groupTitle": "Voice_Contexts"
30413 "url": "/api/voice/contexts/{id}",
30414 "title": "Gets a single Context",
30417 "title": "Example usage:",
30418 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30422 "name": "ShowContexts",
30423 "group": "Voice_Contexts",
30424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30425 "version": "0.0.0",
30426 "filename": "server/api/voiceContext/index.js",
30427 "groupTitle": "Voice_Contexts"
30431 "url": "/api/voice/contexts/{id}",
30432 "title": "Update an existing context",
30435 "title": "Example usage:",
30436 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30441 "group": "Voice_Contexts",
30442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30443 "version": "0.0.0",
30444 "filename": "server/api/voiceContext/index.js",
30445 "groupTitle": "Voice_Contexts"
30449 "url": "/api/voice/dials/reports/describe",
30450 "title": "Gets table info about Dial Reports",
30453 "title": "Example usage:",
30454 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30458 "name": "DescribeDial_Reports",
30459 "group": "Voice_Dial_Reports",
30460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30461 "version": "0.0.0",
30462 "filename": "server/api/voiceDialReport/index.js",
30463 "groupTitle": "Voice_Dial_Reports"
30467 "url": "/api/voice/dials/reports",
30468 "title": "Gets a list of Dial Reports",
30471 "title": "Example usage:",
30472 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30476 "name": "GetDial_Reports",
30477 "group": "Voice_Dial_Reports",
30478 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30479 "version": "0.0.0",
30480 "filename": "server/api/voiceDialReport/index.js",
30481 "groupTitle": "Voice_Dial_Reports"
30485 "url": "/api/voice/dials/reports/{id}",
30486 "title": "Gets a single Dial Report",
30489 "title": "Example usage:",
30490 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30494 "name": "ShowDial_Reports",
30495 "group": "Voice_Dial_Reports",
30496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30497 "version": "0.0.0",
30498 "filename": "server/api/voiceDialReport/index.js",
30499 "groupTitle": "Voice_Dial_Reports"
30503 "url": "/api/voice/extensions/{id}",
30504 "title": "Deletes a Extension",
30507 "title": "Example usage:",
30508 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30512 "name": "DeleteExtensions",
30513 "group": "Voice_Extensions",
30514 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30515 "version": "0.0.0",
30516 "filename": "server/api/voiceExtension/index.js",
30517 "groupTitle": "Voice_Extensions"
30521 "url": "/api/voice/extensions",
30522 "title": "Gets a list of Extensions",
30525 "title": "Example usage:",
30526 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30530 "name": "GetExtensions",
30531 "group": "Voice_Extensions",
30532 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30533 "version": "0.0.0",
30534 "filename": "server/api/voiceExtension/index.js",
30535 "groupTitle": "Voice_Extensions"
30539 "url": "/api/voice/extensions/{id}",
30540 "title": "Gets a single Extension",
30543 "title": "Example usage:",
30544 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30548 "name": "ShowExtensions",
30549 "group": "Voice_Extensions",
30550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30551 "version": "0.0.0",
30552 "filename": "server/api/voiceExtension/index.js",
30553 "groupTitle": "Voice_Extensions"
30557 "url": "/api/voice/extensions",
30558 "title": "Create new applications",
30561 "title": "Example usage:",
30562 "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",
30566 "name": "addApplications",
30567 "group": "Voice_Extensions",
30568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30569 "version": "0.0.0",
30570 "filename": "server/api/voiceExtension/index.js",
30571 "groupTitle": "Voice_Extensions"
30575 "url": "/api/voice/extensions",
30576 "title": "Create an extension",
30579 "title": "Example usage:",
30580 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30585 "group": "Voice_Extensions",
30586 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30587 "version": "0.0.0",
30588 "filename": "server/api/voiceExtension/index.js",
30589 "groupTitle": "Voice_Extensions"
30593 "url": "/api/voice/extensions/{id}",
30594 "title": "Update an extension",
30597 "title": "Example usage:",
30598 "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",
30603 "group": "Voice_Extensions",
30604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30605 "version": "0.0.0",
30606 "filename": "server/api/voiceExtension/index.js",
30607 "groupTitle": "Voice_Extensions"
30611 "url": "/api/voice/mohs",
30612 "title": "Create a new a new MOH",
30615 "title": "Example usage:",
30616 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30621 "group": "Voice_MOHs",
30622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30623 "version": "0.0.0",
30624 "filename": "server/api/voiceMusicOnHold/index.js",
30625 "groupTitle": "Voice_MOHs"
30629 "url": "/api/voice/mohs/{id}/sounds",
30630 "title": "Add sound to MOH",
30633 "title": "Example usage:",
30634 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30638 "name": "AddSound",
30639 "group": "Voice_MOHs",
30640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30641 "version": "0.0.0",
30642 "filename": "server/api/voiceMusicOnHold/index.js",
30643 "groupTitle": "Voice_MOHs"
30647 "url": "/api/voice/mohs/{id}",
30648 "title": "Deletes an MOH",
30651 "title": "Example usage:",
30652 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30656 "name": "DestroyMoh",
30657 "group": "Voice_MOHs",
30658 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30659 "version": "0.0.0",
30660 "filename": "server/api/voiceMusicOnHold/index.js",
30661 "groupTitle": "Voice_MOHs"
30665 "url": "/api/voice/mohs",
30666 "title": "Gets a list of Music On Holds",
30669 "title": "Example usage:",
30670 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30674 "name": "GetMusic_On_Holds",
30675 "group": "Voice_MOHs",
30676 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30677 "version": "0.0.0",
30678 "filename": "server/api/voiceMusicOnHold/index.js",
30679 "groupTitle": "Voice_MOHs"
30683 "url": "/api/voice/mohs/{id}/sounds",
30684 "title": "Gets sounds from MOH",
30687 "title": "Example usage:",
30688 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30692 "name": "GetSounds",
30693 "group": "Voice_MOHs",
30694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30695 "version": "0.0.0",
30696 "filename": "server/api/voiceMusicOnHold/index.js",
30697 "groupTitle": "Voice_MOHs"
30701 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30702 "title": "Remove sound from MOH",
30705 "title": "Example usage:",
30706 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30710 "name": "RemoveSound",
30711 "group": "Voice_MOHs",
30712 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30713 "version": "0.0.0",
30714 "filename": "server/api/voiceMusicOnHold/index.js",
30715 "groupTitle": "Voice_MOHs"
30719 "url": "/api/voice/mohs/{id}",
30720 "title": "Gets a single Music On Hold",
30723 "title": "Example usage:",
30724 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30728 "name": "ShowMusic_On_Holds",
30729 "group": "Voice_MOHs",
30730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30731 "version": "0.0.0",
30732 "filename": "server/api/voiceMusicOnHold/index.js",
30733 "groupTitle": "Voice_MOHs"
30737 "url": "/api/voice/mohs/{id}",
30738 "title": "Update an existing Music On Hold",
30741 "title": "Example usage:",
30742 "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",
30746 "name": "updateMusic_On_Holds",
30747 "group": "Voice_MOHs",
30748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30749 "version": "0.0.0",
30750 "filename": "server/api/voiceMusicOnHold/index.js",
30751 "groupTitle": "Voice_MOHs"
30755 "url": "/api/voice/mails",
30756 "title": "Creates a new Mail",
30759 "title": "Example usage:",
30760 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30764 "name": "CreateMails",
30765 "group": "Voice_Mails",
30773 "field": "customer_id",
30780 "field": "context",
30787 "field": "mailbox",
30794 "field": "password",
30801 "field": "fullname",
30851 "field": "dialout",
30858 "field": "callback",
30880 "field": "operator",
30891 "field": "envelope",
30902 "field": "sayduration",
30909 "field": "saydurationm",
30920 "field": "sendvoicemail",
30942 "field": "nextaftercmd",
30953 "field": "forcename",
30964 "field": "forcegreetings",
30975 "field": "hidefromdir",
30989 "field": "emailsubject",
30996 "field": "emailbody",
31003 "field": "maxsecs",
31023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31024 "version": "0.0.0",
31025 "filename": "server/api/voiceMail/index.js",
31026 "groupTitle": "Voice_Mails"
31030 "url": "/api/voice/mails/{id}",
31031 "title": "Deletes a Mail",
31034 "title": "Example usage:",
31035 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31039 "name": "DeleteMails",
31040 "group": "Voice_Mails",
31041 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31042 "version": "0.0.0",
31043 "filename": "server/api/voiceMail/index.js",
31044 "groupTitle": "Voice_Mails"
31048 "url": "/api/voice/mails",
31049 "title": "Gets a list of Mails",
31052 "title": "Example usage:",
31053 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31057 "name": "GetMails",
31058 "group": "Voice_Mails",
31059 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31060 "version": "0.0.0",
31061 "filename": "server/api/voiceMail/index.js",
31062 "groupTitle": "Voice_Mails"
31066 "url": "/api/voice/mails/{id}",
31067 "title": "Gets a single Mail",
31070 "title": "Example usage:",
31071 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31075 "name": "ShowMails",
31076 "group": "Voice_Mails",
31077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31078 "version": "0.0.0",
31079 "filename": "server/api/voiceMail/index.js",
31080 "groupTitle": "Voice_Mails"
31084 "url": "/api/voice/mails/{id}/messages",
31085 "title": "Gets voice mail messages",
31088 "title": "Example usage:",
31089 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31093 "name": "getMessages",
31094 "group": "Voice_Mails",
31095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31096 "version": "0.0.0",
31097 "filename": "server/api/voiceMail/index.js",
31098 "groupTitle": "Voice_Mails"
31102 "url": "/api/voice/mails/{id}",
31103 "title": "Update an existing Mail",
31106 "title": "Example usage:",
31107 "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",
31111 "name": "updateMails",
31112 "group": "Voice_Mails",
31113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31114 "version": "0.0.0",
31115 "filename": "server/api/voiceMail/index.js",
31116 "groupTitle": "Voice_Mails"
31120 "url": "/api/voice/mails/messages",
31121 "title": "Creates a new Message",
31124 "title": "Example usage:",
31125 "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",
31129 "name": "CreateMessages",
31130 "group": "Voice_Messages",
31159 "field": "context",
31166 "field": "macrocontext",
31173 "field": "callerid",
31180 "field": "origtime",
31187 "field": "duration",
31194 "field": "mailboxuser",
31201 "field": "mailboxcontext",
31208 "field": "recording",
31235 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31236 "version": "0.0.0",
31237 "filename": "server/api/voiceMailMessage/index.js",
31238 "groupTitle": "Voice_Messages"
31242 "url": "/api/voice/mails/messages/{id}",
31243 "title": "Deletes a Message",
31246 "title": "Example usage:",
31247 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31251 "name": "DeleteMessages",
31252 "group": "Voice_Messages",
31253 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31254 "version": "0.0.0",
31255 "filename": "server/api/voiceMailMessage/index.js",
31256 "groupTitle": "Voice_Messages"
31260 "url": "/api/voice/mails/messages",
31261 "title": "Gets a list of Messages",
31264 "title": "Example usage:",
31265 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31269 "name": "GetMessages",
31270 "group": "Voice_Messages",
31271 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31272 "version": "0.0.0",
31273 "filename": "server/api/voiceMailMessage/index.js",
31274 "groupTitle": "Voice_Messages"
31278 "url": "/api/voice/mails/messages/{id}",
31279 "title": "Gets a single Message",
31282 "title": "Example usage:",
31283 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31287 "name": "ShowMessages",
31288 "group": "Voice_Messages",
31289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31290 "version": "0.0.0",
31291 "filename": "server/api/voiceMailMessage/index.js",
31292 "groupTitle": "Voice_Messages"
31296 "url": "voice/mails/messages/{id}/download",
31297 "title": "Download Voice Message",
31300 "title": "Example usage:",
31301 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31305 "name": "download",
31306 "group": "Voice_Messages",
31307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31308 "version": "0.0.0",
31309 "filename": "server/api/voiceMailMessage/index.js",
31310 "groupTitle": "Voice_Messages"
31314 "url": "/api/voice/mails/messages/{id}",
31315 "title": "Update an existing Message",
31318 "title": "Example usage:",
31319 "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",
31323 "name": "updateMessages",
31324 "group": "Voice_Messages",
31325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31326 "version": "0.0.0",
31327 "filename": "server/api/voiceMailMessage/index.js",
31328 "groupTitle": "Voice_Messages"
31332 "url": "/api/voice/prefixes/{id}/users",
31333 "title": "Add agents to a prefix",
31336 "title": "Example usage:",
31337 "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",
31341 "name": "AddAgents",
31342 "group": "Voice_Prefixes",
31343 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31344 "version": "0.0.0",
31345 "filename": "server/api/voicePrefix/index.js",
31346 "groupTitle": "Voice_Prefixes"
31350 "url": "/api/voice/prefixes/{id}",
31351 "title": "Deletes a Prefix",
31354 "title": "Example usage:",
31355 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31359 "name": "DeletePrefixes",
31360 "group": "Voice_Prefixes",
31361 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31362 "version": "0.0.0",
31363 "filename": "server/api/voicePrefix/index.js",
31364 "groupTitle": "Voice_Prefixes"
31368 "url": "/api/voice/prefixes/describe",
31369 "title": "Gets table info about Prefixes",
31372 "title": "Example usage:",
31373 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31377 "name": "DescribePrefixes",
31378 "group": "Voice_Prefixes",
31379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31380 "version": "0.0.0",
31381 "filename": "server/api/voicePrefix/index.js",
31382 "groupTitle": "Voice_Prefixes"
31386 "url": "/api/voice/prefixes/{id}/users",
31387 "title": "Gets agents from prefix",
31390 "title": "Example usage:",
31391 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31395 "name": "GetAgents",
31396 "group": "Voice_Prefixes",
31397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31398 "version": "0.0.0",
31399 "filename": "server/api/voicePrefix/index.js",
31400 "groupTitle": "Voice_Prefixes"
31404 "url": "/api/voice/prefixes",
31405 "title": "Gets a list of Prefixes",
31408 "title": "Example usage:",
31409 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31413 "name": "GetPrefixes",
31414 "group": "Voice_Prefixes",
31415 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31416 "version": "0.0.0",
31417 "filename": "server/api/voicePrefix/index.js",
31418 "groupTitle": "Voice_Prefixes"
31422 "url": "/api/voice/prefixes/{id}/users",
31423 "title": "Removes agents from a prefix",
31426 "title": "Example usage:",
31427 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31431 "name": "RemoveAgents",
31432 "group": "Voice_Prefixes",
31433 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31434 "version": "0.0.0",
31435 "filename": "server/api/voicePrefix/index.js",
31436 "groupTitle": "Voice_Prefixes"
31440 "url": "/api/voice/prefixes/{id}",
31441 "title": "Gets a single Prefix",
31444 "title": "Example usage:",
31445 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31449 "name": "ShowPrefixes",
31450 "group": "Voice_Prefixes",
31451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31452 "version": "0.0.0",
31453 "filename": "server/api/voicePrefix/index.js",
31454 "groupTitle": "Voice_Prefixes"
31458 "url": "/api/voice/prefixes/{id}",
31459 "title": "Update an existing prefix",
31462 "title": "Example usage:",
31463 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31468 "group": "Voice_Prefixes",
31469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31470 "version": "0.0.0",
31471 "filename": "server/api/voicePrefix/index.js",
31472 "groupTitle": "Voice_Prefixes"
31476 "url": "/api/voice/prefixes",
31477 "title": "Create a prefix",
31480 "title": "Example usage:",
31481 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31486 "group": "Voice_Prefixes",
31487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31488 "version": "0.0.0",
31489 "filename": "server/api/voicePrefix/index.js",
31490 "groupTitle": "Voice_Prefixes"
31494 "url": "/api/voice/queues/reports/describe",
31495 "title": "Gets table info about Queue Reports",
31498 "title": "Example usage:",
31499 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31503 "name": "DescribeQueue_Reports",
31504 "group": "Voice_Queue_Reports",
31505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31506 "version": "0.0.0",
31507 "filename": "server/api/voiceQueueReport/index.js",
31508 "groupTitle": "Voice_Queue_Reports"
31512 "url": "/api/voice/queues/reports",
31513 "title": "Gets a list of Queue Reports",
31516 "title": "Example usage:",
31517 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31521 "name": "GetQueue_Reports",
31522 "group": "Voice_Queue_Reports",
31523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31524 "version": "0.0.0",
31525 "filename": "server/api/voiceQueueReport/index.js",
31526 "groupTitle": "Voice_Queue_Reports"
31530 "url": "/api/voice/queues/reports/{id}",
31531 "title": "Gets a single Queue Report",
31534 "title": "Example usage:",
31535 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31539 "name": "ShowQueue_Reports",
31540 "group": "Voice_Queue_Reports",
31541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31542 "version": "0.0.0",
31543 "filename": "server/api/voiceQueueReport/index.js",
31544 "groupTitle": "Voice_Queue_Reports"
31548 "url": "/api/voice/queues/reports/index",
31549 "title": "Get Voice Queues Report",
31552 "title": "Example usage:",
31553 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31557 "name": "getVoiceQueuesReport",
31558 "group": "Voice_Queue_Reports",
31559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31560 "version": "0.0.0",
31561 "filename": "server/api/voiceQueueReport/index.js",
31562 "groupTitle": "Voice_Queue_Reports"
31566 "url": "/api/voice/queues/{id}/users",
31567 "title": "Add agents to queue",
31570 "title": "Example usage:",
31571 "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",
31575 "name": "AddAgents",
31576 "group": "Voice_Queues",
31577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31578 "version": "0.0.0",
31579 "filename": "server/api/voiceQueue/index.js",
31580 "groupTitle": "Voice_Queues"
31584 "url": "/api/voice/queues/{id}/blacklists",
31585 "title": "Add blacklists to a queue",
31588 "title": "Example usage:",
31589 "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",
31593 "name": "AddBlackLists",
31594 "group": "Voice_Queues",
31595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31596 "version": "0.0.0",
31597 "filename": "server/api/voiceQueue/index.js",
31598 "groupTitle": "Voice_Queues"
31602 "url": "/api/voice/queues/{id}/lists",
31603 "title": "Add lists to a queue",
31606 "title": "Example usage:",
31607 "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",
31611 "name": "AddLists",
31612 "group": "Voice_Queues",
31613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31614 "version": "0.0.0",
31615 "filename": "server/api/voiceQueue/index.js",
31616 "groupTitle": "Voice_Queues"
31620 "url": "/api/voice/queues/{id}/teams",
31621 "title": "Add teams to queue",
31624 "title": "Example usage:",
31625 "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",
31629 "name": "AddTeams",
31630 "group": "Voice_Queues",
31631 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31632 "version": "0.0.0",
31633 "filename": "server/api/voiceQueue/index.js",
31634 "groupTitle": "Voice_Queues"
31638 "url": "/api/voice/queues/clone",
31639 "title": "Clone an existing Queue",
31642 "title": "Example usage:",
31643 "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",
31647 "name": "CloneQueues",
31648 "group": "Voice_Queues",
31649 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31650 "version": "0.0.0",
31651 "filename": "server/api/voiceQueue/index.js",
31652 "groupTitle": "Voice_Queues"
31656 "url": "/api/voice/queues",
31657 "title": "Creates a new Queue",
31660 "title": "Example usage:",
31661 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31665 "name": "CreateQueues",
31666 "group": "Voice_Queues",
31692 "field": "musiconhold",
31699 "field": "announce",
31717 "field": "strategy",
31724 "field": "servicelevel",
31731 "field": "context",
31738 "field": "penaltymemberslimit",
31745 "field": "timeout",
31759 "field": "timeoutpriority",
31773 "field": "wrapuptime",
31784 "field": "autofill",
31796 "field": "autopause",
31803 "field": "autopausedelay",
31814 "field": "autopausebusy",
31825 "field": "autopauseunavail",
31843 "field": "setinterfacevar",
31854 "field": "setqueueentryvar",
31865 "field": "setqueuevar",
31876 "field": "eventmemberstatus",
31883 "field": "membermacro",
31890 "field": "membergosub",
31897 "field": "announce_frequency",
31904 "field": "min_announce_frequency",
31911 "field": "periodic_announce_frequency",
31922 "field": "random_periodic_announce",
31933 "field": "relative_periodic_announce",
31945 "field": "announce_holdtime",
31952 "field": "announce_position",
31963 "field": "announce_to_first_user",
31970 "field": "announce_position_limit",
31985 "field": "announce_round_seconds",
31992 "field": "monitor_format",
31999 "field": "monitor_type",
32006 "field": "queue_youarenext",
32013 "field": "queue_thereare",
32020 "field": "queue_callswaiting",
32027 "field": "queue_holdtime",
32034 "field": "queue_minute",
32041 "field": "queue_minutes",
32048 "field": "queue_seconds",
32055 "field": "queue_thankyou",
32062 "field": "queue_reporthold",
32069 "field": "queue_quantity1",
32076 "field": "queue_quantity2",
32083 "field": "queue_periodic_announce",
32090 "field": "queue_less_than",
32097 "field": "periodic_announce",
32104 "field": "joinempty",
32111 "field": "leavewhenempty",
32122 "field": "reportholdtime",
32133 "field": "ringinuse",
32140 "field": "memberdelay",
32151 "field": "timeoutrestart",
32158 "field": "defaultrule",
32165 "field": "description",
32179 "field": "acwTimeout",
32186 "field": "dialActive",
32187 "description": "<p>Active/Disactive Campaign</p>"
32200 "field": "dialMethod",
32201 "description": "<p>Dial Method.</p>"
32207 "field": "dialLimitChannel",
32208 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32214 "field": "dialLimitQueue",
32215 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32221 "field": "dialPowerLevel",
32222 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32228 "\"agentBusyFactor\"",
32232 "field": "dialPredictiveOptimization",
32233 "description": "<p>Only for predictive method.</p>"
32239 "field": "dialPredictiveOptimizationPercentage",
32240 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32246 "field": "dialPredictiveInterval",
32247 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32253 "field": "dialOriginateCallerIdName",
32260 "field": "dialOriginateCallerIdNumber",
32267 "field": "dialOriginateTimeout",
32268 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32274 "field": "dialQueueOptions",
32275 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32281 "field": "dialQueueTimeout",
32282 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32288 "field": "dialQueueProject",
32289 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32295 "field": "dialCongestionMaxRetry",
32296 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32302 "field": "dialCongestionRetryFrequency",
32303 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32309 "field": "dialBusyMaxRetry",
32310 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32316 "field": "dialBusyRetryFrequency",
32317 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32323 "field": "dialNoAnswerMaxRetry",
32324 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32330 "field": "dialNoAnswerRetryFrequency",
32331 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32337 "field": "dialGlobalMaxRetry",
32338 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32344 "field": "dialTimezone",
32351 "field": "dialGlobalInterval",
32358 "field": "dialPrefix",
32370 "field": "dialCheckDuplicateType",
32377 "field": "dialAMDActive",
32378 "description": "<p>Active/Disactive AMD</p>"
32384 "field": "dialAMDInitialSilence",
32385 "description": "<p>#AMD Initial Silence</p>"
32391 "field": "dialAMDGreeting",
32392 "description": "<p>#AMD Greeting</p>"
32398 "field": "dialAMDAfterGreetingSilence",
32399 "description": "<p>#AMD After Greeting Silence</p>"
32405 "field": "dialAMDTotalAnalysisTime",
32406 "description": "<p>#AMD Total Analysis Time</p>"
32412 "field": "dialAMDMinWordLength",
32413 "description": "<p>#AMD Min Word Length</p>"
32419 "field": "dialAMDBetweenWordsSilence",
32420 "description": "<p>#AMD Between Words Silence</p>"
32426 "field": "dialAMDMaximumNumberOfWords",
32427 "description": "<p>#AMD Maximum Number Of Words</p>"
32433 "field": "dialAMDSilenceThreshold",
32434 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32440 "field": "dialAMDMaximumWordLength",
32441 "description": "<p>#AMD Maximum Word Length</p>"
32447 "field": "dialRecallMeTimeout",
32448 "description": "<p>#RecallMe Timeout (min:1)</p>"
32454 "field": "dialRecallInQueue",
32455 "description": "<p>Active/Disactive Recall In Queue</p>"
32465 "field": "dialOrderByScheduledAt",
32472 "field": "dialQueueProject2",
32473 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32479 "field": "dialAgiAfterHangupClient",
32486 "field": "dialAgiAfterHangupAgent",
32493 "field": "dialRandomLastDigitCallerIdNumber",
32494 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32500 "field": "dialCutDigit",
32501 "description": "<p>Cut Digit (min:1, max:15)</p>"
32507 "field": "dialNoSuchNumberMaxRetry",
32508 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32514 "field": "dialNoSuchNumberRetryFrequency",
32515 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32521 "field": "dialDropMaxRetry",
32522 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32528 "field": "dialDropRetryFrequency",
32529 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32535 "field": "dialAbandonedMaxRetry",
32536 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32542 "field": "dialAbandonedRetryFrequency",
32543 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32549 "field": "dialMachineMaxRetry",
32550 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32556 "field": "dialMachineRetryFrequency",
32557 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32563 "field": "dialAgentRejectMaxRetry",
32564 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32570 "field": "dialAgentRejectRetryFrequency",
32571 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32577 "field": "mandatoryDispositionPauseId",
32578 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32584 "field": "mandatoryDisposition",
32585 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32591 "field": "dialPredictiveIntervalMaxThreshold",
32598 "field": "dialPredictiveIntervalMinThreshold",
32604 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32605 "version": "0.0.0",
32606 "filename": "server/api/voiceQueue/index.js",
32607 "groupTitle": "Voice_Queues"
32611 "url": "/api/voice/queues/{id}",
32612 "title": "Deletes a Queue",
32615 "title": "Example usage:",
32616 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32620 "name": "DeleteQueues",
32621 "group": "Voice_Queues",
32622 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32623 "version": "0.0.0",
32624 "filename": "server/api/voiceQueue/index.js",
32625 "groupTitle": "Voice_Queues"
32629 "url": "/api/voice/queues/{id}/users",
32630 "title": "Gets queue agents",
32633 "title": "Example usage:",
32634 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32638 "name": "GetAgents",
32639 "group": "Voice_Queues",
32640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32641 "version": "0.0.0",
32642 "filename": "server/api/voiceQueue/index.js",
32643 "groupTitle": "Voice_Queues"
32647 "url": "/api/voice/queues/{id}/blacklists",
32648 "title": "Get queue blacklists",
32651 "title": "Example usage:",
32652 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32656 "name": "GetBlackLists",
32657 "group": "Voice_Queues",
32658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32659 "version": "0.0.0",
32660 "filename": "server/api/voiceQueue/index.js",
32661 "groupTitle": "Voice_Queues"
32665 "url": "/api/voice/queues/{id}/finals",
32666 "title": "Gets queue hopper finals",
32669 "title": "Example usage:",
32670 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32674 "name": "GetHopperFinals",
32675 "group": "Voice_Queues",
32676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32677 "version": "0.0.0",
32678 "filename": "server/api/voiceQueue/index.js",
32679 "groupTitle": "Voice_Queues"
32683 "url": "/api/voice/queues/{id}/hopper_histories",
32684 "title": "Gets queue hopper histories",
32687 "title": "Example usage:",
32688 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32692 "name": "GetHopperHistories",
32693 "group": "Voice_Queues",
32694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32695 "version": "0.0.0",
32696 "filename": "server/api/voiceQueue/index.js",
32697 "groupTitle": "Voice_Queues"
32701 "url": "/api/voice/queues/{id}/hoppers",
32702 "title": "Gets queue hoppers",
32705 "title": "Example usage:",
32706 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32710 "name": "GetHoppers",
32711 "group": "Voice_Queues",
32712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32713 "version": "0.0.0",
32714 "filename": "server/api/voiceQueue/index.js",
32715 "groupTitle": "Voice_Queues"
32719 "url": "/api/voice/queues/{id}/lists",
32720 "title": "Get queue lists",
32723 "title": "Example usage:",
32724 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32728 "name": "GetLists",
32729 "group": "Voice_Queues",
32730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32731 "version": "0.0.0",
32732 "filename": "server/api/voiceQueue/index.js",
32733 "groupTitle": "Voice_Queues"
32737 "url": "/api/voice/queues/{id}/members",
32738 "title": "Gets queue members",
32741 "title": "Example usage:",
32742 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32746 "name": "GetMembers",
32747 "group": "Voice_Queues",
32748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32749 "version": "0.0.0",
32750 "filename": "server/api/voiceQueue/index.js",
32751 "groupTitle": "Voice_Queues"
32755 "url": "/api/voice/queues",
32756 "title": "Gets a list of Queues",
32759 "title": "Example usage:",
32760 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32764 "name": "GetQueues",
32765 "group": "Voice_Queues",
32766 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32767 "version": "0.0.0",
32768 "filename": "server/api/voiceQueue/index.js",
32769 "groupTitle": "Voice_Queues"
32773 "url": "/api/voice/queues/{id}/teams",
32774 "title": "Gets queue team",
32777 "title": "Example usage:",
32778 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32782 "name": "GetTeams",
32783 "group": "Voice_Queues",
32784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32785 "version": "0.0.0",
32786 "filename": "server/api/voiceQueue/index.js",
32787 "groupTitle": "Voice_Queues"
32791 "url": "/api/voice/queues/{id}/users",
32792 "title": "Removes agents from a queue",
32795 "title": "Example usage:",
32796 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32800 "name": "RemoveAgents",
32801 "group": "Voice_Queues",
32802 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32803 "version": "0.0.0",
32804 "filename": "server/api/voiceQueue/index.js",
32805 "groupTitle": "Voice_Queues"
32809 "url": "/api/voice/queues/{id}/blacklists",
32810 "title": "Remove blacklists from a queue",
32813 "title": "Example usage:",
32814 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32818 "name": "RemoveBlackLists",
32819 "group": "Voice_Queues",
32820 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32821 "version": "0.0.0",
32822 "filename": "server/api/voiceQueue/index.js",
32823 "groupTitle": "Voice_Queues"
32827 "url": "/api/voice/queues/{id}/lists",
32828 "title": "Remove lists from a queue",
32831 "title": "Example usage:",
32832 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32836 "name": "RemoveLists",
32837 "group": "Voice_Queues",
32838 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32839 "version": "0.0.0",
32840 "filename": "server/api/voiceQueue/index.js",
32841 "groupTitle": "Voice_Queues"
32845 "url": "/api/voice/queues/{id}",
32846 "title": "Gets a single Queue",
32849 "title": "Example usage:",
32850 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32854 "name": "ShowQueues",
32855 "group": "Voice_Queues",
32856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32857 "version": "0.0.0",
32858 "filename": "server/api/voiceQueue/index.js",
32859 "groupTitle": "Voice_Queues"
32863 "url": "/api/voice/queues/{id}/blacks",
32864 "title": "Gets queue hopper blacks",
32867 "title": "Example usage:",
32868 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
32872 "name": "getHopperBlacks",
32873 "group": "Voice_Queues",
32874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32875 "version": "0.0.0",
32876 "filename": "server/api/voiceQueue/index.js",
32877 "groupTitle": "Voice_Queues"
32881 "url": "/api/voice/queues/{id}",
32882 "title": "Update an existing Queue",
32885 "title": "Example usage:",
32886 "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",
32890 "name": "updateQueues",
32891 "group": "Voice_Queues",
32892 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32893 "version": "0.0.0",
32894 "filename": "server/api/voiceQueue/index.js",
32895 "groupTitle": "Voice_Queues"
32899 "url": "/api/voice/recordings",
32900 "title": "Creates a new Recording",
32903 "title": "Example usage:",
32904 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32908 "name": "CreateRecordings",
32909 "group": "Voice_Recordings",
32924 "field": "uniqueid",
32931 "field": "channel",
32938 "field": "membername",
32945 "field": "calleridnum",
32952 "field": "calleridname",
32959 "field": "connectedlinenum",
32966 "field": "connectedlinename",
32973 "field": "accountcode",
32980 "field": "context",
33022 "field": "userDisposition",
33029 "field": "userSecondDisposition",
33036 "field": "userThirdDisposition",
33043 "field": "location",
33050 "field": "transcribeName",
33057 "field": "transcribeStatus",
33064 "field": "fileUri",
33071 "field": "fileText",
33078 "field": "failureReason",
33085 "field": "sentiment",
33092 "field": "sPositive",
33099 "field": "sNegative",
33106 "field": "sNeutral",
33120 "field": "tempSentiment",
33127 "field": "createdAt",
33134 "field": "updatedAt",
33140 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33141 "version": "0.0.0",
33142 "filename": "server/api/voiceRecording/index.js",
33143 "groupTitle": "Voice_Recordings"
33147 "url": "/api/voice/recordings/describe",
33148 "title": "Gets table info about Recordings",
33151 "title": "Example usage:",
33152 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33156 "name": "DescribeRecordings",
33157 "group": "Voice_Recordings",
33158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33159 "version": "0.0.0",
33160 "filename": "server/api/voiceRecording/index.js",
33161 "groupTitle": "Voice_Recordings"
33165 "url": "/api/voice/recordings",
33166 "title": "Gets a list of Recordings",
33169 "title": "Example usage:",
33170 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33174 "name": "GetRecordings",
33175 "group": "Voice_Recordings",
33176 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33177 "version": "0.0.0",
33178 "filename": "server/api/voiceRecording/index.js",
33179 "groupTitle": "Voice_Recordings"
33183 "url": "/api/voice/recordings/{id}",
33184 "title": "Gets a single Recording",
33187 "title": "Example usage:",
33188 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33192 "name": "ShowRecordings",
33193 "group": "Voice_Recordings",
33194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33195 "version": "0.0.0",
33196 "filename": "server/api/voiceRecording/index.js",
33197 "groupTitle": "Voice_Recordings"
33201 "url": "/api/voice/recordings/{id}",
33202 "title": "Delete voice recording",
33205 "title": "Example usage:",
33206 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33211 "group": "Voice_Recordings",
33212 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33213 "version": "0.0.0",
33214 "filename": "server/api/voiceRecording/index.js",
33215 "groupTitle": "Voice_Recordings"
33219 "url": "/api/voice/recordings/{id}/download",
33220 "title": "Download Recording",
33223 "title": "Example usage:",
33224 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33228 "name": "download",
33229 "group": "Voice_Recordings",
33230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33231 "version": "0.0.0",
33232 "filename": "server/api/voiceRecording/index.js",
33233 "groupTitle": "Voice_Recordings"
33237 "url": "/api/voice/recordings/{id}/downloads",
33238 "title": "Download Recording",
33241 "title": "Example usage:",
33242 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33246 "name": "downloads",
33247 "group": "Voice_Recordings",
33248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33249 "version": "0.0.0",
33250 "filename": "server/api/voiceRecording/index.js",
33251 "groupTitle": "Voice_Recordings"
33255 "url": "/api/voice/recordings/{id}/transcribe",
33256 "title": "Run Transcribe Recording",
33259 "title": "Example usage:",
33260 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33264 "name": "transcribe",
33265 "group": "Voice_Recordings",
33266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33267 "version": "0.0.0",
33268 "filename": "server/api/voiceRecording/index.js",
33269 "groupTitle": "Voice_Recordings"
33273 "url": "/api/voice/recordings/{id}/transcribe",
33274 "title": "Run Transcribe Recording",
33277 "title": "Example usage:",
33278 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33282 "name": "transcribe",
33283 "group": "Voice_Recordings",
33284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33285 "version": "0.0.0",
33286 "filename": "server/api/voiceRecording/index.js",
33287 "groupTitle": "Voice_Recordings"
33291 "url": "/api/voice/recordings/{id}",
33292 "title": "Update an existing Recording",
33295 "title": "Example usage:",
33296 "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",
33300 "name": "updateRecordings",
33301 "group": "Voice_Recordings",
33302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33303 "version": "0.0.0",
33304 "filename": "server/api/voiceRecording/index.js",
33305 "groupTitle": "Voice_Recordings"
33309 "url": "/api/voice/transfers/reports",
33310 "title": "Creates a new Transfer Report",
33313 "title": "Example usage:",
33314 "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",
33318 "name": "CreateTransfer_Reports",
33319 "group": "Voice_Transfer_Reports",
33345 "field": "transfererchannel",
33352 "field": "transferercalleridnum",
33359 "field": "transferercalleridname",
33366 "field": "transfererconnectedlinenum",
33373 "field": "transfererconnectedlinename",
33380 "field": "transfereraccountcode",
33387 "field": "transferercontext",
33394 "field": "transfererexten",
33401 "field": "transfererlinkedid",
33408 "field": "transfereechannel",
33415 "field": "transfereecalleridnum",
33422 "field": "transfereecalleridname",
33429 "field": "transfereeconnectedlinenum",
33436 "field": "transfereeconnectedlinename",
33443 "field": "transfereeaccountcode",
33450 "field": "transfereecontext",
33457 "field": "transfereeexten",
33464 "field": "transfereelinkedid",
33475 "field": "isexternal",
33482 "field": "context",
33489 "field": "extension",
33495 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33496 "version": "0.0.0",
33497 "filename": "server/api/voiceTransferReport/index.js",
33498 "groupTitle": "Voice_Transfer_Reports"
33502 "url": "/api/voice/transfers/reports/{id}",
33503 "title": "Deletes a Transfer Report",
33506 "title": "Example usage:",
33507 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33511 "name": "DeleteTransfer_Reports",
33512 "group": "Voice_Transfer_Reports",
33513 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33514 "version": "0.0.0",
33515 "filename": "server/api/voiceTransferReport/index.js",
33516 "groupTitle": "Voice_Transfer_Reports"
33520 "url": "/api/voice/transfers/reports/describe",
33521 "title": "Gets table info about Transfer Reports",
33524 "title": "Example usage:",
33525 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33529 "name": "DescribeTransfer_Reports",
33530 "group": "Voice_Transfer_Reports",
33531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33532 "version": "0.0.0",
33533 "filename": "server/api/voiceTransferReport/index.js",
33534 "groupTitle": "Voice_Transfer_Reports"
33538 "url": "/api/voice/transfers/reports",
33539 "title": "Gets a list of Transfer Reports",
33542 "title": "Example usage:",
33543 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33547 "name": "GetTransfer_Reports",
33548 "group": "Voice_Transfer_Reports",
33549 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33550 "version": "0.0.0",
33551 "filename": "server/api/voiceTransferReport/index.js",
33552 "groupTitle": "Voice_Transfer_Reports"
33556 "url": "/api/voice/transfers/reports/{id}",
33557 "title": "Gets a single Transfer Report",
33560 "title": "Example usage:",
33561 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33565 "name": "ShowTransfer_Reports",
33566 "group": "Voice_Transfer_Reports",
33567 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33568 "version": "0.0.0",
33569 "filename": "server/api/voiceTransferReport/index.js",
33570 "groupTitle": "Voice_Transfer_Reports"
33574 "url": "/api/voice/transfers/reports/{id}",
33575 "title": "Update an existing Transfer Report",
33578 "title": "Example usage:",
33579 "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",
33583 "name": "updateTransfer_Reports",
33584 "group": "Voice_Transfer_Reports",
33585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33586 "version": "0.0.0",
33587 "filename": "server/api/voiceTransferReport/index.js",
33588 "groupTitle": "Voice_Transfer_Reports"
33592 "url": "/api/integrations/vtiger/accounts",
33593 "title": "Creates a new Vtiger Account",
33596 "title": "Example usage:",
33597 "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",
33601 "name": "CreateVtiger_Accounts",
33602 "group": "Vtiger_Accounts",
33617 "field": "description",
33624 "field": "username",
33631 "field": "moduleName",
33638 "field": "remoteUri",
33645 "field": "serverUrl",
33652 "field": "accessKey",
33658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33659 "version": "0.0.0",
33660 "filename": "server/api/intVtigerAccount/index.js",
33661 "groupTitle": "Vtiger_Accounts"
33665 "url": "/api/integrations/vtiger/accounts/{id}",
33666 "title": "Deletes a Vtiger Account",
33669 "title": "Example usage:",
33670 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33674 "name": "DeleteVtiger_Accounts",
33675 "group": "Vtiger_Accounts",
33676 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33677 "version": "0.0.0",
33678 "filename": "server/api/intVtigerAccount/index.js",
33679 "groupTitle": "Vtiger_Accounts"
33683 "url": "/api/integrations/vtiger/accounts",
33684 "title": "Gets a list of Vtiger Accounts",
33687 "title": "Example usage:",
33688 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33692 "name": "GetVtiger_Accounts",
33693 "group": "Vtiger_Accounts",
33694 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33695 "version": "0.0.0",
33696 "filename": "server/api/intVtigerAccount/index.js",
33697 "groupTitle": "Vtiger_Accounts"
33701 "url": "/api/integrations/vtiger/accounts/{id}",
33702 "title": "Gets a single Vtiger Account",
33705 "title": "Example usage:",
33706 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33710 "name": "ShowVtiger_Accounts",
33711 "group": "Vtiger_Accounts",
33712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33713 "version": "0.0.0",
33714 "filename": "server/api/intVtigerAccount/index.js",
33715 "groupTitle": "Vtiger_Accounts"
33719 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33720 "title": "Creates new configuration",
33723 "title": "Example usage:",
33724 "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",
33728 "name": "addConfiguration",
33729 "group": "Vtiger_Accounts",
33730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33731 "version": "0.0.0",
33732 "filename": "server/api/intVtigerAccount/index.js",
33733 "groupTitle": "Vtiger_Accounts"
33737 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33738 "title": "Gets account configurations",
33741 "title": "Example usage:",
33742 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33746 "name": "getConfigurations",
33747 "group": "Vtiger_Accounts",
33748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33749 "version": "0.0.0",
33750 "filename": "server/api/intVtigerAccount/index.js",
33751 "groupTitle": "Vtiger_Accounts"
33755 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33756 "title": "Gets account fields",
33759 "title": "Example usage:",
33760 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33764 "name": "getFields",
33765 "group": "Vtiger_Accounts",
33766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33767 "version": "0.0.0",
33768 "filename": "server/api/intVtigerAccount/index.js",
33769 "groupTitle": "Vtiger_Accounts"
33773 "url": "/api/integrations/vtiger/accounts/{id}",
33774 "title": "Update an existing Vtiger Account",
33777 "title": "Example usage:",
33778 "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",
33782 "name": "updateVtiger_Accounts",
33783 "group": "Vtiger_Accounts",
33784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33785 "version": "0.0.0",
33786 "filename": "server/api/intVtigerAccount/index.js",
33787 "groupTitle": "Vtiger_Accounts"
33791 "url": "/api/integrations/vtiger/configurations",
33792 "title": "Creates a new Vtiger Configuration",
33795 "title": "Example usage:",
33796 "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",
33800 "name": "CreateVtiger_Configurations",
33801 "group": "Vtiger_Configurations",
33816 "field": "description",
33822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33823 "version": "0.0.0",
33824 "filename": "server/api/intVtigerConfiguration/index.js",
33825 "groupTitle": "Vtiger_Configurations"
33829 "url": "/api/integrations/vtiger/configurations/{id}",
33830 "title": "Deletes a Vtiger Configuration",
33833 "title": "Example usage:",
33834 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33838 "name": "DeleteVtiger_Configurations",
33839 "group": "Vtiger_Configurations",
33840 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33841 "version": "0.0.0",
33842 "filename": "server/api/intVtigerConfiguration/index.js",
33843 "groupTitle": "Vtiger_Configurations"
33847 "url": "/api/integrations/vtiger/configurations",
33848 "title": "Gets a list of Vtiger Configurations",
33851 "title": "Example usage:",
33852 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33856 "name": "GetVtiger_Configurations",
33857 "group": "Vtiger_Configurations",
33858 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33859 "version": "0.0.0",
33860 "filename": "server/api/intVtigerConfiguration/index.js",
33861 "groupTitle": "Vtiger_Configurations"
33865 "url": "/api/integrations/vtiger/configurations/{id}",
33866 "title": "Gets a single Vtiger Configuration",
33869 "title": "Example usage:",
33870 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33874 "name": "ShowVtiger_Configurations",
33875 "group": "Vtiger_Configurations",
33876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33877 "version": "0.0.0",
33878 "filename": "server/api/intVtigerConfiguration/index.js",
33879 "groupTitle": "Vtiger_Configurations"
33883 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33884 "title": "Gets configurations descriptions",
33887 "title": "Example usage:",
33888 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33892 "name": "getDescriptions",
33893 "group": "Vtiger_Configurations",
33894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33895 "version": "0.0.0",
33896 "filename": "server/api/intVtigerConfiguration/index.js",
33897 "groupTitle": "Vtiger_Configurations"
33901 "url": "/api/integrations/vtiger/configurations/{id}/fields",
33902 "title": "Gets configurations fields",
33905 "title": "Example usage:",
33906 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33910 "name": "getFields",
33911 "group": "Vtiger_Configurations",
33912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33913 "version": "0.0.0",
33914 "filename": "server/api/intVtigerConfiguration/index.js",
33915 "groupTitle": "Vtiger_Configurations"
33919 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33920 "title": "Gets configurations subjects",
33923 "title": "Example usage:",
33924 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33928 "name": "getSubjects",
33929 "group": "Vtiger_Configurations",
33930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33931 "version": "0.0.0",
33932 "filename": "server/api/intVtigerConfiguration/index.js",
33933 "groupTitle": "Vtiger_Configurations"
33937 "url": "/api/integrations/vtiger/configurations/{id}",
33938 "title": "Update an existing Vtiger Configuration",
33941 "title": "Example usage:",
33942 "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",
33946 "name": "updateVtiger_Configurations",
33947 "group": "Vtiger_Configurations",
33948 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33949 "version": "0.0.0",
33950 "filename": "server/api/intVtigerConfiguration/index.js",
33951 "groupTitle": "Vtiger_Configurations"
33955 "url": "/api/integrations/vtiger/fields",
33956 "title": "Creates a new Vtiger Field",
33959 "title": "Example usage:",
33960 "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",
33964 "name": "CreateVtiger_Fields",
33965 "group": "Vtiger_Fields",
33975 "\"customVariable\"",
33987 "field": "content",
34003 "\"customVariable\""
34006 "field": "keyType",
34013 "field": "keyContent",
34020 "field": "idField",
34027 "field": "nameField",
34034 "field": "customField",
34041 "field": "variableName",
34047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34048 "version": "0.0.0",
34049 "filename": "server/api/intVtigerField/index.js",
34050 "groupTitle": "Vtiger_Fields"
34054 "url": "/api/integrations/vtiger/fields/{id}",
34055 "title": "Deletes a Vtiger Field",
34058 "title": "Example usage:",
34059 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34063 "name": "DeleteVtiger_Fields",
34064 "group": "Vtiger_Fields",
34065 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34066 "version": "0.0.0",
34067 "filename": "server/api/intVtigerField/index.js",
34068 "groupTitle": "Vtiger_Fields"
34072 "url": "/api/integrations/vtiger/fields",
34073 "title": "Gets a list of Vtiger Fields",
34076 "title": "Example usage:",
34077 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34081 "name": "GetVtiger_Fields",
34082 "group": "Vtiger_Fields",
34083 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34084 "version": "0.0.0",
34085 "filename": "server/api/intVtigerField/index.js",
34086 "groupTitle": "Vtiger_Fields"
34090 "url": "/api/integrations/vtiger/fields/{id}",
34091 "title": "Gets a single Vtiger Field",
34094 "title": "Example usage:",
34095 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34099 "name": "ShowVtiger_Fields",
34100 "group": "Vtiger_Fields",
34101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34102 "version": "0.0.0",
34103 "filename": "server/api/intVtigerField/index.js",
34104 "groupTitle": "Vtiger_Fields"
34108 "url": "/api/integrations/vtiger/fields/{id}",
34109 "title": "Update an existing Vtiger Field",
34112 "title": "Example usage:",
34113 "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",
34117 "name": "updateVtiger_Fields",
34118 "group": "Vtiger_Fields",
34119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34120 "version": "0.0.0",
34121 "filename": "server/api/intVtigerField/index.js",
34122 "groupTitle": "Vtiger_Fields"
34126 "url": "/api/webbar/answer",
34127 "title": "answer webrtc call",
34130 "title": "Example usage:",
34131 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34135 "name": "Web_Bar_answer",
34144 "field": "sessionId",
34157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34158 "version": "0.0.0",
34159 "filename": "server/api/webbar/index.js",
34160 "groupTitle": "WebBar"
34164 "url": "/api/webbar/calls",
34165 "title": "webrtc call list",
34168 "title": "Example usage:",
34169 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34173 "name": "Web_Bar_calls",
34188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34189 "version": "0.0.0",
34190 "filename": "server/api/webbar/index.js",
34191 "groupTitle": "WebBar"
34195 "url": "/api/webbar/hangup",
34196 "title": "hangup webrtc call",
34199 "title": "Example usage:",
34200 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34204 "name": "Web_Bar_hangup",
34213 "field": "sessionId",
34226 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34227 "version": "0.0.0",
34228 "filename": "server/api/webbar/index.js",
34229 "groupTitle": "WebBar"
34233 "url": "/api/webbar/unhold",
34234 "title": "unhold webrtc call",
34237 "title": "Example usage:",
34238 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34242 "name": "Web_Bar_hold",
34251 "field": "sessionId",
34264 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34265 "version": "0.0.0",
34266 "filename": "server/api/webbar/index.js",
34267 "groupTitle": "WebBar"
34271 "url": "/api/webbar/hold",
34272 "title": "hold webrtc call",
34275 "title": "Example usage:",
34276 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34280 "name": "Web_Bar_hold",
34289 "field": "sessionId",
34302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34303 "version": "0.0.0",
34304 "filename": "server/api/webbar/index.js",
34305 "groupTitle": "WebBar"
34309 "url": "/api/webbar/originate",
34310 "title": "Originate new webrtc call",
34313 "title": "Example usage:",
34314 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34318 "name": "Web_Bar_originate",
34327 "field": "callNumber",
34341 "field": "callerId",
34348 "field": "callbackUrl",
34354 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34355 "version": "0.0.0",
34356 "filename": "server/api/webbar/index.js",
34357 "groupTitle": "WebBar"
34361 "url": "/api/webbar/transfer",
34362 "title": "blind transfer webrtc call",
34365 "title": "Example usage:",
34366 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34370 "name": "Web_Bar_transfer",
34386 "field": "sessionId",
34393 "field": "transferNumber",
34399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34400 "version": "0.0.0",
34401 "filename": "server/api/webbar/index.js",
34402 "groupTitle": "WebBar"
34406 "url": "/api/whatsapp/accounts/{id}/users",
34407 "title": "Add agents to a whatsapp account",
34410 "title": "Example usage:",
34411 "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",
34415 "name": "AddAgents",
34416 "group": "Whatsapp_Accounts",
34417 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34418 "version": "0.0.0",
34419 "filename": "server/api/whatsappAccount/index.js",
34420 "groupTitle": "Whatsapp_Accounts"
34424 "url": "/api/whatsapp/accounts",
34425 "title": "Creates a new Account",
34428 "title": "Example usage:",
34429 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34433 "name": "CreateAccounts",
34434 "group": "Whatsapp_Accounts",
34487 "field": "accountSid",
34494 "field": "authToken",
34501 "field": "notificationTemplate",
34508 "field": "notificationSound",
34515 "field": "notificationShake",
34522 "field": "waitForTheAssignedAgent",
34529 "field": "queueTransfer",
34536 "field": "queueTransferTimeout",
34543 "field": "agentTransfer",
34550 "field": "agentTransferTimeout",
34557 "field": "mandatoryDispositionPauseId",
34558 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34564 "field": "mandatoryDisposition",
34565 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34571 "field": "description",
34577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34578 "version": "0.0.0",
34579 "filename": "server/api/whatsappAccount/index.js",
34580 "groupTitle": "Whatsapp_Accounts"
34584 "url": "/api/whatsapp/accounts/{id}",
34585 "title": "Deletes a Account",
34588 "title": "Example usage:",
34589 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34593 "name": "DeleteAccounts",
34594 "group": "Whatsapp_Accounts",
34595 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34596 "version": "0.0.0",
34597 "filename": "server/api/whatsappAccount/index.js",
34598 "groupTitle": "Whatsapp_Accounts"
34602 "url": "/api/whatsapp/accounts/describe",
34603 "title": "Gets table info about Accounts",
34606 "title": "Example usage:",
34607 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34611 "name": "DescribeAccounts",
34612 "group": "Whatsapp_Accounts",
34613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34614 "version": "0.0.0",
34615 "filename": "server/api/whatsappAccount/index.js",
34616 "groupTitle": "Whatsapp_Accounts"
34620 "url": "/api/whatsapp/accounts",
34621 "title": "Gets a list of Accounts",
34624 "title": "Example usage:",
34625 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34629 "name": "GetAccounts",
34630 "group": "Whatsapp_Accounts",
34631 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34632 "version": "0.0.0",
34633 "filename": "server/api/whatsappAccount/index.js",
34634 "groupTitle": "Whatsapp_Accounts"
34638 "url": "/api/whatsapp/accounts/{id}/users",
34639 "title": "Gets agents from whatsapp account",
34642 "title": "Example usage:",
34643 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34647 "name": "GetAgents",
34648 "group": "Whatsapp_Accounts",
34649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34650 "version": "0.0.0",
34651 "filename": "server/api/whatsappAccount/index.js",
34652 "groupTitle": "Whatsapp_Accounts"
34656 "url": "/api/whatsapp/accounts/{id}/users",
34657 "title": "Removes agents from a whatsapp account",
34660 "title": "Example usage:",
34661 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34665 "name": "RemoveAgents",
34666 "group": "Whatsapp_Accounts",
34667 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34668 "version": "0.0.0",
34669 "filename": "server/api/whatsappAccount/index.js",
34670 "groupTitle": "Whatsapp_Accounts"
34674 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34675 "title": "Removes canned answers from account",
34678 "title": "Example usage:",
34679 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34683 "name": "RemoveAnswers",
34684 "group": "Whatsapp_Accounts",
34685 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34686 "version": "0.0.0",
34687 "filename": "server/api/whatsappAccount/index.js",
34688 "groupTitle": "Whatsapp_Accounts"
34692 "url": "/api/whatsapp/accounts/{id}/dispositions",
34693 "title": "Removes dispositions from account",
34696 "title": "Example usage:",
34697 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34701 "name": "RemoveDispositions",
34702 "group": "Whatsapp_Accounts",
34703 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34704 "version": "0.0.0",
34705 "filename": "server/api/whatsappAccount/index.js",
34706 "groupTitle": "Whatsapp_Accounts"
34710 "url": "/api/whatsapp/accounts/{id}",
34711 "title": "Gets a single Account",
34714 "title": "Example usage:",
34715 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34719 "name": "ShowAccounts",
34720 "group": "Whatsapp_Accounts",
34721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34722 "version": "0.0.0",
34723 "filename": "server/api/whatsappAccount/index.js",
34724 "groupTitle": "Whatsapp_Accounts"
34728 "url": "/api/whatsapp/messages/{id}/accept",
34729 "title": "Accepts message",
34732 "title": "Example usage:",
34733 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34737 "name": "acceptMessage",
34738 "group": "Whatsapp_Accounts",
34739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34740 "version": "0.0.0",
34741 "filename": "server/api/whatsappMessage/index.js",
34742 "groupTitle": "Whatsapp_Accounts"
34746 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34747 "title": "Creates new canned answer",
34750 "title": "Example usage:",
34751 "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",
34755 "name": "addAnswer",
34756 "group": "Whatsapp_Accounts",
34778 "field": "description",
34791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34792 "version": "0.0.0",
34793 "filename": "server/api/whatsappAccount/index.js",
34794 "groupTitle": "Whatsapp_Accounts"
34798 "url": "/api/whatsapp/accounts/{id}/applications",
34799 "title": "Creates new applications",
34802 "title": "Example usage:",
34803 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34807 "name": "addApplications",
34808 "group": "Whatsapp_Accounts",
34816 "field": "priority",
34830 "field": "appdata",
34837 "field": "description",
34844 "field": "interval",
34850 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34851 "version": "0.0.0",
34852 "filename": "server/api/whatsappAccount/index.js",
34853 "groupTitle": "Whatsapp_Accounts"
34857 "url": "/api/whatsapp/accounts/{id}/dispositions",
34858 "title": "Creates new disposition",
34861 "title": "Example usage:",
34862 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34866 "name": "addDisposition",
34867 "group": "Whatsapp_Accounts",
34894 "field": "description",
34900 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34901 "version": "0.0.0",
34902 "filename": "server/api/whatsappAccount/index.js",
34903 "groupTitle": "Whatsapp_Accounts"
34907 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34908 "title": "Gets account canned answers",
34911 "title": "Example usage:",
34912 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34916 "name": "getAnswers",
34917 "group": "Whatsapp_Accounts",
34918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34919 "version": "0.0.0",
34920 "filename": "server/api/whatsappAccount/index.js",
34921 "groupTitle": "Whatsapp_Accounts"
34925 "url": "/api/whatsapp/accounts/{id}/applications",
34926 "title": "Gets account applications",
34929 "title": "Example usage:",
34930 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34934 "name": "getApplications",
34935 "group": "Whatsapp_Accounts",
34936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34937 "version": "0.0.0",
34938 "filename": "server/api/whatsappAccount/index.js",
34939 "groupTitle": "Whatsapp_Accounts"
34943 "url": "/api/whatsapp/accounts/{id}/dispositions",
34944 "title": "Gets account dispositions",
34947 "title": "Example usage:",
34948 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34952 "name": "getDispositions",
34953 "group": "Whatsapp_Accounts",
34954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34955 "version": "0.0.0",
34956 "filename": "server/api/whatsappAccount/index.js",
34957 "groupTitle": "Whatsapp_Accounts"
34961 "url": "/api/whatsapp/accounts/{id}/notify",
34962 "title": "Notify new message",
34965 "title": "Example usage:",
34966 "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",
34971 "group": "Whatsapp_Accounts",
34972 "description": "<p>Motion 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>",
34973 "version": "0.0.0",
34974 "filename": "server/api/whatsappAccount/index.js",
34975 "groupTitle": "Whatsapp_Accounts"
34979 "url": "/api/whatsapp/messages/{id}/reject",
34980 "title": "Rejects message",
34983 "title": "Example usage:",
34984 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34988 "name": "rejectMessage",
34989 "group": "Whatsapp_Accounts",
34990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34991 "version": "0.0.0",
34992 "filename": "server/api/whatsappMessage/index.js",
34993 "groupTitle": "Whatsapp_Accounts"
34997 "url": "/api/whatsapp/accounts/{id}/send",
34998 "title": "Send new whatsapp message",
35001 "title": "Example usage:",
35002 "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",
35006 "name": "sendWhatsapp",
35007 "group": "Whatsapp_Accounts",
35008 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35009 "version": "0.0.0",
35010 "filename": "server/api/whatsappAccount/index.js",
35011 "groupTitle": "Whatsapp_Accounts"
35015 "url": "/api/whatsapp/messages/{id}/status",
35016 "title": "Receive message status",
35019 "title": "Example usage:",
35020 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35024 "name": "statusMessage",
35025 "group": "Whatsapp_Accounts",
35026 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35027 "version": "0.0.0",
35028 "filename": "server/api/whatsappMessage/index.js",
35029 "groupTitle": "Whatsapp_Accounts"
35033 "url": "/api/whatsapp/accounts/{id}",
35034 "title": "Update an existing Account",
35037 "title": "Example usage:",
35038 "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",
35042 "name": "updateAccounts",
35043 "group": "Whatsapp_Accounts",
35044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35045 "version": "0.0.0",
35046 "filename": "server/api/whatsappAccount/index.js",
35047 "groupTitle": "Whatsapp_Accounts"
35051 "url": "/api/whatsapp/applications",
35052 "title": "Creates a new Application",
35055 "title": "Example usage:",
35056 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35060 "name": "CreateApplications",
35061 "group": "Whatsapp_Applications",
35069 "field": "priority",
35083 "field": "appdata",
35090 "field": "description",
35097 "field": "interval",
35103 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35104 "version": "0.0.0",
35105 "filename": "server/api/whatsappApplication/index.js",
35106 "groupTitle": "Whatsapp_Applications"
35110 "url": "/api/whatsapp/applications/{id}",
35111 "title": "Deletes a Application",
35114 "title": "Example usage:",
35115 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35119 "name": "DeleteApplications",
35120 "group": "Whatsapp_Applications",
35121 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35122 "version": "0.0.0",
35123 "filename": "server/api/whatsappApplication/index.js",
35124 "groupTitle": "Whatsapp_Applications"
35128 "url": "/api/whatsapp/applications",
35129 "title": "Gets a list of Applications",
35132 "title": "Example usage:",
35133 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35137 "name": "GetApplications",
35138 "group": "Whatsapp_Applications",
35139 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35140 "version": "0.0.0",
35141 "filename": "server/api/whatsappApplication/index.js",
35142 "groupTitle": "Whatsapp_Applications"
35146 "url": "/api/whatsapp/applications/{id}",
35147 "title": "Gets a single Application",
35150 "title": "Example usage:",
35151 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35155 "name": "ShowApplications",
35156 "group": "Whatsapp_Applications",
35157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35158 "version": "0.0.0",
35159 "filename": "server/api/whatsappApplication/index.js",
35160 "groupTitle": "Whatsapp_Applications"
35164 "url": "/api/whatsapp/applications/{id}",
35165 "title": "Update an existing Application",
35168 "title": "Example usage:",
35169 "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",
35173 "name": "updateApplications",
35174 "group": "Whatsapp_Applications",
35175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35176 "version": "0.0.0",
35177 "filename": "server/api/whatsappApplication/index.js",
35178 "groupTitle": "Whatsapp_Applications"
35182 "url": "/api/whatsapp/interactions/{id}/tags",
35183 "title": "Add tags to the interaction",
35186 "title": "Example usage:",
35187 "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",
35192 "group": "Whatsapp_Interactions",
35193 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35194 "version": "0.0.0",
35195 "filename": "server/api/whatsappInteraction/index.js",
35196 "groupTitle": "Whatsapp_Interactions"
35200 "url": "/api/whatsapp/interactions",
35201 "title": "Creates a new Interaction",
35204 "title": "Example usage:",
35205 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35209 "name": "CreateInteractions",
35210 "group": "Whatsapp_Interactions",
35225 "field": "closedAt",
35232 "field": "disposition",
35239 "field": "secondDisposition",
35246 "field": "thirdDisposition",
35267 "field": "read1stAt",
35278 "field": "firstMsgDirection",
35285 "field": "lastMsgAt",
35296 "field": "lastMsgDirection",
35302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35303 "version": "0.0.0",
35304 "filename": "server/api/whatsappInteraction/index.js",
35305 "groupTitle": "Whatsapp_Interactions"
35309 "url": "/api/whatsapp/interactions/{id}",
35310 "title": "Deletes a Interaction",
35313 "title": "Example usage:",
35314 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35318 "name": "DeleteInteractions",
35319 "group": "Whatsapp_Interactions",
35320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35321 "version": "0.0.0",
35322 "filename": "server/api/whatsappInteraction/index.js",
35323 "groupTitle": "Whatsapp_Interactions"
35327 "url": "/api/whatsapp/interactions/describe",
35328 "title": "Gets table info about Interactions",
35331 "title": "Example usage:",
35332 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35336 "name": "DescribeInteractions",
35337 "group": "Whatsapp_Interactions",
35338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35339 "version": "0.0.0",
35340 "filename": "server/api/whatsappInteraction/index.js",
35341 "groupTitle": "Whatsapp_Interactions"
35345 "url": "/api/whatsapp/interactions",
35346 "title": "Gets a list of Interactions",
35349 "title": "Example usage:",
35350 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35354 "name": "GetInteractions",
35355 "group": "Whatsapp_Interactions",
35356 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35357 "version": "0.0.0",
35358 "filename": "server/api/whatsappInteraction/index.js",
35359 "groupTitle": "Whatsapp_Interactions"
35363 "url": "/api/whatsapp/interactions/{id}/tags",
35364 "title": "Removes tags from interaction",
35367 "title": "Example usage:",
35368 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35372 "name": "RemoveTags",
35373 "group": "Whatsapp_Interactions",
35374 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35375 "version": "0.0.0",
35376 "filename": "server/api/whatsappInteraction/index.js",
35377 "groupTitle": "Whatsapp_Interactions"
35381 "url": "/api/whatsapp/interactions/{id}",
35382 "title": "Gets a single Interaction",
35385 "title": "Example usage:",
35386 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35390 "name": "ShowInteractions",
35391 "group": "Whatsapp_Interactions",
35392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35393 "version": "0.0.0",
35394 "filename": "server/api/whatsappInteraction/index.js",
35395 "groupTitle": "Whatsapp_Interactions"
35399 "url": "/api/whatsapp/interactions/{id}/messages",
35400 "title": "Creates new messages",
35403 "title": "Example usage:",
35404 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35408 "name": "addMessage",
35409 "group": "Whatsapp_Interactions",
35435 "field": "direction",
35442 "field": "messageId",
35470 "field": "providerName",
35477 "field": "providerResponse",
35483 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35484 "version": "0.0.0",
35485 "filename": "server/api/whatsappInteraction/index.js",
35486 "groupTitle": "Whatsapp_Interactions"
35490 "url": "/api/whatsapp/interactions/{id}/download",
35491 "title": "Gets interaction",
35494 "title": "Example usage:",
35495 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35499 "name": "download",
35500 "group": "Whatsapp_Interactions",
35501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35502 "version": "0.0.0",
35503 "filename": "server/api/whatsappInteraction/index.js",
35504 "groupTitle": "Whatsapp_Interactions"
35508 "url": "/api/whatsapp/interactions/{id}/messages",
35509 "title": "Gets interaction messages",
35512 "title": "Example usage:",
35513 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35517 "name": "getMessages",
35518 "group": "Whatsapp_Interactions",
35519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35520 "version": "0.0.0",
35521 "filename": "server/api/whatsappInteraction/index.js",
35522 "groupTitle": "Whatsapp_Interactions"
35526 "url": "/api/whatsapp/interactions/{id}",
35527 "title": "Update an existing Interaction",
35530 "title": "Example usage:",
35531 "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",
35535 "name": "updateInteractions",
35536 "group": "Whatsapp_Interactions",
35537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35538 "version": "0.0.0",
35539 "filename": "server/api/whatsappInteraction/index.js",
35540 "groupTitle": "Whatsapp_Interactions"
35544 "url": "/api/whatsapp/messages",
35545 "title": "Creates a new Message",
35548 "title": "Example usage:",
35549 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35553 "name": "CreateMessages",
35554 "group": "Whatsapp_Messages",
35580 "field": "direction",
35587 "field": "messageId",
35615 "field": "providerName",
35622 "field": "providerResponse",
35628 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35629 "version": "0.0.0",
35630 "filename": "server/api/whatsappMessage/index.js",
35631 "groupTitle": "Whatsapp_Messages"
35635 "url": "/api/whatsapp/messages/{id}",
35636 "title": "Deletes a Message",
35639 "title": "Example usage:",
35640 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35644 "name": "DeleteMessages",
35645 "group": "Whatsapp_Messages",
35646 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35647 "version": "0.0.0",
35648 "filename": "server/api/whatsappMessage/index.js",
35649 "groupTitle": "Whatsapp_Messages"
35653 "url": "/api/whatsapp/messages/describe",
35654 "title": "Gets table info about Messages",
35657 "title": "Example usage:",
35658 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35662 "name": "DescribeMessages",
35663 "group": "Whatsapp_Messages",
35664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35665 "version": "0.0.0",
35666 "filename": "server/api/whatsappMessage/index.js",
35667 "groupTitle": "Whatsapp_Messages"
35671 "url": "/api/whatsapp/messages",
35672 "title": "Gets a list of Messages",
35675 "title": "Example usage:",
35676 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35680 "name": "GetMessages",
35681 "group": "Whatsapp_Messages",
35682 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35683 "version": "0.0.0",
35684 "filename": "server/api/whatsappMessage/index.js",
35685 "groupTitle": "Whatsapp_Messages"
35689 "url": "/api/whatsapp/messages/{id}",
35690 "title": "Gets a single Message",
35693 "title": "Example usage:",
35694 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35698 "name": "ShowMessages",
35699 "group": "Whatsapp_Messages",
35700 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35701 "version": "0.0.0",
35702 "filename": "server/api/whatsappMessage/index.js",
35703 "groupTitle": "Whatsapp_Messages"
35707 "url": "/api/whatsapp/messages/{id}",
35708 "title": "Update an existing Message",
35711 "title": "Example usage:",
35712 "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",
35716 "name": "updateMessages",
35717 "group": "Whatsapp_Messages",
35718 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35719 "version": "0.0.0",
35720 "filename": "server/api/whatsappMessage/index.js",
35721 "groupTitle": "Whatsapp_Messages"
35725 "url": "/api/whatsapp/reports/queue",
35726 "title": "Creates a new Whatsapp Queue Report",
35729 "title": "Example usage:",
35730 "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",
35734 "name": "CreateWhatsapp_Queue_Reports",
35735 "group": "Whatsapp_Queue_Reports",
35743 "field": "uniqueid",
35764 "field": "leaveAt",
35771 "field": "acceptAt",
35791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35792 "version": "0.0.0",
35793 "filename": "server/api/whatsappQueueReport/index.js",
35794 "groupTitle": "Whatsapp_Queue_Reports"
35798 "url": "/api/whatsapp/reports/queue/{id}",
35799 "title": "Deletes a Whatsapp Queue Report",
35802 "title": "Example usage:",
35803 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35807 "name": "DeleteWhatsapp_Queue_Reports",
35808 "group": "Whatsapp_Queue_Reports",
35809 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35810 "version": "0.0.0",
35811 "filename": "server/api/whatsappQueueReport/index.js",
35812 "groupTitle": "Whatsapp_Queue_Reports"
35816 "url": "/api/whatsapp/reports/queue/describe",
35817 "title": "Gets table info about Whatsapp Queue Reports",
35820 "title": "Example usage:",
35821 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35825 "name": "DescribeWhatsapp_Queue_Reports",
35826 "group": "Whatsapp_Queue_Reports",
35827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35828 "version": "0.0.0",
35829 "filename": "server/api/whatsappQueueReport/index.js",
35830 "groupTitle": "Whatsapp_Queue_Reports"
35834 "url": "/api/whatsapp/reports/queue",
35835 "title": "Gets a list of Whatsapp Queue Reports",
35838 "title": "Example usage:",
35839 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35843 "name": "GetWhatsapp_Queue_Reports",
35844 "group": "Whatsapp_Queue_Reports",
35845 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35846 "version": "0.0.0",
35847 "filename": "server/api/whatsappQueueReport/index.js",
35848 "groupTitle": "Whatsapp_Queue_Reports"
35852 "url": "/api/whatsapp/reports/queue/{id}",
35853 "title": "Gets a single Whatsapp Queue Report",
35856 "title": "Example usage:",
35857 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35861 "name": "ShowWhatsapp_Queue_Reports",
35862 "group": "Whatsapp_Queue_Reports",
35863 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35864 "version": "0.0.0",
35865 "filename": "server/api/whatsappQueueReport/index.js",
35866 "groupTitle": "Whatsapp_Queue_Reports"
35870 "url": "/api/whatsapp/reports/queue/{id}",
35871 "title": "Update an existing Whatsapp Queue Report",
35874 "title": "Example usage:",
35875 "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",
35879 "name": "updateWhatsapp_Queue_Reports",
35880 "group": "Whatsapp_Queue_Reports",
35881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35882 "version": "0.0.0",
35883 "filename": "server/api/whatsappQueueReport/index.js",
35884 "groupTitle": "Whatsapp_Queue_Reports"
35888 "url": "/api/whatsapp/queues/{id}/users",
35889 "title": "Add agents to a queue",
35892 "title": "Example usage:",
35893 "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",
35897 "name": "AddAgents",
35898 "group": "Whatsapp_Queues",
35899 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35900 "version": "0.0.0",
35901 "filename": "server/api/whatsappQueue/index.js",
35902 "groupTitle": "Whatsapp_Queues"
35906 "url": "/api/whatsapp/queues/{id}/teams",
35907 "title": "Add teams to a queue",
35910 "title": "Example usage:",
35911 "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",
35915 "name": "AddTeams",
35916 "group": "Whatsapp_Queues",
35917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35918 "version": "0.0.0",
35919 "filename": "server/api/whatsappQueue/index.js",
35920 "groupTitle": "Whatsapp_Queues"
35924 "url": "/api/whatsapp/queues",
35925 "title": "Creates a new Queue",
35928 "title": "Example usage:",
35929 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35933 "name": "CreateQueues",
35934 "group": "Whatsapp_Queues",
35949 "field": "timeout",
35961 "field": "strategy",
35968 "field": "description",
35974 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35975 "version": "0.0.0",
35976 "filename": "server/api/whatsappQueue/index.js",
35977 "groupTitle": "Whatsapp_Queues"
35981 "url": "/api/whatsapp/queues/{id}",
35982 "title": "Deletes a Queue",
35985 "title": "Example usage:",
35986 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35990 "name": "DeleteQueues",
35991 "group": "Whatsapp_Queues",
35992 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35993 "version": "0.0.0",
35994 "filename": "server/api/whatsappQueue/index.js",
35995 "groupTitle": "Whatsapp_Queues"
35999 "url": "/api/whatsapp/queues/describe",
36000 "title": "Gets table info about Queues",
36003 "title": "Example usage:",
36004 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36008 "name": "DescribeQueues",
36009 "group": "Whatsapp_Queues",
36010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36011 "version": "0.0.0",
36012 "filename": "server/api/whatsappQueue/index.js",
36013 "groupTitle": "Whatsapp_Queues"
36017 "url": "/api/whatsapp/queues/{id}/users",
36018 "title": "Gets queue agents",
36021 "title": "Example usage:",
36022 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36026 "name": "GetAgents",
36027 "group": "Whatsapp_Queues",
36028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36029 "version": "0.0.0",
36030 "filename": "server/api/whatsappQueue/index.js",
36031 "groupTitle": "Whatsapp_Queues"
36035 "url": "/api/whatsapp/queues/{id}/members",
36036 "title": "GetMembers",
36039 "title": "Example usage:",
36040 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36044 "name": "GetMembers",
36045 "group": "Whatsapp_Queues",
36046 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36047 "version": "0.0.0",
36048 "filename": "server/api/whatsappQueue/index.js",
36049 "groupTitle": "Whatsapp_Queues"
36053 "url": "/api/whatsapp/queues",
36054 "title": "Gets a list of Queues",
36057 "title": "Example usage:",
36058 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36062 "name": "GetQueues",
36063 "group": "Whatsapp_Queues",
36064 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36065 "version": "0.0.0",
36066 "filename": "server/api/whatsappQueue/index.js",
36067 "groupTitle": "Whatsapp_Queues"
36071 "url": "/api/whatsapp/queues/{id}/teams",
36072 "title": "Gets queues list",
36075 "title": "Example usage:",
36076 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36080 "name": "GetTeams",
36081 "group": "Whatsapp_Queues",
36082 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36083 "version": "0.0.0",
36084 "filename": "server/api/whatsappQueue/index.js",
36085 "groupTitle": "Whatsapp_Queues"
36089 "url": "/api/whatsapp/queues/{id}/users",
36090 "title": "Removes agents from a queue",
36093 "title": "Example usage:",
36094 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36098 "name": "RemoveAgents",
36099 "group": "Whatsapp_Queues",
36100 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36101 "version": "0.0.0",
36102 "filename": "server/api/whatsappQueue/index.js",
36103 "groupTitle": "Whatsapp_Queues"
36107 "url": "/api/whatsapp/queues/{id}",
36108 "title": "Gets a single Queue",
36111 "title": "Example usage:",
36112 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36116 "name": "ShowQueues",
36117 "group": "Whatsapp_Queues",
36118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36119 "version": "0.0.0",
36120 "filename": "server/api/whatsappQueue/index.js",
36121 "groupTitle": "Whatsapp_Queues"
36125 "url": "/api/whatsapp/queues/{id}",
36126 "title": "Update an existing Queue",
36129 "title": "Example usage:",
36130 "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",
36134 "name": "updateQueues",
36135 "group": "Whatsapp_Queues",
36136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36137 "version": "0.0.0",
36138 "filename": "server/api/whatsappQueue/index.js",
36139 "groupTitle": "Whatsapp_Queues"
36143 "url": "/api/whatsapp/reports/transfer",
36144 "title": "Creates a new Whatsapp Transfer Report",
36147 "title": "Example usage:",
36148 "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",
36152 "name": "CreateWhatsapp_Transfer_Reports",
36153 "group": "Whatsapp_Transfer_Reports",
36161 "field": "uniqueid",
36180 "field": "transferredAt",
36186 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36187 "version": "0.0.0",
36188 "filename": "server/api/whatsappTransferReport/index.js",
36189 "groupTitle": "Whatsapp_Transfer_Reports"
36193 "url": "/api/whatsapp/reports/transfer/{id}",
36194 "title": "Deletes a Whatsapp Transfer Report",
36197 "title": "Example usage:",
36198 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36202 "name": "DeleteWhatsapp_Transfer_Reports",
36203 "group": "Whatsapp_Transfer_Reports",
36204 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36205 "version": "0.0.0",
36206 "filename": "server/api/whatsappTransferReport/index.js",
36207 "groupTitle": "Whatsapp_Transfer_Reports"
36211 "url": "/api/whatsapp/reports/transfer/describe",
36212 "title": "Gets table info about Whatsapp Transfer Reports",
36215 "title": "Example usage:",
36216 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36220 "name": "DescribeWhatsapp_Transfer_Reports",
36221 "group": "Whatsapp_Transfer_Reports",
36222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36223 "version": "0.0.0",
36224 "filename": "server/api/whatsappTransferReport/index.js",
36225 "groupTitle": "Whatsapp_Transfer_Reports"
36229 "url": "/api/whatsapp/reports/transfer",
36230 "title": "Gets a list of Whatsapp Transfer Reports",
36233 "title": "Example usage:",
36234 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36238 "name": "GetWhatsapp_Transfer_Reports",
36239 "group": "Whatsapp_Transfer_Reports",
36240 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36241 "version": "0.0.0",
36242 "filename": "server/api/whatsappTransferReport/index.js",
36243 "groupTitle": "Whatsapp_Transfer_Reports"
36247 "url": "/api/whatsapp/reports/transfer/{id}",
36248 "title": "Gets a single Whatsapp Transfer Report",
36251 "title": "Example usage:",
36252 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36256 "name": "ShowWhatsapp_Transfer_Reports",
36257 "group": "Whatsapp_Transfer_Reports",
36258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36259 "version": "0.0.0",
36260 "filename": "server/api/whatsappTransferReport/index.js",
36261 "groupTitle": "Whatsapp_Transfer_Reports"
36265 "url": "/api/whatsapp/reports/transfer/{id}",
36266 "title": "Update an existing Whatsapp Transfer Report",
36269 "title": "Example usage:",
36270 "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",
36274 "name": "updateWhatsapp_Transfer_Reports",
36275 "group": "Whatsapp_Transfer_Reports",
36276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36277 "version": "0.0.0",
36278 "filename": "server/api/whatsappTransferReport/index.js",
36279 "groupTitle": "Whatsapp_Transfer_Reports"
36283 "url": "/api/integrations/zendesk/accounts",
36284 "title": "Creates a new Zendesk Account",
36287 "title": "Example usage:",
36288 "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",
36292 "name": "CreateZendesk_Accounts",
36293 "group": "Zendesk_Accounts",
36308 "field": "description",
36315 "field": "username",
36322 "field": "password",
36336 "field": "remoteUri",
36347 "field": "authType",
36354 "field": "serverUrl",
36361 "\"integrationTab\"",
36371 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36372 "version": "0.0.0",
36373 "filename": "server/api/intZendeskAccount/index.js",
36374 "groupTitle": "Zendesk_Accounts"
36378 "url": "/api/integrations/zendesk/accounts/{id}",
36379 "title": "Deletes a Zendesk Account",
36382 "title": "Example usage:",
36383 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36387 "name": "DeleteZendesk_Accounts",
36388 "group": "Zendesk_Accounts",
36389 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36390 "version": "0.0.0",
36391 "filename": "server/api/intZendeskAccount/index.js",
36392 "groupTitle": "Zendesk_Accounts"
36396 "url": "/api/integrations/zendesk/accounts",
36397 "title": "Gets a list of Zendesk Accounts",
36400 "title": "Example usage:",
36401 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36405 "name": "GetZendesk_Accounts",
36406 "group": "Zendesk_Accounts",
36407 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36408 "version": "0.0.0",
36409 "filename": "server/api/intZendeskAccount/index.js",
36410 "groupTitle": "Zendesk_Accounts"
36414 "url": "/api/integrations/zendesk/accounts/{id}",
36415 "title": "Gets a single Zendesk Account",
36418 "title": "Example usage:",
36419 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36423 "name": "ShowZendesk_Accounts",
36424 "group": "Zendesk_Accounts",
36425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36426 "version": "0.0.0",
36427 "filename": "server/api/intZendeskAccount/index.js",
36428 "groupTitle": "Zendesk_Accounts"
36432 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36433 "title": "Creates new configuration",
36436 "title": "Example usage:",
36437 "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",
36441 "name": "addConfiguration",
36442 "group": "Zendesk_Accounts",
36443 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36444 "version": "0.0.0",
36445 "filename": "server/api/intZendeskAccount/index.js",
36446 "groupTitle": "Zendesk_Accounts"
36450 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36451 "title": "Gets account configurations",
36454 "title": "Example usage:",
36455 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36459 "name": "getConfigurations",
36460 "group": "Zendesk_Accounts",
36461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36462 "version": "0.0.0",
36463 "filename": "server/api/intZendeskAccount/index.js",
36464 "groupTitle": "Zendesk_Accounts"
36468 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36469 "title": "Gets account fields",
36472 "title": "Example usage:",
36473 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36477 "name": "getFields",
36478 "group": "Zendesk_Accounts",
36479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36480 "version": "0.0.0",
36481 "filename": "server/api/intZendeskAccount/index.js",
36482 "groupTitle": "Zendesk_Accounts"
36486 "url": "/api/integrations/zendesk/accounts/{id}",
36487 "title": "Update an existing Zendesk Account",
36490 "title": "Example usage:",
36491 "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",
36495 "name": "updateZendesk_Accounts",
36496 "group": "Zendesk_Accounts",
36497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36498 "version": "0.0.0",
36499 "filename": "server/api/intZendeskAccount/index.js",
36500 "groupTitle": "Zendesk_Accounts"
36504 "url": "/api/integrations/zendesk/configurations",
36505 "title": "Creates a new Zendesk Configuration",
36508 "title": "Example usage:",
36509 "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",
36513 "name": "CreateZendesk_Configurations",
36514 "group": "Zendesk_Configurations",
36529 "field": "description",
36535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36536 "version": "0.0.0",
36537 "filename": "server/api/intZendeskConfiguration/index.js",
36538 "groupTitle": "Zendesk_Configurations"
36542 "url": "/api/integrations/zendesk/configurations/{id}",
36543 "title": "Deletes a Zendesk Configuration",
36546 "title": "Example usage:",
36547 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36551 "name": "DeleteZendesk_Configurations",
36552 "group": "Zendesk_Configurations",
36553 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36554 "version": "0.0.0",
36555 "filename": "server/api/intZendeskConfiguration/index.js",
36556 "groupTitle": "Zendesk_Configurations"
36560 "url": "/api/integrations/zendesk/configurations",
36561 "title": "Gets a list of Zendesk Configurations",
36564 "title": "Example usage:",
36565 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36569 "name": "GetZendesk_Configurations",
36570 "group": "Zendesk_Configurations",
36571 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36572 "version": "0.0.0",
36573 "filename": "server/api/intZendeskConfiguration/index.js",
36574 "groupTitle": "Zendesk_Configurations"
36578 "url": "/api/integrations/zendesk/configurations/{id}",
36579 "title": "Gets a single Zendesk Configuration",
36582 "title": "Example usage:",
36583 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36587 "name": "ShowZendesk_Configurations",
36588 "group": "Zendesk_Configurations",
36589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36590 "version": "0.0.0",
36591 "filename": "server/api/intZendeskConfiguration/index.js",
36592 "groupTitle": "Zendesk_Configurations"
36596 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36597 "title": "Gets configurations descriptions",
36600 "title": "Example usage:",
36601 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36605 "name": "getDescriptions",
36606 "group": "Zendesk_Configurations",
36607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36608 "version": "0.0.0",
36609 "filename": "server/api/intZendeskConfiguration/index.js",
36610 "groupTitle": "Zendesk_Configurations"
36614 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36615 "title": "Gets configurations fields",
36618 "title": "Example usage:",
36619 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36623 "name": "getFields",
36624 "group": "Zendesk_Configurations",
36625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36626 "version": "0.0.0",
36627 "filename": "server/api/intZendeskConfiguration/index.js",
36628 "groupTitle": "Zendesk_Configurations"
36632 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36633 "title": "Gets configurations subjects",
36636 "title": "Example usage:",
36637 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36641 "name": "getSubjects",
36642 "group": "Zendesk_Configurations",
36643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36644 "version": "0.0.0",
36645 "filename": "server/api/intZendeskConfiguration/index.js",
36646 "groupTitle": "Zendesk_Configurations"
36650 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36651 "title": "Gets configurations tags",
36654 "title": "Example usage:",
36655 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36660 "group": "Zendesk_Configurations",
36661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36662 "version": "0.0.0",
36663 "filename": "server/api/intZendeskConfiguration/index.js",
36664 "groupTitle": "Zendesk_Configurations"
36668 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36669 "title": "Sets new tags",
36672 "title": "Example usage:",
36673 "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",
36678 "group": "Zendesk_Configurations",
36679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36680 "version": "0.0.0",
36681 "filename": "server/api/intZendeskConfiguration/index.js",
36682 "groupTitle": "Zendesk_Configurations"
36686 "url": "/api/integrations/zendesk/configurations/{id}",
36687 "title": "Update an existing Zendesk Configuration",
36690 "title": "Example usage:",
36691 "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",
36695 "name": "updateZendesk_Configurations",
36696 "group": "Zendesk_Configurations",
36697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36698 "version": "0.0.0",
36699 "filename": "server/api/intZendeskConfiguration/index.js",
36700 "groupTitle": "Zendesk_Configurations"
36704 "url": "/api/integrations/zendesk/fields",
36705 "title": "Creates a new Zendesk Field",
36708 "title": "Example usage:",
36709 "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",
36713 "name": "CreateZendesk_Fields",
36714 "group": "Zendesk_Fields",
36724 "\"customVariable\"",
36736 "field": "content",
36752 "\"customVariable\""
36755 "field": "keyType",
36762 "field": "keyContent",
36769 "field": "idField",
36776 "field": "nameField",
36783 "field": "customField",
36790 "field": "variableName",
36796 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36797 "version": "0.0.0",
36798 "filename": "server/api/intZendeskField/index.js",
36799 "groupTitle": "Zendesk_Fields"
36803 "url": "/api/integrations/zendesk/fields/{id}",
36804 "title": "Deletes a Zendesk Field",
36807 "title": "Example usage:",
36808 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36812 "name": "DeleteZendesk_Fields",
36813 "group": "Zendesk_Fields",
36814 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36815 "version": "0.0.0",
36816 "filename": "server/api/intZendeskField/index.js",
36817 "groupTitle": "Zendesk_Fields"
36821 "url": "/api/integrations/zendesk/fields",
36822 "title": "Gets a list of Zendesk Fields",
36825 "title": "Example usage:",
36826 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36830 "name": "GetZendesk_Fields",
36831 "group": "Zendesk_Fields",
36832 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36833 "version": "0.0.0",
36834 "filename": "server/api/intZendeskField/index.js",
36835 "groupTitle": "Zendesk_Fields"
36839 "url": "/api/integrations/zendesk/fields/{id}",
36840 "title": "Gets a single Zendesk Field",
36843 "title": "Example usage:",
36844 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36848 "name": "ShowZendesk_Fields",
36849 "group": "Zendesk_Fields",
36850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36851 "version": "0.0.0",
36852 "filename": "server/api/intZendeskField/index.js",
36853 "groupTitle": "Zendesk_Fields"
36857 "url": "/api/integrations/zendesk/fields/{id}",
36858 "title": "Update an existing Zendesk Field",
36861 "title": "Example usage:",
36862 "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",
36866 "name": "updateZendesk_Fields",
36867 "group": "Zendesk_Fields",
36868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36869 "version": "0.0.0",
36870 "filename": "server/api/intZendeskField/index.js",
36871 "groupTitle": "Zendesk_Fields"
36875 "url": "/api/integrations/zoho/accounts",
36876 "title": "Creates a new Zoho Account",
36879 "title": "Example usage:",
36880 "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",
36884 "name": "CreateZoho_Accounts",
36885 "group": "Zoho_Accounts",
36900 "field": "description",
36921 "field": "clientId",
36928 "field": "clientSecret",
36935 "field": "serverUrl",
36949 "field": "refreshToken",
36955 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36956 "version": "0.0.0",
36957 "filename": "server/api/intZohoAccount/index.js",
36958 "groupTitle": "Zoho_Accounts"
36962 "url": "/api/integrations/zoho/accounts/{id}",
36963 "title": "Deletes a Zoho Account",
36966 "title": "Example usage:",
36967 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36971 "name": "DeleteZoho_Accounts",
36972 "group": "Zoho_Accounts",
36973 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36974 "version": "0.0.0",
36975 "filename": "server/api/intZohoAccount/index.js",
36976 "groupTitle": "Zoho_Accounts"
36980 "url": "/api/integrations/zoho/accounts",
36981 "title": "Gets a list of Zoho Accounts",
36984 "title": "Example usage:",
36985 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36989 "name": "GetZoho_Accounts",
36990 "group": "Zoho_Accounts",
36991 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36992 "version": "0.0.0",
36993 "filename": "server/api/intZohoAccount/index.js",
36994 "groupTitle": "Zoho_Accounts"
36998 "url": "/api/integrations/zoho/accounts/{id}",
36999 "title": "Gets a single Zoho Account",
37002 "title": "Example usage:",
37003 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37007 "name": "ShowZoho_Accounts",
37008 "group": "Zoho_Accounts",
37009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37010 "version": "0.0.0",
37011 "filename": "server/api/intZohoAccount/index.js",
37012 "groupTitle": "Zoho_Accounts"
37016 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37017 "title": "Creates new configuration",
37020 "title": "Example usage:",
37021 "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",
37025 "name": "addConfiguration",
37026 "group": "Zoho_Accounts",
37027 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37028 "version": "0.0.0",
37029 "filename": "server/api/intZohoAccount/index.js",
37030 "groupTitle": "Zoho_Accounts"
37034 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37035 "title": "Gets account configurations",
37038 "title": "Example usage:",
37039 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37043 "name": "getConfigurations",
37044 "group": "Zoho_Accounts",
37045 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37046 "version": "0.0.0",
37047 "filename": "server/api/intZohoAccount/index.js",
37048 "groupTitle": "Zoho_Accounts"
37052 "url": "/api/integrations/zoho/accounts/{id}/fields",
37053 "title": "Gets account fields",
37056 "title": "Example usage:",
37057 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37061 "name": "getFields",
37062 "group": "Zoho_Accounts",
37063 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37064 "version": "0.0.0",
37065 "filename": "server/api/intZohoAccount/index.js",
37066 "groupTitle": "Zoho_Accounts"
37070 "url": "/api/integrations/zoho/accounts/{id}",
37071 "title": "Update an existing Zoho Account",
37074 "title": "Example usage:",
37075 "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",
37079 "name": "updateZoho_Accounts",
37080 "group": "Zoho_Accounts",
37081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37082 "version": "0.0.0",
37083 "filename": "server/api/intZohoAccount/index.js",
37084 "groupTitle": "Zoho_Accounts"
37088 "url": "/api/integrations/zoho/configurations",
37089 "title": "Creates a new Zoho Configuration",
37092 "title": "Example usage:",
37093 "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",
37097 "name": "CreateZoho_Configurations",
37098 "group": "Zoho_Configurations",
37118 "field": "moduleCreate",
37125 "\"contact_lead\"",
37130 "field": "moduleSearch",
37137 "field": "description",
37143 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37144 "version": "0.0.0",
37145 "filename": "server/api/intZohoConfiguration/index.js",
37146 "groupTitle": "Zoho_Configurations"
37150 "url": "/api/integrations/zoho/configurations/{id}",
37151 "title": "Deletes a Zoho Configuration",
37154 "title": "Example usage:",
37155 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37159 "name": "DeleteZoho_Configurations",
37160 "group": "Zoho_Configurations",
37161 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37162 "version": "0.0.0",
37163 "filename": "server/api/intZohoConfiguration/index.js",
37164 "groupTitle": "Zoho_Configurations"
37168 "url": "/api/integrations/zoho/configurations",
37169 "title": "Gets a list of Zoho Configurations",
37172 "title": "Example usage:",
37173 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37177 "name": "GetZoho_Configurations",
37178 "group": "Zoho_Configurations",
37179 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37180 "version": "0.0.0",
37181 "filename": "server/api/intZohoConfiguration/index.js",
37182 "groupTitle": "Zoho_Configurations"
37186 "url": "/api/integrations/zoho/configurations/{id}",
37187 "title": "Gets a single Zoho Configuration",
37190 "title": "Example usage:",
37191 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37195 "name": "ShowZoho_Configurations",
37196 "group": "Zoho_Configurations",
37197 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37198 "version": "0.0.0",
37199 "filename": "server/api/intZohoConfiguration/index.js",
37200 "groupTitle": "Zoho_Configurations"
37204 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37205 "title": "Gets configurations descriptions",
37208 "title": "Example usage:",
37209 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37213 "name": "getDescriptions",
37214 "group": "Zoho_Configurations",
37215 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37216 "version": "0.0.0",
37217 "filename": "server/api/intZohoConfiguration/index.js",
37218 "groupTitle": "Zoho_Configurations"
37222 "url": "/api/integrations/zoho/configurations/{id}/fields",
37223 "title": "Gets configurations fields",
37226 "title": "Example usage:",
37227 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37231 "name": "getFields",
37232 "group": "Zoho_Configurations",
37233 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37234 "version": "0.0.0",
37235 "filename": "server/api/intZohoConfiguration/index.js",
37236 "groupTitle": "Zoho_Configurations"
37240 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37241 "title": "Gets configurations subjects",
37244 "title": "Example usage:",
37245 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37249 "name": "getSubjects",
37250 "group": "Zoho_Configurations",
37251 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37252 "version": "0.0.0",
37253 "filename": "server/api/intZohoConfiguration/index.js",
37254 "groupTitle": "Zoho_Configurations"
37258 "url": "/api/integrations/zoho/configurations/{id}",
37259 "title": "Update an existing Zoho Configuration",
37262 "title": "Example usage:",
37263 "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",
37267 "name": "updateZoho_Configurations",
37268 "group": "Zoho_Configurations",
37269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37270 "version": "0.0.0",
37271 "filename": "server/api/intZohoConfiguration/index.js",
37272 "groupTitle": "Zoho_Configurations"
37276 "url": "/api/integrations/zoho/fields",
37277 "title": "Creates a new Zoho Field",
37280 "title": "Example usage:",
37281 "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",
37285 "name": "CreateZoho_Fields",
37286 "group": "Zoho_Fields",
37296 "\"customVariable\"",
37308 "field": "content",
37324 "\"customVariable\""
37327 "field": "keyType",
37334 "field": "keyContent",
37341 "field": "idField",
37348 "field": "nameField",
37355 "field": "customField",
37362 "field": "variableName",
37368 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37369 "version": "0.0.0",
37370 "filename": "server/api/intZohoField/index.js",
37371 "groupTitle": "Zoho_Fields"
37375 "url": "/api/integrations/zoho/fields/{id}",
37376 "title": "Deletes a Zoho Field",
37379 "title": "Example usage:",
37380 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37384 "name": "DeleteZoho_Fields",
37385 "group": "Zoho_Fields",
37386 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37387 "version": "0.0.0",
37388 "filename": "server/api/intZohoField/index.js",
37389 "groupTitle": "Zoho_Fields"
37393 "url": "/api/integrations/zoho/fields",
37394 "title": "Gets a list of Zoho Fields",
37397 "title": "Example usage:",
37398 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37402 "name": "GetZoho_Fields",
37403 "group": "Zoho_Fields",
37404 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37405 "version": "0.0.0",
37406 "filename": "server/api/intZohoField/index.js",
37407 "groupTitle": "Zoho_Fields"
37411 "url": "/api/integrations/zoho/fields/{id}",
37412 "title": "Gets a single Zoho Field",
37415 "title": "Example usage:",
37416 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37420 "name": "ShowZoho_Fields",
37421 "group": "Zoho_Fields",
37422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37423 "version": "0.0.0",
37424 "filename": "server/api/intZohoField/index.js",
37425 "groupTitle": "Zoho_Fields"
37429 "url": "/api/integrations/zoho/fields/{id}",
37430 "title": "Update an existing Zoho Field",
37433 "title": "Example usage:",
37434 "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",
37438 "name": "updateZoho_Fields",
37439 "group": "Zoho_Fields",
37440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37441 "version": "0.0.0",
37442 "filename": "server/api/intZohoField/index.js",
37443 "groupTitle": "Zoho_Fields"
37448 "title": "Creates a new Cdr",
37451 "title": "Example usage:",
37452 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37456 "name": "CreateCdrs",
37465 "field": "calldate",
37493 "field": "dcontext",
37500 "field": "channel",
37507 "field": "dstchannel",
37514 "field": "lastapp",
37521 "field": "lastdata",
37528 "field": "duration",
37535 "field": "billsec",
37542 "field": "disposition",
37549 "field": "amaflags",
37556 "field": "accountcode",
37563 "field": "userfield",
37570 "field": "uniqueid",
37577 "field": "linkedid",
37584 "field": "sequence",
37591 "field": "peeraccount",
37611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37612 "version": "0.0.0",
37613 "filename": "server/api/cdr/index.js",
37614 "groupTitle": "cdr"
37618 "url": "/api/cdr/{id}",
37619 "title": "Deletes a Cdr",
37622 "title": "Example usage:",
37623 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37627 "name": "DeleteCdrs",
37629 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37630 "version": "0.0.0",
37631 "filename": "server/api/cdr/index.js",
37632 "groupTitle": "cdr"
37636 "url": "/api/cdr/describe",
37637 "title": "Gets table info about Cdrs",
37640 "title": "Example usage:",
37641 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37645 "name": "DescribeCdrs",
37647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37648 "version": "0.0.0",
37649 "filename": "server/api/cdr/index.js",
37650 "groupTitle": "cdr"
37655 "title": "Gets a list of Cdrs",
37658 "title": "Example usage:",
37659 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37665 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37666 "version": "0.0.0",
37667 "filename": "server/api/cdr/index.js",
37668 "groupTitle": "cdr"
37672 "url": "/api/cdr/{id}",
37673 "title": "Gets a single Cdr",
37676 "title": "Example usage:",
37677 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37681 "name": "ShowCdrs",
37683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37684 "version": "0.0.0",
37685 "filename": "server/api/cdr/index.js",
37686 "groupTitle": "cdr"
37690 "url": "/api/cdr/{id}",
37691 "title": "Update an existing Cdr",
37694 "title": "Example usage:",
37695 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37699 "name": "updateCdrs",
37701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37702 "version": "0.0.0",
37703 "filename": "server/api/cdr/index.js",
37704 "groupTitle": "cdr"
37708 "url": "/api/voiceQueuesLog",
37709 "title": "Creates a new VoiceQueuesLog",
37712 "title": "Example usage:",
37713 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37717 "name": "CreateVoiceQueuesLogs",
37718 "group": "voiceQueuesLog",
37740 "field": "queuename",
37809 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37810 "version": "0.0.0",
37811 "filename": "server/api/voiceQueuesLog/index.js",
37812 "groupTitle": "voiceQueuesLog"
37816 "url": "/api/voiceQueuesLog/{id}",
37817 "title": "Deletes a VoiceQueuesLog",
37820 "title": "Example usage:",
37821 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37825 "name": "DeleteVoiceQueuesLogs",
37826 "group": "voiceQueuesLog",
37827 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37828 "version": "0.0.0",
37829 "filename": "server/api/voiceQueuesLog/index.js",
37830 "groupTitle": "voiceQueuesLog"
37834 "url": "/api/voiceQueuesLog",
37835 "title": "Gets a list of VoiceQueuesLogs",
37838 "title": "Example usage:",
37839 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37843 "name": "GetVoiceQueuesLogs",
37844 "group": "voiceQueuesLog",
37845 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37846 "version": "0.0.0",
37847 "filename": "server/api/voiceQueuesLog/index.js",
37848 "groupTitle": "voiceQueuesLog"
37852 "url": "/api/voiceQueuesLog/{id}",
37853 "title": "Gets a single VoiceQueuesLog",
37856 "title": "Example usage:",
37857 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37861 "name": "ShowVoiceQueuesLogs",
37862 "group": "voiceQueuesLog",
37863 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37864 "version": "0.0.0",
37865 "filename": "server/api/voiceQueuesLog/index.js",
37866 "groupTitle": "voiceQueuesLog"
37870 "url": "/api/voiceQueuesLog/{id}",
37871 "title": "Update an existing VoiceQueuesLog",
37874 "title": "Example usage:",
37875 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37879 "name": "updateVoiceQueuesLogs",
37880 "group": "voiceQueuesLog",
37881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37882 "version": "0.0.0",
37883 "filename": "server/api/voiceQueuesLog/index.js",
37884 "groupTitle": "voiceQueuesLog"