4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/google",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authGoogle/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/local",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authLocal/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/automations",
1381 "title": "Creates a new Automation",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1389 "name": "CreateAutomations",
1390 "group": "Automations",
1412 "field": "description",
1432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1434 "filename": "server/api/automation/index.js",
1435 "groupTitle": "Automations"
1439 "url": "/api/automations/{id}",
1440 "title": "Deletes a Automation",
1443 "title": "Example usage:",
1444 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1448 "name": "DeleteAutomations",
1449 "group": "Automations",
1450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1452 "filename": "server/api/automation/index.js",
1453 "groupTitle": "Automations"
1457 "url": "/api/automations",
1458 "title": "Gets a list of Automations",
1461 "title": "Example usage:",
1462 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1466 "name": "GetAutomations",
1467 "group": "Automations",
1468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1470 "filename": "server/api/automation/index.js",
1471 "groupTitle": "Automations"
1475 "url": "/api/automations/{id}",
1476 "title": "Gets a single Automation",
1479 "title": "Example usage:",
1480 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1484 "name": "ShowAutomations",
1485 "group": "Automations",
1486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488 "filename": "server/api/automation/index.js",
1489 "groupTitle": "Automations"
1493 "url": "/api/automations/{id}/actions",
1494 "title": "Creates new actions",
1497 "title": "Example usage:",
1498 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1502 "name": "addActions",
1503 "group": "Automations",
1519 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1526 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1533 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1540 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1575 "filename": "server/api/automation/index.js",
1576 "groupTitle": "Automations"
1580 "url": "/api/automations/{id}/conditions",
1581 "title": "Creates new conditions",
1584 "title": "Example usage:",
1585 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1589 "name": "addConditions",
1590 "group": "Automations",
1612 "field": "operator",
1625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1627 "filename": "server/api/automation/index.js",
1628 "groupTitle": "Automations"
1632 "url": "/api/automations/{id}/actions",
1633 "title": "Gets Automation Actions",
1636 "title": "Example usage:",
1637 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1641 "name": "getActions",
1642 "group": "Automations",
1643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1645 "filename": "server/api/automation/index.js",
1646 "groupTitle": "Automations"
1650 "url": "/api/automations/{id}/conditions",
1651 "title": "Gets Automation Conditions",
1654 "title": "Example usage:",
1655 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1659 "name": "getConditions",
1660 "group": "Automations",
1661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1663 "filename": "server/api/automation/index.js",
1664 "groupTitle": "Automations"
1668 "url": "/api/automations/{id}",
1669 "title": "Update an existing Automation",
1672 "title": "Example usage:",
1673 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1677 "name": "updateAutomations",
1678 "group": "Automations",
1679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/canned_answers",
1687 "title": "Create a new canned answer",
1690 "title": "Example usage:",
1691 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1696 "group": "Canned_Answers",
1697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699 "filename": "server/api/cannedAnswer/index.js",
1700 "groupTitle": "Canned_Answers"
1704 "url": "/api/canned_answers/{id}",
1705 "title": "Deletes a Canned Answer",
1708 "title": "Example usage:",
1709 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1713 "name": "DeleteCanned_Answers",
1714 "group": "Canned_Answers",
1715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1717 "filename": "server/api/cannedAnswer/index.js",
1718 "groupTitle": "Canned_Answers"
1722 "url": "/api/canned_answers",
1723 "title": "Gets a list of Canned Answers",
1726 "title": "Example usage:",
1727 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1731 "name": "GetCanned_Answers",
1732 "group": "Canned_Answers",
1733 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1735 "filename": "server/api/cannedAnswer/index.js",
1736 "groupTitle": "Canned_Answers"
1740 "url": "/api/canned_answers/{id}",
1741 "title": "Gets a single Canned Answer",
1744 "title": "Example usage:",
1745 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1749 "name": "ShowCanned_Answers",
1750 "group": "Canned_Answers",
1751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753 "filename": "server/api/cannedAnswer/index.js",
1754 "groupTitle": "Canned_Answers"
1758 "url": "/api/canned_answers/{id}",
1759 "title": "Update an existing Canned Answer",
1762 "title": "Example usage:",
1763 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1767 "name": "updateCanned_Answers",
1768 "group": "Canned_Answers",
1769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771 "filename": "server/api/cannedAnswer/index.js",
1772 "groupTitle": "Canned_Answers"
1776 "url": "/chat/internal/users",
1777 "title": "Gets Users Last Messages",
1780 "title": "Example usage:",
1781 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1785 "name": "getLastUsersMessages",
1786 "group": "ChatInternalMessage",
1787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1789 "filename": "server/api/chatInternalMessage/index.js",
1790 "groupTitle": "ChatInternalMessage"
1794 "url": "/api/chat/applications/{id}",
1795 "title": "Deletes a Application",
1798 "title": "Example usage:",
1799 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1803 "name": "DeleteApplications",
1804 "group": "Chat_Applications",
1805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1807 "filename": "server/api/chatApplication/index.js",
1808 "groupTitle": "Chat_Applications"
1812 "url": "/api/chat/applications/{id}",
1813 "title": "Gets a single Application",
1816 "title": "Example usage:",
1817 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1821 "name": "ShowApplications",
1822 "group": "Chat_Applications",
1823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825 "filename": "server/api/chatApplication/index.js",
1826 "groupTitle": "Chat_Applications"
1830 "url": "/api/chat/applications/{id}",
1831 "title": "Update an existing Application",
1834 "title": "Example usage:",
1835 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1839 "name": "updateApplications",
1840 "group": "Chat_Applications",
1841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843 "filename": "server/api/chatApplication/index.js",
1844 "groupTitle": "Chat_Applications"
1848 "url": "/api/chat/groups",
1849 "title": "Creates a new Group",
1852 "title": "Example usage:",
1853 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1857 "name": "CreateGroups",
1858 "group": "Chat_Groups",
1873 "field": "description",
1886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1888 "filename": "server/api/chatGroup/index.js",
1889 "groupTitle": "Chat_Groups"
1893 "url": "/api/chat/groups/{id}",
1894 "title": "Deletes a Group",
1897 "title": "Example usage:",
1898 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1902 "name": "DeleteGroups",
1903 "group": "Chat_Groups",
1904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1906 "filename": "server/api/chatGroup/index.js",
1907 "groupTitle": "Chat_Groups"
1911 "url": "/api/chat/groups/describe",
1912 "title": "Gets table info about Groups",
1915 "title": "Example usage:",
1916 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1920 "name": "DescribeGroups",
1921 "group": "Chat_Groups",
1922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1924 "filename": "server/api/chatGroup/index.js",
1925 "groupTitle": "Chat_Groups"
1929 "url": "/api/chat/groups",
1930 "title": "Gets a list of Groups",
1933 "title": "Example usage:",
1934 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1938 "name": "GetGroups",
1939 "group": "Chat_Groups",
1940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1942 "filename": "server/api/chatGroup/index.js",
1943 "groupTitle": "Chat_Groups"
1947 "url": "/api/chat/groups/{id}/members",
1948 "title": "Removes members from a group",
1951 "title": "Example usage:",
1952 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1956 "name": "RemoveMembers",
1957 "group": "Chat_Groups",
1958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1960 "filename": "server/api/chatGroup/index.js",
1961 "groupTitle": "Chat_Groups"
1965 "url": "/api/chat/groups/{id}",
1966 "title": "Gets a single Group",
1969 "title": "Example usage:",
1970 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1974 "name": "ShowGroups",
1975 "group": "Chat_Groups",
1976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978 "filename": "server/api/chatGroup/index.js",
1979 "groupTitle": "Chat_Groups"
1983 "url": "/api/chat/groups/{id}/members",
1984 "title": "Add members to chat group",
1987 "title": "Example usage:",
1988 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1992 "name": "addMembers",
1993 "group": "Chat_Groups",
1994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1996 "filename": "server/api/chatGroup/index.js",
1997 "groupTitle": "Chat_Groups"
2001 "url": "/api/chat/groups/{id}/messages",
2002 "title": "Creates a new group message",
2005 "title": "Example usage:",
2006 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2010 "name": "addMessage",
2011 "group": "Chat_Groups",
2012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014 "filename": "server/api/chatGroup/index.js",
2015 "groupTitle": "Chat_Groups"
2019 "url": "/api/chat/groups/{id}/members",
2020 "title": "Gets Members",
2023 "title": "Example usage:",
2024 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2028 "name": "getMembers",
2029 "group": "Chat_Groups",
2030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032 "filename": "server/api/chatGroup/index.js",
2033 "groupTitle": "Chat_Groups"
2037 "url": "/api/chat/groups/{id}/messages",
2038 "title": "Gets Messages",
2041 "title": "Example usage:",
2042 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2046 "name": "getMessages",
2047 "group": "Chat_Groups",
2048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050 "filename": "server/api/chatGroup/index.js",
2051 "groupTitle": "Chat_Groups"
2055 "url": "/api/chat/groups/{id}/unread",
2056 "title": "Get unread chat group messages",
2059 "title": "Example usage:",
2060 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2065 "group": "Chat_Groups",
2066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068 "filename": "server/api/chatGroup/index.js",
2069 "groupTitle": "Chat_Groups"
2073 "url": "/api/chat/groups/{id}",
2074 "title": "Update an existing Group",
2077 "title": "Example usage:",
2078 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2082 "name": "updateGroups",
2083 "group": "Chat_Groups",
2084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086 "filename": "server/api/chatGroup/index.js",
2087 "groupTitle": "Chat_Groups"
2091 "url": "/api/chat/interactions/{id}/tags",
2092 "title": "Add tags to the interaction",
2095 "title": "Example usage:",
2096 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2101 "group": "Chat_Interactions",
2102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104 "filename": "server/api/chatInteraction/index.js",
2105 "groupTitle": "Chat_Interactions"
2109 "url": "/api/chat/interactions",
2110 "title": "Creates a new Interaction",
2113 "title": "Example usage:",
2114 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2118 "name": "CreateInteractions",
2119 "group": "Chat_Interactions",
2134 "field": "ratingValue",
2145 "field": "ratingType",
2152 "field": "ratingMessage",
2159 "field": "pathTranscript",
2166 "field": "mailTranscript",
2173 "field": "closedAt",
2180 "field": "disposition",
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}/close",
2439 "title": "Close Interaction",
2442 "title": "Example usage:",
2443 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2447 "name": "addMessage",
2448 "group": "Chat_Interactions",
2449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2451 "filename": "server/api/chatInteraction/index.js",
2452 "groupTitle": "Chat_Interactions"
2456 "url": "/api/chat/interactions/{id}/messages",
2457 "title": "Creates new messages",
2460 "title": "Example usage:",
2461 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2465 "name": "addMessage",
2466 "group": "Chat_Interactions",
2499 "field": "direction",
2513 "field": "providerName",
2520 "field": "providerResponse",
2526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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",
4388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4390 "filename": "server/api/chatWebsite/index.js",
4391 "groupTitle": "Chat_Websites"
4395 "url": "/api/chat/websites/{id}",
4396 "title": "Deletes a Website",
4399 "title": "Example usage:",
4400 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4404 "name": "DeleteWebsites",
4405 "group": "Chat_Websites",
4406 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4408 "filename": "server/api/chatWebsite/index.js",
4409 "groupTitle": "Chat_Websites"
4413 "url": "/api/chat/websites/describe",
4414 "title": "Gets table info about Websites",
4417 "title": "Example usage:",
4418 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4422 "name": "DescribeWebsites",
4423 "group": "Chat_Websites",
4424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4426 "filename": "server/api/chatWebsite/index.js",
4427 "groupTitle": "Chat_Websites"
4431 "url": "/api/chat/websites/{id}/users",
4432 "title": "Gets agents from website",
4435 "title": "Example usage:",
4436 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4440 "name": "GetAgents",
4441 "group": "Chat_Websites",
4442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4444 "filename": "server/api/chatWebsite/index.js",
4445 "groupTitle": "Chat_Websites"
4449 "url": "/api/chat/websites",
4450 "title": "Gets a list of Websites",
4453 "title": "Example usage:",
4454 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4458 "name": "GetWebsites",
4459 "group": "Chat_Websites",
4460 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4462 "filename": "server/api/chatWebsite/index.js",
4463 "groupTitle": "Chat_Websites"
4467 "url": "/api/chat/websites/{id}/users",
4468 "title": "Removes agents from a website",
4471 "title": "Example usage:",
4472 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4476 "name": "RemoveAgents",
4477 "group": "Chat_Websites",
4478 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4480 "filename": "server/api/chatWebsite/index.js",
4481 "groupTitle": "Chat_Websites"
4485 "url": "/api/chat/websites/{id}/canned_answers",
4486 "title": "Removes canned answers from account",
4489 "title": "Example usage:",
4490 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4494 "name": "RemoveAnswers",
4495 "group": "Chat_Websites",
4496 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4498 "filename": "server/api/chatWebsite/index.js",
4499 "groupTitle": "Chat_Websites"
4503 "url": "/api/chat/websites/{id}/dispositions",
4504 "title": "Removes canned answers from account",
4507 "title": "Example usage:",
4508 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4512 "name": "RemoveDispositions",
4513 "group": "Chat_Websites",
4514 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4516 "filename": "server/api/chatWebsite/index.js",
4517 "groupTitle": "Chat_Websites"
4521 "url": "/api/chat/websites/{id}",
4522 "title": "Gets a single Website",
4525 "title": "Example usage:",
4526 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4530 "name": "ShowWebsites",
4531 "group": "Chat_Websites",
4532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4534 "filename": "server/api/chatWebsite/index.js",
4535 "groupTitle": "Chat_Websites"
4539 "url": "/api/chat/messages/{id}/accept",
4540 "title": "Accepts message",
4543 "title": "Example usage:",
4544 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4548 "name": "acceptMessage",
4549 "group": "Chat_Websites",
4550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4552 "filename": "server/api/chatMessage/index.js",
4553 "groupTitle": "Chat_Websites"
4557 "url": "/api/chat/websites/{id}/canned_answers",
4558 "title": "Creates new canned answer",
4561 "title": "Example usage:",
4562 "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",
4566 "name": "addAnswer",
4567 "group": "Chat_Websites",
4589 "field": "description",
4602 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4604 "filename": "server/api/chatWebsite/index.js",
4605 "groupTitle": "Chat_Websites"
4609 "url": "/api/chat/websites/{id}/applications",
4610 "title": "Creates new applications",
4613 "title": "Example usage:",
4614 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4618 "name": "addApplications",
4619 "group": "Chat_Websites",
4627 "field": "priority",
4648 "field": "description",
4655 "field": "interval",
4661 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4663 "filename": "server/api/chatWebsite/index.js",
4664 "groupTitle": "Chat_Websites"
4668 "url": "/api/chat/websites/{id}/avatar",
4669 "title": "Add avatar",
4672 "title": "Example usage:",
4673 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4677 "name": "addAvatar",
4678 "group": "Chat_Websites",
4679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4681 "filename": "server/api/chatWebsite/index.js",
4682 "groupTitle": "Chat_Websites"
4686 "url": "/api/chat/websites/{id}/customer_avatar",
4687 "title": "Add customer avatar",
4690 "title": "Example usage:",
4691 "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",
4695 "name": "addCustomerAvatar",
4696 "group": "Chat_Websites",
4697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4699 "filename": "server/api/chatWebsite/index.js",
4700 "groupTitle": "Chat_Websites"
4704 "url": "/api/chat/websites/{id}/dispositions",
4705 "title": "Creates new disposition",
4708 "title": "Example usage:",
4709 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4713 "name": "addDisposition",
4714 "group": "Chat_Websites",
4741 "field": "description",
4747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4749 "filename": "server/api/chatWebsite/index.js",
4750 "groupTitle": "Chat_Websites"
4754 "url": "/api/chat/accounts/{id}/interactions",
4755 "title": "Creates new interactions",
4758 "title": "Example usage:",
4759 "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",
4763 "name": "addInteraction",
4764 "group": "Chat_Websites",
4779 "field": "ratingValue",
4790 "field": "ratingType",
4797 "field": "ratingMessage",
4804 "field": "pathTranscript",
4811 "field": "mailTranscript",
4818 "field": "closedAt",
4825 "field": "disposition",
4832 "field": "secondDisposition",
4839 "field": "thirdDisposition",
4853 "field": "browserName",
4860 "field": "browserVersion",
4874 "field": "osVersion",
4881 "field": "deviceModel",
4888 "field": "deviceVendor",
4895 "field": "deviceType",
4909 "field": "customerIp",
4916 "field": "formData",
4923 "field": "read1stAt",
4930 "field": "lastMsgAt",
4941 "field": "lastMsgDirection",
4948 "field": "closeReason",
4955 "field": "customerPort",
4962 "field": "vidaooSessionId",
4968 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4970 "filename": "server/api/chatWebsite/index.js",
4971 "groupTitle": "Chat_Websites"
4975 "url": "/api/chat/websites/{id}/logo",
4976 "title": "Add logo",
4979 "title": "Example usage:",
4980 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4985 "group": "Chat_Websites",
4986 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4988 "filename": "server/api/chatWebsite/index.js",
4989 "groupTitle": "Chat_Websites"
4993 "url": "/api/chat/websites/{id}/proactive_actions",
4994 "title": "Creates new Proactive Actions",
4997 "title": "Example usage:",
4998 "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",
5002 "name": "addProactiveActions",
5003 "group": "Chat_Websites",
5029 "field": "selector",
5042 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5044 "filename": "server/api/chatWebsite/index.js",
5045 "groupTitle": "Chat_Websites"
5049 "url": "/api/chat/websites/{id}/system_avatar",
5050 "title": "Add system avatar",
5053 "title": "Example usage:",
5054 "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",
5058 "name": "addSystemAvatar",
5059 "group": "Chat_Websites",
5060 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5062 "filename": "server/api/chatWebsite/index.js",
5063 "groupTitle": "Chat_Websites"
5067 "url": "/api/chat/websites/{id}/canned_answers",
5068 "title": "Gets account canned answers",
5071 "title": "Example usage:",
5072 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5076 "name": "getAnswers",
5077 "group": "Chat_Websites",
5078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5080 "filename": "server/api/chatWebsite/index.js",
5081 "groupTitle": "Chat_Websites"
5085 "url": "/api/chat/websites/{id}/applications",
5086 "title": "Gets Website Applications",
5089 "title": "Example usage:",
5090 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5094 "name": "getApplications",
5095 "group": "Chat_Websites",
5096 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5098 "filename": "server/api/chatWebsite/index.js",
5099 "groupTitle": "Chat_Websites"
5103 "url": "/api/chat/websites/{id}/avatar",
5104 "title": "Get avatar",
5107 "title": "Example usage:",
5108 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5112 "name": "getAvatar",
5113 "group": "Chat_Websites",
5114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5116 "filename": "server/api/chatWebsite/index.js",
5117 "groupTitle": "Chat_Websites"
5121 "url": "/api/chat/websites/{id}/customer_avatar",
5122 "title": "Get Customer Avatar",
5125 "title": "Example usage:",
5126 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5130 "name": "getCustomerAvatar",
5131 "group": "Chat_Websites",
5132 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5134 "filename": "server/api/chatWebsite/index.js",
5135 "groupTitle": "Chat_Websites"
5139 "url": "/api/chat/websites/{id}/dispositions",
5140 "title": "Gets account dispositions",
5143 "title": "Example usage:",
5144 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5148 "name": "getDispositions",
5149 "group": "Chat_Websites",
5150 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5152 "filename": "server/api/chatWebsite/index.js",
5153 "groupTitle": "Chat_Websites"
5157 "url": "/api/chat/websites/{id}/fields",
5158 "title": "Gets Website Fields",
5161 "title": "Example usage:",
5162 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5166 "name": "getFields",
5167 "group": "Chat_Websites",
5168 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5170 "filename": "server/api/chatWebsite/index.js",
5171 "groupTitle": "Chat_Websites"
5175 "url": "/api/chat/websites/{id}/interactions",
5176 "title": "Gets Website Interactions",
5179 "title": "Example usage:",
5180 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5184 "name": "getInteraction",
5185 "group": "Chat_Websites",
5186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5188 "filename": "server/api/chatWebsite/index.js",
5189 "groupTitle": "Chat_Websites"
5193 "url": "/api/chat/websites/{id}/logo",
5194 "title": "Get logo",
5197 "title": "Example usage:",
5198 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5203 "group": "Chat_Websites",
5204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5206 "filename": "server/api/chatWebsite/index.js",
5207 "groupTitle": "Chat_Websites"
5211 "url": "/api/chat/websites/{id}/offline_messages",
5212 "title": "Gets Website Offline Messages",
5215 "title": "Example usage:",
5216 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5220 "name": "getOfflineMessages",
5221 "group": "Chat_Websites",
5222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5224 "filename": "server/api/chatWebsite/index.js",
5225 "groupTitle": "Chat_Websites"
5229 "url": "/api/chat/websites/{id}/proactive_actions",
5230 "title": "Gets Website Proactive Actions",
5233 "title": "Example usage:",
5234 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5238 "name": "getProactiveActions",
5239 "group": "Chat_Websites",
5240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5242 "filename": "server/api/chatWebsite/index.js",
5243 "groupTitle": "Chat_Websites"
5247 "url": "/api/chat/websites/{id}/snippet",
5248 "title": "Gets Website Snippet",
5251 "title": "Example usage:",
5252 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5256 "name": "getSnippet",
5257 "group": "Chat_Websites",
5258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5260 "filename": "server/api/chatWebsite/index.js",
5261 "groupTitle": "Chat_Websites"
5265 "url": "/api/chat/websites/{id}/system_avatar",
5266 "title": "Get System Avatar",
5269 "title": "Example usage:",
5270 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5274 "name": "getSystemAvatar",
5275 "group": "Chat_Websites",
5276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5278 "filename": "server/api/chatWebsite/index.js",
5279 "groupTitle": "Chat_Websites"
5283 "url": "/api/chat/websites/{id}/notify",
5284 "title": "Notify new message",
5287 "title": "Example usage:",
5288 "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",
5293 "group": "Chat_Websites",
5294 "description": "<p>Motion 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>",
5296 "filename": "server/api/chatWebsite/index.js",
5297 "groupTitle": "Chat_Websites"
5301 "url": "/api/chat/websites/{id}/offline",
5302 "title": "Offline message",
5305 "title": "Example usage:",
5306 "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",
5311 "group": "Chat_Websites",
5312 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5314 "filename": "server/api/chatWebsite/index.js",
5315 "groupTitle": "Chat_Websites"
5319 "url": "/api/chat/messages/{id}/reject",
5320 "title": "Rejects message",
5323 "title": "Example usage:",
5324 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5328 "name": "rejectMessage",
5329 "group": "Chat_Websites",
5330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5332 "filename": "server/api/chatMessage/index.js",
5333 "groupTitle": "Chat_Websites"
5337 "url": "/api/chat/websites/{id}",
5338 "title": "Update an existing Website",
5341 "title": "Example usage:",
5342 "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",
5346 "name": "updateWebsites",
5347 "group": "Chat_Websites",
5348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5350 "filename": "server/api/chatWebsite/index.js",
5351 "groupTitle": "Chat_Websites"
5355 "url": "/api/cloudProviders",
5356 "title": "Creates a new CloudProvider",
5359 "title": "Example usage:",
5360 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5364 "name": "CreateCloudProviders",
5365 "group": "CloudProviders",
5404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5406 "filename": "server/api/cloudProvider/index.js",
5407 "groupTitle": "CloudProviders"
5411 "url": "/api/cloudProviders/{id}",
5412 "title": "Deletes a CloudProvider",
5415 "title": "Example usage:",
5416 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5420 "name": "DeleteCloudProviders",
5421 "group": "CloudProviders",
5422 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5424 "filename": "server/api/cloudProvider/index.js",
5425 "groupTitle": "CloudProviders"
5429 "url": "/api/cloudProviders",
5430 "title": "Gets a list of CloudProviders",
5433 "title": "Example usage:",
5434 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5438 "name": "GetCloudProviders",
5439 "group": "CloudProviders",
5440 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5442 "filename": "server/api/cloudProvider/index.js",
5443 "groupTitle": "CloudProviders"
5447 "url": "/api/cloudProviders/{id}",
5448 "title": "Gets a single CloudProvider",
5451 "title": "Example usage:",
5452 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5456 "name": "ShowCloudProviders",
5457 "group": "CloudProviders",
5458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5460 "filename": "server/api/cloudProvider/index.js",
5461 "groupTitle": "CloudProviders"
5465 "url": "/api/cloudProviders/{id}",
5466 "title": "Update an existing CloudProvider",
5469 "title": "Example usage:",
5470 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5474 "name": "updateCloudProviders",
5475 "group": "CloudProviders",
5476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5478 "filename": "server/api/cloudProvider/index.js",
5479 "groupTitle": "CloudProviders"
5483 "url": "/api/cm/companies",
5484 "title": "Creates a new Company",
5487 "title": "Example usage:",
5488 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5492 "name": "CreateCompanies",
5493 "group": "Cm_Companies",
5515 "field": "companyId",
5557 "field": "postalCode",
5585 "field": "emailDomain",
5599 "field": "sPostalCode",
5613 "field": "sCountry",
5620 "field": "description",
5626 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5628 "filename": "server/api/cmCompany/index.js",
5629 "groupTitle": "Cm_Companies"
5633 "url": "/api/cm/companies/{id}",
5634 "title": "Deletes a Company",
5637 "title": "Example usage:",
5638 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5642 "name": "DeleteCompanies",
5643 "group": "Cm_Companies",
5644 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5646 "filename": "server/api/cmCompany/index.js",
5647 "groupTitle": "Cm_Companies"
5651 "url": "/api/cm/companies/describe",
5652 "title": "Gets table info about Companies",
5655 "title": "Example usage:",
5656 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5660 "name": "DescribeCompanies",
5661 "group": "Cm_Companies",
5662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5664 "filename": "server/api/cmCompany/index.js",
5665 "groupTitle": "Cm_Companies"
5669 "url": "/api/cm/companies",
5670 "title": "Gets a list of Companies",
5673 "title": "Example usage:",
5674 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5678 "name": "GetCompanies",
5679 "group": "Cm_Companies",
5680 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5682 "filename": "server/api/cmCompany/index.js",
5683 "groupTitle": "Cm_Companies"
5687 "url": "/api/cm/companies/{id}",
5688 "title": "Gets a single Company",
5691 "title": "Example usage:",
5692 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5696 "name": "ShowCompanies",
5697 "group": "Cm_Companies",
5698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5700 "filename": "server/api/cmCompany/index.js",
5701 "groupTitle": "Cm_Companies"
5705 "url": "/api/cm/companies/{id}/contacts",
5706 "title": "Creates new contacts",
5709 "title": "Example usage:",
5710 "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",
5714 "name": "addContacts",
5715 "group": "Cm_Companies",
5723 "field": "firstName",
5730 "field": "lastName",
5744 "field": "postalCode",
5765 "field": "dateOfBirth",
5772 "field": "description",
5814 "field": "facebook",
5870 "field": "telegram",
5884 "field": "priority",
5891 "field": "scheduledat",
5897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5899 "filename": "server/api/cmCompany/index.js",
5900 "groupTitle": "Cm_Companies"
5904 "url": "/api/cm/companies/{id}/contacts",
5905 "title": "Gets List Contacts",
5908 "title": "Example usage:",
5909 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5913 "name": "getContacts",
5914 "group": "Cm_Companies",
5915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5917 "filename": "server/api/cmCompany/index.js",
5918 "groupTitle": "Cm_Companies"
5922 "url": "/api/cm/companies/{id}",
5923 "title": "Update an existing Company",
5926 "title": "Example usage:",
5927 "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",
5931 "name": "updateCompanies",
5932 "group": "Cm_Companies",
5933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5935 "filename": "server/api/cmCompany/index.js",
5936 "groupTitle": "Cm_Companies"
5940 "url": "/api/cm/contacts/{id}",
5941 "title": "Deletes a Contact",
5944 "title": "Example usage:",
5945 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5949 "name": "DeleteContacts",
5950 "group": "Cm_Contacts",
5951 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5953 "filename": "server/api/cmContact/index.js",
5954 "groupTitle": "Cm_Contacts"
5958 "url": "/api/cm/contacts/describe",
5959 "title": "Gets table info about Contacts",
5962 "title": "Example usage:",
5963 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5967 "name": "DescribeContacts",
5968 "group": "Cm_Contacts",
5969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5971 "filename": "server/api/cmContact/index.js",
5972 "groupTitle": "Cm_Contacts"
5976 "url": "/api/cm/contacts",
5977 "title": "Gets a list of Contacts",
5980 "title": "Example usage:",
5981 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5985 "name": "GetContacts",
5986 "group": "Cm_Contacts",
5987 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5989 "filename": "server/api/cmContact/index.js",
5990 "groupTitle": "Cm_Contacts"
5994 "url": "/api/cm/contacts/{id}/finals",
5995 "title": "Gets contact hopper finals",
5998 "title": "Example usage:",
5999 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6003 "name": "GetHopperFinals",
6004 "group": "Cm_Contacts",
6005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6007 "filename": "server/api/cmContact/index.js",
6008 "groupTitle": "Cm_Contacts"
6012 "url": "/api/cm/contacts/{id}/hopper_histories",
6013 "title": "Gets contact hopper histories",
6016 "title": "Example usage:",
6017 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6021 "name": "GetHopperHistories",
6022 "group": "Cm_Contacts",
6023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6025 "filename": "server/api/cmContact/index.js",
6026 "groupTitle": "Cm_Contacts"
6030 "url": "/api/cm/contacts/{id}/hoppers",
6031 "title": "Gets contact hoppers",
6034 "title": "Example usage:",
6035 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6039 "name": "GetHoppers",
6040 "group": "Cm_Contacts",
6041 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6043 "filename": "server/api/cmContact/index.js",
6044 "groupTitle": "Cm_Contacts"
6048 "url": "/api/cm/contacts/create_many",
6049 "title": "Create Contacts",
6052 "title": "Example usage:",
6053 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6057 "name": "bulkCreate",
6058 "group": "Cm_Contacts",
6059 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6061 "filename": "server/api/cmContact/index.js",
6062 "groupTitle": "Cm_Contacts"
6066 "url": "/api/cm/contacts",
6067 "title": "Create Contact",
6070 "title": "Example usage:",
6071 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6076 "group": "Cm_Contacts",
6077 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6079 "filename": "server/api/cmContact/index.js",
6080 "groupTitle": "Cm_Contacts"
6084 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6085 "title": "Gets contact hopper blacks",
6088 "title": "Example usage:",
6089 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6093 "name": "getJscriptySessions",
6094 "group": "Cm_Contacts",
6095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6097 "filename": "server/api/cmContact/index.js",
6098 "groupTitle": "Cm_Contacts"
6102 "url": "/api/cm/contacts/{id}/tags",
6103 "title": "Gets configurations tags",
6106 "title": "Example usage:",
6107 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6112 "group": "Cm_Contacts",
6113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6115 "filename": "server/api/cmContact/index.js",
6116 "groupTitle": "Cm_Contacts"
6120 "url": "/api/cm/contacts/merge",
6121 "title": "Merge Contact",
6124 "title": "Example usage:",
6125 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6130 "group": "Cm_Contacts",
6131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6133 "filename": "server/api/cmContact/index.js",
6134 "groupTitle": "Cm_Contacts"
6138 "url": "/api/cm/contacts/{id}/tags",
6139 "title": "Sets new tags",
6142 "title": "Example usage:",
6143 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6148 "group": "Cm_Contacts",
6149 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6151 "filename": "server/api/cmContact/index.js",
6152 "groupTitle": "Cm_Contacts"
6156 "url": "/api/cm/contacts/{id}",
6157 "title": "Gets a single Contact",
6160 "title": "Example usage:",
6161 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6166 "group": "Cm_Contacts",
6167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6169 "filename": "server/api/cmContact/index.js",
6170 "groupTitle": "Cm_Contacts"
6174 "url": "/api/cm/contacts/{id}",
6175 "title": "Update a single Contact",
6178 "title": "Example usage:",
6179 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6184 "group": "Cm_Contacts",
6185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6187 "filename": "server/api/cmContact/index.js",
6188 "groupTitle": "Cm_Contacts"
6192 "url": "/api/cm/custom_fields/{id}",
6193 "title": "Deletes a Custom Field",
6196 "title": "Example usage:",
6197 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6201 "name": "DeleteCustom_Fields",
6202 "group": "Cm_Custom_Fields",
6203 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6205 "filename": "server/api/cmCustomField/index.js",
6206 "groupTitle": "Cm_Custom_Fields"
6210 "url": "/api/cm/custom_fields",
6211 "title": "Gets a list of Custom Fields",
6214 "title": "Example usage:",
6215 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6219 "name": "GetCustom_Fields",
6220 "group": "Cm_Custom_Fields",
6221 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6223 "filename": "server/api/cmCustomField/index.js",
6224 "groupTitle": "Cm_Custom_Fields"
6228 "url": "/api/cm/custom_fields/{id}",
6229 "title": "Gets a single Custom Field",
6232 "title": "Example usage:",
6233 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6237 "name": "ShowCustom_Fields",
6238 "group": "Cm_Custom_Fields",
6239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6241 "filename": "server/api/cmCustomField/index.js",
6242 "groupTitle": "Cm_Custom_Fields"
6246 "url": "/api/cm/custom_fields/{id}",
6247 "title": "Update an existing Custom Field",
6250 "title": "Example usage:",
6251 "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",
6255 "name": "updateCustom_Fields",
6256 "group": "Cm_Custom_Fields",
6257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6259 "filename": "server/api/cmCustomField/index.js",
6260 "groupTitle": "Cm_Custom_Fields"
6264 "url": "/api/cm/hopper",
6265 "title": "Creates a new Hopper",
6268 "title": "Example usage:",
6269 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6273 "name": "CreateHopper",
6274 "group": "Cm_Hopper",
6296 "field": "scheduledat",
6303 "field": "countbusyretry",
6310 "field": "countcongestionretry",
6317 "field": "countnoanswerretry",
6324 "field": "callback",
6331 "field": "callbackuniqueid",
6338 "field": "callbackat",
6345 "field": "priority",
6352 "field": "recallme",
6359 "field": "ContactId",
6380 "field": "VoiceQueueId",
6387 "field": "CampaignId",
6394 "field": "countnosuchnumberretry",
6401 "field": "countdropretry",
6408 "field": "countabandonedretry",
6415 "field": "countmachineretry",
6422 "field": "countagentrejectretry",
6428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6430 "filename": "server/api/cmHopper/index.js",
6431 "groupTitle": "Cm_Hopper"
6435 "url": "/api/cm/hopper/describe",
6436 "title": "Gets table info about Hopper",
6439 "title": "Example usage:",
6440 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6444 "name": "DescribeHopper",
6445 "group": "Cm_Hopper",
6446 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6448 "filename": "server/api/cmHopper/index.js",
6449 "groupTitle": "Cm_Hopper"
6453 "url": "/api/cm/hopper",
6454 "title": "Gets a list of Hopper",
6457 "title": "Example usage:",
6458 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6462 "name": "GetHopper",
6463 "group": "Cm_Hopper",
6464 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6466 "filename": "server/api/cmHopper/index.js",
6467 "groupTitle": "Cm_Hopper"
6471 "url": "/api/cm/hopper/{id}",
6472 "title": "Gets a single Hopper",
6475 "title": "Example usage:",
6476 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6480 "name": "ShowHopper",
6481 "group": "Cm_Hopper",
6482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6484 "filename": "server/api/cmHopper/index.js",
6485 "groupTitle": "Cm_Hopper"
6489 "url": "/api/cm/hopper_black/{id}",
6490 "title": "Deletes a Hopper Black",
6493 "title": "Example usage:",
6494 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6498 "name": "DeleteHopper_Black",
6499 "group": "Cm_Hopper_Black",
6500 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6502 "filename": "server/api/cmHopperBlack/index.js",
6503 "groupTitle": "Cm_Hopper_Black"
6507 "url": "/api/cm/hopper_black/describe",
6508 "title": "Gets table info about Hopper Black",
6511 "title": "Example usage:",
6512 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6516 "name": "DescribeHopper_Black",
6517 "group": "Cm_Hopper_Black",
6518 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6520 "filename": "server/api/cmHopperBlack/index.js",
6521 "groupTitle": "Cm_Hopper_Black"
6525 "url": "/api/cm/hopper_black",
6526 "title": "Gets a list of Hopper Black",
6529 "title": "Example usage:",
6530 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6534 "name": "GetHopper_Black",
6535 "group": "Cm_Hopper_Black",
6536 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6538 "filename": "server/api/cmHopperBlack/index.js",
6539 "groupTitle": "Cm_Hopper_Black"
6543 "url": "/api/cm/hopper_black/{id}",
6544 "title": "Gets a single Hopper Black",
6547 "title": "Example usage:",
6548 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6552 "name": "ShowHopper_Black",
6553 "group": "Cm_Hopper_Black",
6554 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6556 "filename": "server/api/cmHopperBlack/index.js",
6557 "groupTitle": "Cm_Hopper_Black"
6561 "url": "/api/cm/hopper_black/{id}",
6562 "title": "Update an existing Hopper Black",
6565 "title": "Example usage:",
6566 "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",
6570 "name": "updateHopper_Black",
6571 "group": "Cm_Hopper_Black",
6572 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6574 "filename": "server/api/cmHopperBlack/index.js",
6575 "groupTitle": "Cm_Hopper_Black"
6579 "url": "/api/cm/hopper_final/checkContactHopper",
6580 "title": "Check if contact is in hopper",
6583 "title": "Example usage:",
6584 "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",
6588 "name": "/checkContactHopper",
6589 "group": "Cm_Hopper_Final",
6590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6592 "filename": "server/api/cmHopperFinal/index.js",
6593 "groupTitle": "Cm_Hopper_Final"
6597 "url": "/api/cm/hopper_final/describe",
6598 "title": "Gets table info about HopperFinal",
6601 "title": "Example usage:",
6602 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6606 "name": "DescribeHopperFinal",
6607 "group": "Cm_Hopper_Final",
6608 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6610 "filename": "server/api/cmHopperFinal/index.js",
6611 "groupTitle": "Cm_Hopper_Final"
6615 "url": "/api/cm/hopper_final",
6616 "title": "Gets a list of HopperFinal",
6619 "title": "Example usage:",
6620 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6624 "name": "GetHopperFinal",
6625 "group": "Cm_Hopper_Final",
6626 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6628 "filename": "server/api/cmHopperFinal/index.js",
6629 "groupTitle": "Cm_Hopper_Final"
6633 "url": "/api/cm/hopper_final/{id}",
6634 "title": "Gets a single HopperFinal",
6637 "title": "Example usage:",
6638 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6642 "name": "ShowHopperFinal",
6643 "group": "Cm_Hopper_Final",
6644 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6646 "filename": "server/api/cmHopperFinal/index.js",
6647 "groupTitle": "Cm_Hopper_Final"
6651 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6652 "title": "Return number contacts for attributes",
6655 "title": "Example usage:",
6656 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6660 "name": "countContactsIvrCampaignHopperFinal",
6661 "group": "Cm_Hopper_Final",
6662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6664 "filename": "server/api/cmHopperFinal/index.js",
6665 "groupTitle": "Cm_Hopper_Final"
6669 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6670 "title": "Return number contacts for attributes",
6673 "title": "Example usage:",
6674 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6678 "name": "countContactsQueueCampaignHopperFinal",
6679 "group": "Cm_Hopper_Final",
6680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6682 "filename": "server/api/cmHopperFinal/index.js",
6683 "groupTitle": "Cm_Hopper_Final"
6687 "url": "/api/cm/hopper_final/campaign/{id}",
6688 "title": "Move contacts in hopper",
6691 "title": "Example usage:",
6692 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6696 "name": "moveContactsIvrCampaignHopperFinal",
6697 "group": "Cm_Hopper_Final",
6698 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6700 "filename": "server/api/cmHopperFinal/index.js",
6701 "groupTitle": "Cm_Hopper_Final"
6705 "url": "/api/cm/hopper_final/voice/queue/{id}",
6706 "title": "Move contacts in hopper",
6709 "title": "Example usage:",
6710 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6714 "name": "moveContactsQueueCampaignHopperFinal",
6715 "group": "Cm_Hopper_Final",
6716 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6718 "filename": "server/api/cmHopperFinal/index.js",
6719 "groupTitle": "Cm_Hopper_Final"
6723 "url": "/api/cm/hopper_final/{id}",
6724 "title": "Update a single hopper final",
6727 "title": "Example usage:",
6728 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6733 "group": "Cm_Hopper_Final",
6734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6736 "filename": "server/api/cmHopperFinal/index.js",
6737 "groupTitle": "Cm_Hopper_Final"
6741 "url": "/api/cm/hopper_history",
6742 "title": "Creates a new HopperHistory",
6745 "title": "Example usage:",
6746 "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",
6750 "name": "CreateHopperHistory",
6751 "group": "Cm_Hopper_History",
6766 "field": "statedesc",
6773 "field": "scheduledat",
6780 "field": "countbusyretry",
6787 "field": "countcongestionretry",
6794 "field": "countnoanswerretry",
6801 "field": "countglobal",
6808 "field": "uniqueid",
6815 "field": "originatecalleridnum",
6822 "field": "originatecalleridname",
6829 "field": "calleridnum",
6836 "field": "calleridname",
6843 "field": "starttime",
6850 "field": "responsetime",
6857 "field": "answertime",
6864 "field": "droptime",
6878 "field": "ringtime",
6885 "field": "holdtime",
6892 "field": "talktime",
6899 "field": "followuptime",
6906 "field": "dropreason",
6913 "field": "campaign",
6920 "field": "campaigntype",
6927 "field": "membername",
6955 "field": "callback",
6962 "field": "callbackuniqueid",
6969 "field": "callbackat",
6976 "field": "recallme",
6983 "field": "editedat",
6997 "field": "countnosuchnumberretry",
7004 "field": "countdropretry",
7011 "field": "countabandonedretry",
7018 "field": "countmachineretry",
7025 "field": "countagentrejectretry",
7031 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7033 "filename": "server/api/cmHopperHistory/index.js",
7034 "groupTitle": "Cm_Hopper_History"
7038 "url": "/api/cm/hopper_history/describe",
7039 "title": "Gets table info about HopperHistory",
7042 "title": "Example usage:",
7043 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7047 "name": "DescribeHopperHistory",
7048 "group": "Cm_Hopper_History",
7049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7051 "filename": "server/api/cmHopperHistory/index.js",
7052 "groupTitle": "Cm_Hopper_History"
7056 "url": "/api/cm/hopper_history",
7057 "title": "Gets a list of HopperHistory",
7060 "title": "Example usage:",
7061 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7065 "name": "GetHopperHistory",
7066 "group": "Cm_Hopper_History",
7067 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7069 "filename": "server/api/cmHopperHistory/index.js",
7070 "groupTitle": "Cm_Hopper_History"
7074 "url": "/api/cm/hopper_history/{id}",
7075 "title": "Gets a single HopperHistory",
7078 "title": "Example usage:",
7079 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7083 "name": "ShowHopperHistory",
7084 "group": "Cm_Hopper_History",
7085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7087 "filename": "server/api/cmHopperHistory/index.js",
7088 "groupTitle": "Cm_Hopper_History"
7092 "url": "/api/cm/hopper_history/{id}",
7093 "title": "Update a single hopper history",
7096 "title": "Example usage:",
7097 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7102 "group": "Cm_Hopper_History",
7103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7105 "filename": "server/api/cmHopperHistory/index.js",
7106 "groupTitle": "Cm_Hopper_History"
7110 "url": "/api/cm/hopper/{id}",
7111 "title": "Delete Hopper",
7114 "title": "Example usage:",
7115 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7120 "group": "Cm_Hopper",
7121 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7123 "filename": "server/api/cmHopper/index.js",
7124 "groupTitle": "Cm_Hopper"
7128 "url": "/api/cm/hopper/opencontacts",
7129 "title": "Gets Open Contacts",
7132 "title": "Example usage:",
7133 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7137 "name": "getOpenContacts",
7138 "group": "Cm_Hopper",
7139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7141 "filename": "server/api/cmHopper/index.js",
7142 "groupTitle": "Cm_Hopper"
7146 "url": "/api/cm/hopper/preview",
7147 "title": "Gets Preview Dialer Contacts",
7150 "title": "Example usage:",
7151 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7155 "name": "getPreview",
7156 "group": "Cm_Hopper",
7157 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7159 "filename": "server/api/cmHopper/index.js",
7160 "groupTitle": "Cm_Hopper"
7164 "url": "/api/cm/hopper/{id}",
7165 "title": "Update an existing Hopper",
7168 "title": "Example usage:",
7169 "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",
7173 "name": "updateHopper",
7174 "group": "Cm_Hopper",
7175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7177 "filename": "server/api/cmHopper/index.js",
7178 "groupTitle": "Cm_Hopper"
7182 "url": "/api/cm/lists",
7183 "title": "Creates a new List",
7186 "title": "Example usage:",
7187 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7191 "name": "CreateLists",
7192 "group": "Cm_Lists",
7207 "field": "description",
7214 "field": "dialPrefix",
7220 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7222 "filename": "server/api/cmList/index.js",
7223 "groupTitle": "Cm_Lists"
7227 "url": "/api/cm/lists/{id}",
7228 "title": "Deletes a List",
7231 "title": "Example usage:",
7232 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7236 "name": "DeleteLists",
7237 "group": "Cm_Lists",
7238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7240 "filename": "server/api/cmList/index.js",
7241 "groupTitle": "Cm_Lists"
7245 "url": "/api/cm/lists/describe",
7246 "title": "Gets table info about Lists",
7249 "title": "Example usage:",
7250 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7254 "name": "DescribeLists",
7255 "group": "Cm_Lists",
7256 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7258 "filename": "server/api/cmList/index.js",
7259 "groupTitle": "Cm_Lists"
7263 "url": "/api/cm/lists/{id}/users",
7264 "title": "Gets agents from list",
7267 "title": "Example usage:",
7268 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7272 "name": "GetAgents",
7273 "group": "Cm_Lists",
7274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7276 "filename": "server/api/cmList/index.js",
7277 "groupTitle": "Cm_Lists"
7281 "url": "/api/cm/lists",
7282 "title": "Gets a list of Lists",
7285 "title": "Example usage:",
7286 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7291 "group": "Cm_Lists",
7292 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7294 "filename": "server/api/cmList/index.js",
7295 "groupTitle": "Cm_Lists"
7299 "url": "/api/cm/lists/{id}/users",
7300 "title": "Removes agents from a list",
7303 "title": "Example usage:",
7304 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7308 "name": "RemoveAgents",
7309 "group": "Cm_Lists",
7310 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7312 "filename": "server/api/cmList/index.js",
7313 "groupTitle": "Cm_Lists"
7317 "url": "/api/cm/lists/{id}/dispositions",
7318 "title": "Removes dispositions from account",
7321 "title": "Example usage:",
7322 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7326 "name": "RemoveDispositions",
7327 "group": "Cm_Lists",
7328 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7330 "filename": "server/api/cmList/index.js",
7331 "groupTitle": "Cm_Lists"
7335 "url": "/api/cm/lists/{id}",
7336 "title": "Gets a single List",
7339 "title": "Example usage:",
7340 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7344 "name": "ShowLists",
7345 "group": "Cm_Lists",
7346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7348 "filename": "server/api/cmList/index.js",
7349 "groupTitle": "Cm_Lists"
7353 "url": "/api/cm/lists/{id}/users",
7354 "title": "Adds agents to a list",
7357 "title": "Example usage:",
7358 "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",
7362 "name": "addAgents",
7363 "group": "Cm_Lists",
7364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7366 "filename": "server/api/cmList/index.js",
7367 "groupTitle": "Cm_Lists"
7371 "url": "/api/cm/lists/{id}/contacts",
7372 "title": "Creates new contacts",
7375 "title": "Example usage:",
7376 "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",
7380 "name": "addContacts",
7381 "group": "Cm_Lists",
7389 "field": "firstName",
7396 "field": "lastName",
7410 "field": "postalCode",
7431 "field": "dateOfBirth",
7438 "field": "description",
7480 "field": "facebook",
7536 "field": "telegram",
7550 "field": "priority",
7557 "field": "scheduledat",
7563 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7565 "filename": "server/api/cmList/index.js",
7566 "groupTitle": "Cm_Lists"
7570 "url": "/api/cm/lists/{id}/fields",
7571 "title": "Creates a new custom field",
7574 "title": "Example usage:",
7575 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7579 "name": "addCustomField",
7580 "group": "Cm_Lists",
7581 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7583 "filename": "server/api/cmList/index.js",
7584 "groupTitle": "Cm_Lists"
7588 "url": "/api/cm/lists/{id}/dispositions",
7589 "title": "Creates new disposition",
7592 "title": "Example usage:",
7593 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7597 "name": "addDisposition",
7598 "group": "Cm_Lists",
7625 "field": "description",
7631 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7633 "filename": "server/api/cmList/index.js",
7634 "groupTitle": "Cm_Lists"
7638 "url": "/api/cm/lists/{id}/contacts",
7639 "title": "Gets List Contacts",
7642 "title": "Example usage:",
7643 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7647 "name": "getContacts",
7648 "group": "Cm_Lists",
7649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7651 "filename": "server/api/cmList/index.js",
7652 "groupTitle": "Cm_Lists"
7656 "url": "/api/cm/lists/{id}/fields",
7657 "title": "Gets Custom Fields",
7660 "title": "Example usage:",
7661 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7665 "name": "getCustomFields",
7666 "group": "Cm_Lists",
7667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7669 "filename": "server/api/cmList/index.js",
7670 "groupTitle": "Cm_Lists"
7674 "url": "/api/cm/lists/{id}/dispositions",
7675 "title": "Gets list dispositions",
7678 "title": "Example usage:",
7679 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7683 "name": "getDispositions",
7684 "group": "Cm_Lists",
7685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7687 "filename": "server/api/cmList/index.js",
7688 "groupTitle": "Cm_Lists"
7692 "url": "/api/cm/lists/{id}/contacts/csv",
7693 "title": "Gets CSV List Contacts",
7696 "title": "Example usage:",
7697 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7702 "group": "Cm_Lists",
7703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7705 "filename": "server/api/cmList/index.js",
7706 "groupTitle": "Cm_Lists"
7710 "url": "/api/cm/lists/{id}",
7711 "title": "Update an existing List",
7714 "title": "Example usage:",
7715 "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",
7719 "name": "updateLists",
7720 "group": "Cm_Lists",
7721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7723 "filename": "server/api/cmList/index.js",
7724 "groupTitle": "Cm_Lists"
7728 "url": "/api/cm/contacts/upload/:id",
7729 "title": "Import new contacts by csv",
7732 "title": "Example usage:",
7733 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7738 "group": "Cm_contacts",
7739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7741 "filename": "server/api/cmContact/index.js",
7742 "groupTitle": "Cm_contacts"
7746 "url": "/api/cm/contacts/upload",
7747 "title": "Upload csv",
7750 "title": "Example usage:",
7751 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7756 "group": "Cm_contacts",
7757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7759 "filename": "server/api/cmContact/index.js",
7760 "groupTitle": "Cm_contacts"
7764 "url": "/api/cm/contacts/csv",
7765 "title": "Create new contacts by csv",
7768 "title": "Example usage:",
7769 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7773 "name": "uploadCsv",
7774 "group": "Cm_contacts",
7775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7777 "filename": "server/api/cmContact/index.js",
7778 "groupTitle": "Cm_contacts"
7782 "url": "/api/conditions/{id}",
7783 "title": "Deletes a Condition",
7786 "title": "Example usage:",
7787 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7791 "name": "DeleteConditions",
7792 "group": "Conditions",
7793 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7795 "filename": "server/api/condition/index.js",
7796 "groupTitle": "Conditions"
7800 "url": "/api/conditions/{id}",
7801 "title": "Update an existing Condition",
7804 "title": "Example usage:",
7805 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7809 "name": "updateConditions",
7810 "group": "Conditions",
7811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7813 "filename": "server/api/condition/index.js",
7814 "groupTitle": "Conditions"
7818 "url": "/api/cm/custom_field",
7819 "title": "Create a new custom field",
7822 "title": "Example usage:",
7823 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7827 "name": "CreateCustomField",
7828 "group": "Custom_Fields",
7829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7831 "filename": "server/api/cmCustomField/index.js",
7832 "groupTitle": "Custom_Fields"
7836 "url": "/api/dashboards/items",
7837 "title": "Create dasboard item",
7840 "title": "Example usage:",
7841 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7846 "group": "Dashboard_Items",
7847 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7849 "filename": "server/api/dashboardItem/index.js",
7850 "groupTitle": "Dashboard_Items"
7854 "url": "/api/dashboards/items/{id}",
7855 "title": "Deletes a Dashboard Item",
7858 "title": "Example usage:",
7859 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7863 "name": "DeleteDashboard_Items",
7864 "group": "Dashboard_Items",
7865 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7867 "filename": "server/api/dashboardItem/index.js",
7868 "groupTitle": "Dashboard_Items"
7872 "url": "/api/dashboards/items/{id}",
7873 "title": "Gets a single Dashboard Item",
7876 "title": "Example usage:",
7877 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7881 "name": "ShowDashboard_Items",
7882 "group": "Dashboard_Items",
7883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7885 "filename": "server/api/dashboardItem/index.js",
7886 "groupTitle": "Dashboard_Items"
7890 "url": "/api/dashboards/items/{id}",
7891 "title": "Update an existing item",
7894 "title": "Example usage:",
7895 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7900 "group": "Dashboard_Items",
7901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7903 "filename": "server/api/dashboardItem/index.js",
7904 "groupTitle": "Dashboard_Items"
7908 "url": "/api/dashboards/clone",
7909 "title": "Clone an existing Dashboard",
7912 "title": "Example usage:",
7913 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7917 "name": "CloneDashboards",
7918 "group": "Dashboards",
7919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7921 "filename": "server/api/dashboard/index.js",
7922 "groupTitle": "Dashboards"
7926 "url": "/api/dashboards",
7927 "title": "Creates a new Dashboard",
7930 "title": "Example usage:",
7931 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7935 "name": "CreateDashboards",
7936 "group": "Dashboards",
7951 "field": "description",
7957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7959 "filename": "server/api/dashboard/index.js",
7960 "groupTitle": "Dashboards"
7964 "url": "/api/dashboards/{id}",
7965 "title": "Deletes a Dashboard",
7968 "title": "Example usage:",
7969 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7973 "name": "DeleteDashboards",
7974 "group": "Dashboards",
7975 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7977 "filename": "server/api/dashboard/index.js",
7978 "groupTitle": "Dashboards"
7982 "url": "/api/dashboards",
7983 "title": "Gets a list of Dashboards",
7986 "title": "Example usage:",
7987 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7991 "name": "GetDashboards",
7992 "group": "Dashboards",
7993 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7995 "filename": "server/api/dashboard/index.js",
7996 "groupTitle": "Dashboards"
8000 "url": "/api/dashboards/{id}",
8001 "title": "Gets a single Dashboard",
8004 "title": "Example usage:",
8005 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8009 "name": "ShowDashboards",
8010 "group": "Dashboards",
8011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8013 "filename": "server/api/dashboard/index.js",
8014 "groupTitle": "Dashboards"
8018 "url": "/api/dashboards/{id}/items",
8019 "title": "Creates new item",
8022 "title": "Example usage:",
8023 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8028 "group": "Dashboards",
8029 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8031 "filename": "server/api/dashboard/index.js",
8032 "groupTitle": "Dashboards"
8036 "url": "/api/dashboards/{id}/items",
8037 "title": "Gets items",
8040 "title": "Example usage:",
8041 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8046 "group": "Dashboards",
8047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8049 "filename": "server/api/dashboard/index.js",
8050 "groupTitle": "Dashboards"
8054 "url": "/api/dashboards/{id}",
8055 "title": "Update an existing Dashboard",
8058 "title": "Example usage:",
8059 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8063 "name": "updateDashboards",
8064 "group": "Dashboards",
8065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8067 "filename": "server/api/dashboard/index.js",
8068 "groupTitle": "Dashboards"
8072 "url": "/api/integrations/desk/accounts",
8073 "title": "Creates a new Desk Account",
8076 "title": "Example usage:",
8077 "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",
8081 "name": "CreateDesk_Accounts",
8082 "group": "Desk_Accounts",
8097 "field": "description",
8104 "field": "username",
8111 "field": "remoteUri",
8121 "field": "authType",
8128 "field": "password",
8135 "field": "consumerKey",
8142 "field": "consumerSecret",
8156 "field": "tokenSecret",
8163 "field": "serverUrl",
8170 "\"integrationTab\"",
8180 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8182 "filename": "server/api/intDeskAccount/index.js",
8183 "groupTitle": "Desk_Accounts"
8187 "url": "/api/integrations/desk/accounts/{id}",
8188 "title": "Deletes a Desk Account",
8191 "title": "Example usage:",
8192 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8196 "name": "DeleteDesk_Accounts",
8197 "group": "Desk_Accounts",
8198 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8200 "filename": "server/api/intDeskAccount/index.js",
8201 "groupTitle": "Desk_Accounts"
8205 "url": "/api/integrations/desk/accounts",
8206 "title": "Gets a list of Desk Accounts",
8209 "title": "Example usage:",
8210 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8214 "name": "GetDesk_Accounts",
8215 "group": "Desk_Accounts",
8216 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8218 "filename": "server/api/intDeskAccount/index.js",
8219 "groupTitle": "Desk_Accounts"
8223 "url": "/api/integrations/desk/accounts/{id}",
8224 "title": "Gets a single Desk Account",
8227 "title": "Example usage:",
8228 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8232 "name": "ShowDesk_Accounts",
8233 "group": "Desk_Accounts",
8234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8236 "filename": "server/api/intDeskAccount/index.js",
8237 "groupTitle": "Desk_Accounts"
8241 "url": "/api/integrations/desk/accounts/{id}/configurations",
8242 "title": "Creates new configuration",
8245 "title": "Example usage:",
8246 "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",
8250 "name": "addConfiguration",
8251 "group": "Desk_Accounts",
8252 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8254 "filename": "server/api/intDeskAccount/index.js",
8255 "groupTitle": "Desk_Accounts"
8259 "url": "/api/integrations/desk/accounts/{id}/configurations",
8260 "title": "Gets account configurations",
8263 "title": "Example usage:",
8264 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8268 "name": "getConfigurations",
8269 "group": "Desk_Accounts",
8270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8272 "filename": "server/api/intDeskAccount/index.js",
8273 "groupTitle": "Desk_Accounts"
8277 "url": "/api/integrations/desk/accounts/{id}/fields",
8278 "title": "Gets account fields",
8281 "title": "Example usage:",
8282 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8286 "name": "getFields",
8287 "group": "Desk_Accounts",
8288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8290 "filename": "server/api/intDeskAccount/index.js",
8291 "groupTitle": "Desk_Accounts"
8295 "url": "/api/integrations/desk/accounts/{id}",
8296 "title": "Update an existing Desk Account",
8299 "title": "Example usage:",
8300 "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",
8304 "name": "updateDesk_Accounts",
8305 "group": "Desk_Accounts",
8306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8308 "filename": "server/api/intDeskAccount/index.js",
8309 "groupTitle": "Desk_Accounts"
8313 "url": "/api/integrations/desk/configurations",
8314 "title": "Creates a new Desk Configuration",
8317 "title": "Example usage:",
8318 "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",
8322 "name": "CreateDesk_Configurations",
8323 "group": "Desk_Configurations",
8338 "field": "description",
8344 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8346 "filename": "server/api/intDeskConfiguration/index.js",
8347 "groupTitle": "Desk_Configurations"
8351 "url": "/api/integrations/desk/configurations/{id}",
8352 "title": "Deletes a Desk Configuration",
8355 "title": "Example usage:",
8356 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8360 "name": "DeleteDesk_Configurations",
8361 "group": "Desk_Configurations",
8362 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8364 "filename": "server/api/intDeskConfiguration/index.js",
8365 "groupTitle": "Desk_Configurations"
8369 "url": "/api/integrations/desk/configurations",
8370 "title": "Gets a list of Desk Configurations",
8373 "title": "Example usage:",
8374 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8378 "name": "GetDesk_Configurations",
8379 "group": "Desk_Configurations",
8380 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8382 "filename": "server/api/intDeskConfiguration/index.js",
8383 "groupTitle": "Desk_Configurations"
8387 "url": "/api/integrations/desk/configurations/{id}",
8388 "title": "Gets a single Desk Configuration",
8391 "title": "Example usage:",
8392 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8396 "name": "ShowDesk_Configurations",
8397 "group": "Desk_Configurations",
8398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8400 "filename": "server/api/intDeskConfiguration/index.js",
8401 "groupTitle": "Desk_Configurations"
8405 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8406 "title": "Gets configurations descriptions",
8409 "title": "Example usage:",
8410 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8414 "name": "getDescriptions",
8415 "group": "Desk_Configurations",
8416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8418 "filename": "server/api/intDeskConfiguration/index.js",
8419 "groupTitle": "Desk_Configurations"
8423 "url": "/api/integrations/desk/configurations/{id}/fields",
8424 "title": "Gets configurations fields",
8427 "title": "Example usage:",
8428 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8432 "name": "getFields",
8433 "group": "Desk_Configurations",
8434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8436 "filename": "server/api/intDeskConfiguration/index.js",
8437 "groupTitle": "Desk_Configurations"
8441 "url": "/api/integrations/desk/configurations/{id}/subjects",
8442 "title": "Gets configurations subjects",
8445 "title": "Example usage:",
8446 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8450 "name": "getSubjects",
8451 "group": "Desk_Configurations",
8452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8454 "filename": "server/api/intDeskConfiguration/index.js",
8455 "groupTitle": "Desk_Configurations"
8459 "url": "/api/integrations/desk/configurations/{id}/tags",
8460 "title": "Gets configurations tags",
8463 "title": "Example usage:",
8464 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8469 "group": "Desk_Configurations",
8470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8472 "filename": "server/api/intDeskConfiguration/index.js",
8473 "groupTitle": "Desk_Configurations"
8477 "url": "/api/integrations/desk/configurations/{id}/tags",
8478 "title": "Sets new tags",
8481 "title": "Example usage:",
8482 "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",
8487 "group": "Desk_Configurations",
8488 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8490 "filename": "server/api/intDeskConfiguration/index.js",
8491 "groupTitle": "Desk_Configurations"
8495 "url": "/api/integrations/desk/configurations/{id}",
8496 "title": "Update an existing Desk Configuration",
8499 "title": "Example usage:",
8500 "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",
8504 "name": "updateDesk_Configurations",
8505 "group": "Desk_Configurations",
8506 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8508 "filename": "server/api/intDeskConfiguration/index.js",
8509 "groupTitle": "Desk_Configurations"
8513 "url": "/api/integrations/desk/fields",
8514 "title": "Creates a new Desk Field",
8517 "title": "Example usage:",
8518 "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",
8522 "name": "CreateDesk_Fields",
8523 "group": "Desk_Fields",
8533 "\"customVariable\"",
8560 "\"customVariable\""
8570 "field": "keyContent",
8584 "field": "nameField",
8591 "field": "customField",
8598 "field": "variableName",
8604 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8606 "filename": "server/api/intDeskField/index.js",
8607 "groupTitle": "Desk_Fields"
8611 "url": "/api/integrations/desk/fields/{id}",
8612 "title": "Deletes a Desk Field",
8615 "title": "Example usage:",
8616 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8620 "name": "DeleteDesk_Fields",
8621 "group": "Desk_Fields",
8622 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8624 "filename": "server/api/intDeskField/index.js",
8625 "groupTitle": "Desk_Fields"
8629 "url": "/api/integrations/desk/fields",
8630 "title": "Gets a list of Desk Fields",
8633 "title": "Example usage:",
8634 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8638 "name": "GetDesk_Fields",
8639 "group": "Desk_Fields",
8640 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8642 "filename": "server/api/intDeskField/index.js",
8643 "groupTitle": "Desk_Fields"
8647 "url": "/api/integrations/desk/fields/{id}",
8648 "title": "Gets a single Desk Field",
8651 "title": "Example usage:",
8652 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8656 "name": "ShowDesk_Fields",
8657 "group": "Desk_Fields",
8658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Update an existing Desk Field",
8669 "title": "Example usage:",
8670 "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",
8674 "name": "updateDesk_Fields",
8675 "group": "Desk_Fields",
8676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/dispositions",
8684 "title": "Creates a new Disposition",
8687 "title": "Example usage:",
8688 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8692 "name": "CreateDispositions",
8693 "group": "Dispositions",
8720 "field": "description",
8726 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8728 "filename": "server/api/disposition/index.js",
8729 "groupTitle": "Dispositions"
8733 "url": "/api/dispositions/{id}",
8734 "title": "Deletes a Disposition",
8737 "title": "Example usage:",
8738 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8742 "name": "DeleteDispositions",
8743 "group": "Dispositions",
8744 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8746 "filename": "server/api/disposition/index.js",
8747 "groupTitle": "Dispositions"
8751 "url": "/api/dispositions",
8752 "title": "Gets a list of Dispositions",
8755 "title": "Example usage:",
8756 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8760 "name": "GetDispositions",
8761 "group": "Dispositions",
8762 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8764 "filename": "server/api/disposition/index.js",
8765 "groupTitle": "Dispositions"
8769 "url": "/api/dispositions/{id}",
8770 "title": "Gets a single Disposition",
8773 "title": "Example usage:",
8774 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8778 "name": "ShowDispositions",
8779 "group": "Dispositions",
8780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Update an existing Disposition",
8791 "title": "Example usage:",
8792 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8796 "name": "updateDispositions",
8797 "group": "Dispositions",
8798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/integrations/dynamics365/accounts",
8806 "title": "Creates a new Dynamics365 Account",
8809 "title": "Example usage:",
8810 "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",
8814 "name": "CreateDynamics365_Accounts",
8815 "group": "Dynamics365_Accounts",
8830 "field": "username",
8837 "field": "password",
8844 "field": "remoteUri",
8851 "field": "tenantId",
8858 "field": "clientId",
8865 "field": "clientSecret",
8872 "field": "serverUrl",
8879 "field": "description",
8885 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8887 "filename": "server/api/intDynamics365Account/index.js",
8888 "groupTitle": "Dynamics365_Accounts"
8892 "url": "/api/integrations/dynamics365/accounts/{id}",
8893 "title": "Deletes a Dynamics365 Account",
8896 "title": "Example usage:",
8897 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8901 "name": "DeleteDynamics365_Accounts",
8902 "group": "Dynamics365_Accounts",
8903 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8905 "filename": "server/api/intDynamics365Account/index.js",
8906 "groupTitle": "Dynamics365_Accounts"
8910 "url": "/api/integrations/dynamics365/accounts",
8911 "title": "Gets a list of Dynamics365 Accounts",
8914 "title": "Example usage:",
8915 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8919 "name": "GetDynamics365_Accounts",
8920 "group": "Dynamics365_Accounts",
8921 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8923 "filename": "server/api/intDynamics365Account/index.js",
8924 "groupTitle": "Dynamics365_Accounts"
8928 "url": "/api/integrations/dynamics365/accounts/{id}",
8929 "title": "Gets a single Dynamics365 Account",
8932 "title": "Example usage:",
8933 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8937 "name": "ShowDynamics365_Accounts",
8938 "group": "Dynamics365_Accounts",
8939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/configurations",
8947 "title": "Creates new configuration",
8950 "title": "Example usage:",
8951 "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",
8955 "name": "addConfiguration",
8956 "group": "Dynamics365_Accounts",
8957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}/configurations",
8965 "title": "Gets account configurations",
8968 "title": "Example usage:",
8969 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8973 "name": "getConfigurations",
8974 "group": "Dynamics365_Accounts",
8975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8977 "filename": "server/api/intDynamics365Account/index.js",
8978 "groupTitle": "Dynamics365_Accounts"
8982 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8983 "title": "Gets account fields",
8986 "title": "Example usage:",
8987 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8991 "name": "getFields",
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}",
9001 "title": "Update an existing Dynamics365 Account",
9004 "title": "Example usage:",
9005 "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",
9009 "name": "updateDynamics365_Accounts",
9010 "group": "Dynamics365_Accounts",
9011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/configurations",
9019 "title": "Creates a new Dynamics365 Configuration",
9022 "title": "Example usage:",
9023 "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",
9027 "name": "CreateDynamics365_Configurations",
9028 "group": "Dynamics365_Configurations",
9043 "field": "description",
9054 "field": "ticketType",
9060 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9062 "filename": "server/api/intDynamics365Configuration/index.js",
9063 "groupTitle": "Dynamics365_Configurations"
9067 "url": "/api/integrations/dynamics365/configurations/{id}",
9068 "title": "Deletes a Dynamics365 Configuration",
9071 "title": "Example usage:",
9072 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9076 "name": "DeleteDynamics365_Configurations",
9077 "group": "Dynamics365_Configurations",
9078 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9080 "filename": "server/api/intDynamics365Configuration/index.js",
9081 "groupTitle": "Dynamics365_Configurations"
9085 "url": "/api/integrations/dynamics365/configurations",
9086 "title": "Gets a list of Dynamics365 Configurations",
9089 "title": "Example usage:",
9090 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9094 "name": "GetDynamics365_Configurations",
9095 "group": "Dynamics365_Configurations",
9096 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9098 "filename": "server/api/intDynamics365Configuration/index.js",
9099 "groupTitle": "Dynamics365_Configurations"
9103 "url": "/api/integrations/dynamics365/configurations/{id}",
9104 "title": "Gets a single Dynamics365 Configuration",
9107 "title": "Example usage:",
9108 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9112 "name": "ShowDynamics365_Configurations",
9113 "group": "Dynamics365_Configurations",
9114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/descriptions",
9122 "title": "Gets configurations descriptions",
9125 "title": "Example usage:",
9126 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9130 "name": "getDescriptions",
9131 "group": "Dynamics365_Configurations",
9132 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/{id}/fields",
9140 "title": "Gets configurations fields",
9143 "title": "Example usage:",
9144 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9148 "name": "getFields",
9149 "group": "Dynamics365_Configurations",
9150 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9152 "filename": "server/api/intDynamics365Configuration/index.js",
9153 "groupTitle": "Dynamics365_Configurations"
9157 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9158 "title": "Gets configurations subjects",
9161 "title": "Example usage:",
9162 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9166 "name": "getSubjects",
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}",
9176 "title": "Update an existing Dynamics365 Configuration",
9179 "title": "Example usage:",
9180 "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",
9184 "name": "updateDynamics365_Configurations",
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/fields",
9194 "title": "Creates a new Dynamics365 Field",
9197 "title": "Example usage:",
9198 "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",
9202 "name": "CreateDynamics365_Fields",
9203 "group": "Dynamics365_Fields",
9213 "\"customVariable\"",
9240 "\"customVariable\""
9250 "field": "keyContent",
9264 "field": "nameField",
9271 "field": "customField",
9278 "field": "variableName",
9284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9286 "filename": "server/api/intDynamics365Field/index.js",
9287 "groupTitle": "Dynamics365_Fields"
9291 "url": "/api/integrations/dynamics365/fields/{id}",
9292 "title": "Deletes a Dynamics365 Field",
9295 "title": "Example usage:",
9296 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9300 "name": "DeleteDynamics365_Fields",
9301 "group": "Dynamics365_Fields",
9302 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9304 "filename": "server/api/intDynamics365Field/index.js",
9305 "groupTitle": "Dynamics365_Fields"
9309 "url": "/api/integrations/dynamics365/fields",
9310 "title": "Gets a list of Dynamics365 Fields",
9313 "title": "Example usage:",
9314 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9318 "name": "GetDynamics365_Fields",
9319 "group": "Dynamics365_Fields",
9320 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9322 "filename": "server/api/intDynamics365Field/index.js",
9323 "groupTitle": "Dynamics365_Fields"
9327 "url": "/api/integrations/dynamics365/fields/{id}",
9328 "title": "Gets a single Dynamics365 Field",
9331 "title": "Example usage:",
9332 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9336 "name": "ShowDynamics365_Fields",
9337 "group": "Dynamics365_Fields",
9338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9340 "filename": "server/api/intDynamics365Field/index.js",
9341 "groupTitle": "Dynamics365_Fields"
9345 "url": "/api/integrations/dynamics365/fields/{id}",
9346 "title": "Update an existing Dynamics365 Field",
9349 "title": "Example usage:",
9350 "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",
9354 "name": "updateDynamics365_Fields",
9355 "group": "Dynamics365_Fields",
9356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9358 "filename": "server/api/intDynamics365Field/index.js",
9359 "groupTitle": "Dynamics365_Fields"
9363 "url": "/api/fax/accounts/{id}/users",
9364 "title": "Add agents to a fax account",
9367 "title": "Example usage:",
9368 "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",
9372 "name": "AddAgents",
9373 "group": "Fax_Accounts",
9374 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9376 "filename": "server/api/faxAccount/index.js",
9377 "groupTitle": "Fax_Accounts"
9381 "url": "/api/fax/accounts",
9382 "title": "Creates a new Account",
9385 "title": "Example usage:",
9386 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9390 "name": "CreateAccounts",
9391 "group": "Fax_Accounts",
9406 "field": "description",
9424 "field": "headerinfo",
9431 "field": "localstationid",
9482 "field": "faxdetect",
9489 "field": "t38timeout",
9516 "field": "notificationTemplate",
9523 "field": "notificationSound",
9530 "field": "notificationShake",
9537 "field": "waitForTheAssignedAgent",
9544 "field": "queueTransfer",
9551 "field": "queueTransferTimeout",
9558 "field": "agentTransfer",
9565 "field": "agentTransferTimeout",
9572 "field": "mandatoryDispositionPauseId",
9573 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9579 "field": "mandatoryDisposition",
9580 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9585 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9587 "filename": "server/api/faxAccount/index.js",
9588 "groupTitle": "Fax_Accounts"
9592 "url": "/api/fax/accounts/{id}",
9593 "title": "Deletes a Account",
9596 "title": "Example usage:",
9597 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9601 "name": "DeleteAccounts",
9602 "group": "Fax_Accounts",
9603 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9605 "filename": "server/api/faxAccount/index.js",
9606 "groupTitle": "Fax_Accounts"
9610 "url": "/api/fax/accounts/describe",
9611 "title": "Gets table info about Accounts",
9614 "title": "Example usage:",
9615 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9619 "name": "DescribeAccounts",
9620 "group": "Fax_Accounts",
9621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9623 "filename": "server/api/faxAccount/index.js",
9624 "groupTitle": "Fax_Accounts"
9628 "url": "/api/fax/accounts",
9629 "title": "Gets a list of Accounts",
9632 "title": "Example usage:",
9633 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9637 "name": "GetAccounts",
9638 "group": "Fax_Accounts",
9639 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9641 "filename": "server/api/faxAccount/index.js",
9642 "groupTitle": "Fax_Accounts"
9646 "url": "/api/fax/accounts/{id}/users",
9647 "title": "Gets agents from fax account",
9650 "title": "Example usage:",
9651 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9655 "name": "GetAgents",
9656 "group": "Fax_Accounts",
9657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9659 "filename": "server/api/faxAccount/index.js",
9660 "groupTitle": "Fax_Accounts"
9664 "url": "/api/fax/accounts/{id}/users",
9665 "title": "Removes agents from a fax account",
9668 "title": "Example usage:",
9669 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9673 "name": "RemoveAgents",
9674 "group": "Fax_Accounts",
9675 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9677 "filename": "server/api/faxAccount/index.js",
9678 "groupTitle": "Fax_Accounts"
9682 "url": "/api/fax/accounts/{id}/canned_answers",
9683 "title": "Removes canned answers from account",
9686 "title": "Example usage:",
9687 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9691 "name": "RemoveAnswers",
9692 "group": "Fax_Accounts",
9693 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9695 "filename": "server/api/faxAccount/index.js",
9696 "groupTitle": "Fax_Accounts"
9700 "url": "/api/fax/accounts/{id}/dispositions",
9701 "title": "Removes dispositions from account",
9704 "title": "Example usage:",
9705 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9709 "name": "RemoveDispositions",
9710 "group": "Fax_Accounts",
9711 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9713 "filename": "server/api/faxAccount/index.js",
9714 "groupTitle": "Fax_Accounts"
9718 "url": "/api/fax/accounts/{id}",
9719 "title": "Gets a single Account",
9722 "title": "Example usage:",
9723 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9727 "name": "ShowAccounts",
9728 "group": "Fax_Accounts",
9729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9731 "filename": "server/api/faxAccount/index.js",
9732 "groupTitle": "Fax_Accounts"
9736 "url": "/api/fax/accounts/{id}/canned_answers",
9737 "title": "Creates new canned answer",
9740 "title": "Example usage:",
9741 "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",
9745 "name": "addAnswer",
9746 "group": "Fax_Accounts",
9768 "field": "description",
9781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9783 "filename": "server/api/faxAccount/index.js",
9784 "groupTitle": "Fax_Accounts"
9788 "url": "/api/fax/accounts/{id}/applications",
9789 "title": "Creates new applications",
9792 "title": "Example usage:",
9793 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9797 "name": "addApplications",
9798 "group": "Fax_Accounts",
9806 "field": "priority",
9827 "field": "description",
9834 "field": "interval",
9840 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9842 "filename": "server/api/faxAccount/index.js",
9843 "groupTitle": "Fax_Accounts"
9847 "url": "/api/fax/accounts/addaccountapplications",
9848 "title": "Creates new account and applications",
9851 "title": "Example usage:",
9852 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9856 "name": "addApplications",
9857 "group": "Fax_Accounts",
9865 "field": "priority",
9886 "field": "description",
9893 "field": "interval",
9899 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9901 "filename": "server/api/faxAccount/index.js",
9902 "groupTitle": "Fax_Accounts"
9906 "url": "/api/fax/accounts/{id}/dispositions",
9907 "title": "Creates new disposition",
9910 "title": "Example usage:",
9911 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9915 "name": "addDisposition",
9916 "group": "Fax_Accounts",
9943 "field": "description",
9949 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9951 "filename": "server/api/faxAccount/index.js",
9952 "groupTitle": "Fax_Accounts"
9956 "url": "/api/fax/accounts/{id}/interactions",
9957 "title": "Creates new interactions",
9960 "title": "Example usage:",
9961 "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",
9965 "name": "addInteraction",
9966 "group": "Fax_Accounts",
9981 "field": "closedAt",
9988 "field": "disposition",
9995 "field": "secondDisposition",
10002 "field": "thirdDisposition",
10016 "field": "read1stAt",
10034 "field": "firstMsgDirection",
10041 "field": "lastMsgAt",
10052 "field": "lastMsgDirection",
10058 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10059 "version": "0.0.0",
10060 "filename": "server/api/faxAccount/index.js",
10061 "groupTitle": "Fax_Accounts"
10065 "url": "/api/fax/accounts/{id}/canned_answers",
10066 "title": "Gets account canned answers",
10069 "title": "Example usage:",
10070 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10074 "name": "getAnswers",
10075 "group": "Fax_Accounts",
10076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10077 "version": "0.0.0",
10078 "filename": "server/api/faxAccount/index.js",
10079 "groupTitle": "Fax_Accounts"
10083 "url": "/api/fax/accounts/{id}/applications",
10084 "title": "Gets account pplications",
10087 "title": "Example usage:",
10088 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10092 "name": "getApplications",
10093 "group": "Fax_Accounts",
10094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10095 "version": "0.0.0",
10096 "filename": "server/api/faxAccount/index.js",
10097 "groupTitle": "Fax_Accounts"
10101 "url": "/api/fax/accounts/{id}/dispositions",
10102 "title": "Gets account dispositions",
10105 "title": "Example usage:",
10106 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10110 "name": "getDispositions",
10111 "group": "Fax_Accounts",
10112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10113 "version": "0.0.0",
10114 "filename": "server/api/faxAccount/index.js",
10115 "groupTitle": "Fax_Accounts"
10119 "url": "/api/fax/accounts/{id}/interactions",
10120 "title": "Gets account interactions",
10123 "title": "Example usage:",
10124 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10128 "name": "getInteraction",
10129 "group": "Fax_Accounts",
10130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10131 "version": "0.0.0",
10132 "filename": "server/api/faxAccount/index.js",
10133 "groupTitle": "Fax_Accounts"
10137 "url": "/api/fax/accounts/{id}/messages",
10138 "title": "Gets account messages",
10141 "title": "Example usage:",
10142 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10146 "name": "getMessages",
10147 "group": "Fax_Accounts",
10148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10149 "version": "0.0.0",
10150 "filename": "server/api/faxAccount/index.js",
10151 "groupTitle": "Fax_Accounts"
10155 "url": "/api/fax/accounts/{id}/send",
10156 "title": "Send new fax",
10159 "title": "Example usage:",
10160 "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",
10165 "group": "Fax_Accounts",
10166 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10167 "version": "0.0.0",
10168 "filename": "server/api/faxAccount/index.js",
10169 "groupTitle": "Fax_Accounts"
10173 "url": "/api/fax/accounts/{id}",
10174 "title": "Update an existing Account",
10177 "title": "Example usage:",
10178 "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",
10182 "name": "updateAccounts",
10183 "group": "Fax_Accounts",
10184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10185 "version": "0.0.0",
10186 "filename": "server/api/faxAccount/index.js",
10187 "groupTitle": "Fax_Accounts"
10191 "url": "/api/fax/accounts/updateaccountapplications",
10192 "title": "Update account and applications",
10195 "title": "Example usage:",
10196 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10200 "name": "updateApplications",
10201 "group": "Fax_Accounts",
10209 "field": "priority",
10223 "field": "appdata",
10230 "field": "description",
10237 "field": "interval",
10243 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10244 "version": "0.0.0",
10245 "filename": "server/api/faxAccount/index.js",
10246 "groupTitle": "Fax_Accounts"
10250 "url": "/api/fax/applications",
10251 "title": "Creates a new Application",
10254 "title": "Example usage:",
10255 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10259 "name": "CreateApplications",
10260 "group": "Fax_Applications",
10268 "field": "priority",
10282 "field": "appdata",
10289 "field": "description",
10296 "field": "interval",
10302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10303 "version": "0.0.0",
10304 "filename": "server/api/faxApplication/index.js",
10305 "groupTitle": "Fax_Applications"
10309 "url": "/api/fax/applications/{id}",
10310 "title": "Deletes a Application",
10313 "title": "Example usage:",
10314 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10318 "name": "DeleteApplications",
10319 "group": "Fax_Applications",
10320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10321 "version": "0.0.0",
10322 "filename": "server/api/faxApplication/index.js",
10323 "groupTitle": "Fax_Applications"
10327 "url": "/api/fax/applications",
10328 "title": "Gets a list of Applications",
10331 "title": "Example usage:",
10332 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10336 "name": "GetApplications",
10337 "group": "Fax_Applications",
10338 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10339 "version": "0.0.0",
10340 "filename": "server/api/faxApplication/index.js",
10341 "groupTitle": "Fax_Applications"
10345 "url": "/api/fax/applications/{id}",
10346 "title": "Gets a single Application",
10349 "title": "Example usage:",
10350 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10354 "name": "ShowApplications",
10355 "group": "Fax_Applications",
10356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10357 "version": "0.0.0",
10358 "filename": "server/api/faxApplication/index.js",
10359 "groupTitle": "Fax_Applications"
10363 "url": "/api/fax/applications/{id}",
10364 "title": "Update an existing Application",
10367 "title": "Example usage:",
10368 "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",
10372 "name": "updateApplications",
10373 "group": "Fax_Applications",
10374 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10375 "version": "0.0.0",
10376 "filename": "server/api/faxApplication/index.js",
10377 "groupTitle": "Fax_Applications"
10381 "url": "/api/fax/interactions/{id}/tags",
10382 "title": "Add tags to the interaction",
10385 "title": "Example usage:",
10386 "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",
10391 "group": "Fax_Interactions",
10392 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10393 "version": "0.0.0",
10394 "filename": "server/api/faxInteraction/index.js",
10395 "groupTitle": "Fax_Interactions"
10399 "url": "/api/fax/interactions",
10400 "title": "Creates a new Interaction",
10403 "title": "Example usage:",
10404 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10408 "name": "CreateInteractions",
10409 "group": "Fax_Interactions",
10424 "field": "closedAt",
10431 "field": "disposition",
10438 "field": "secondDisposition",
10445 "field": "thirdDisposition",
10459 "field": "read1stAt",
10477 "field": "firstMsgDirection",
10484 "field": "lastMsgAt",
10495 "field": "lastMsgDirection",
10501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10502 "version": "0.0.0",
10503 "filename": "server/api/faxInteraction/index.js",
10504 "groupTitle": "Fax_Interactions"
10508 "url": "/api/fax/interactions/{id}",
10509 "title": "Deletes a Interaction",
10512 "title": "Example usage:",
10513 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10517 "name": "DeleteInteractions",
10518 "group": "Fax_Interactions",
10519 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10520 "version": "0.0.0",
10521 "filename": "server/api/faxInteraction/index.js",
10522 "groupTitle": "Fax_Interactions"
10526 "url": "/api/fax/interactions/describe",
10527 "title": "Gets table info about Interactions",
10530 "title": "Example usage:",
10531 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10535 "name": "DescribeInteractions",
10536 "group": "Fax_Interactions",
10537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10538 "version": "0.0.0",
10539 "filename": "server/api/faxInteraction/index.js",
10540 "groupTitle": "Fax_Interactions"
10544 "url": "/api/fax/interactions",
10545 "title": "Gets a list of Interactions",
10548 "title": "Example usage:",
10549 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10553 "name": "GetInteractions",
10554 "group": "Fax_Interactions",
10555 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10556 "version": "0.0.0",
10557 "filename": "server/api/faxInteraction/index.js",
10558 "groupTitle": "Fax_Interactions"
10562 "url": "/api/fax/interactions/{id}/tags",
10563 "title": "Removes tags from interaction",
10566 "title": "Example usage:",
10567 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10571 "name": "RemoveTags",
10572 "group": "Fax_Interactions",
10573 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10574 "version": "0.0.0",
10575 "filename": "server/api/faxInteraction/index.js",
10576 "groupTitle": "Fax_Interactions"
10580 "url": "/api/fax/interactions/{id}",
10581 "title": "Gets a single Interaction",
10584 "title": "Example usage:",
10585 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10589 "name": "ShowInteractions",
10590 "group": "Fax_Interactions",
10591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10592 "version": "0.0.0",
10593 "filename": "server/api/faxInteraction/index.js",
10594 "groupTitle": "Fax_Interactions"
10598 "url": "/api/fax/interactions/{id}/messages",
10599 "title": "Creates new messages",
10602 "title": "Example usage:",
10603 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10607 "name": "addMessage",
10608 "group": "Fax_Interactions",
10634 "field": "direction",
10641 "field": "failMessage",
10654 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10655 "version": "0.0.0",
10656 "filename": "server/api/faxInteraction/index.js",
10657 "groupTitle": "Fax_Interactions"
10661 "url": "/api/fax/interactions/{id}/download",
10662 "title": "Get interactions",
10665 "title": "Example usage:",
10666 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10670 "name": "download",
10671 "group": "Fax_Interactions",
10672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10673 "version": "0.0.0",
10674 "filename": "server/api/faxInteraction/index.js",
10675 "groupTitle": "Fax_Interactions"
10679 "url": "/api/fax/interactions/{id}/messages",
10680 "title": "Gets interaction messages",
10683 "title": "Example usage:",
10684 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10688 "name": "getMessages",
10689 "group": "Fax_Interactions",
10690 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10691 "version": "0.0.0",
10692 "filename": "server/api/faxInteraction/index.js",
10693 "groupTitle": "Fax_Interactions"
10697 "url": "/api/fax/interactions/{id}",
10698 "title": "Update an existing Interaction",
10701 "title": "Example usage:",
10702 "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",
10706 "name": "updateInteractions",
10707 "group": "Fax_Interactions",
10708 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10709 "version": "0.0.0",
10710 "filename": "server/api/faxInteraction/index.js",
10711 "groupTitle": "Fax_Interactions"
10715 "url": "/api/fax/messages/{id}/download",
10716 "title": "Get message",
10719 "title": "Example usage:",
10720 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10724 "name": "download",
10725 "group": "Fax_Message",
10726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10727 "version": "0.0.0",
10728 "filename": "server/api/faxMessage/index.js",
10729 "groupTitle": "Fax_Message"
10733 "url": "/api/fax/messages/{id}",
10734 "title": "Deletes a Message",
10737 "title": "Example usage:",
10738 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10742 "name": "DeleteMessages",
10743 "group": "Fax_Messages",
10744 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10745 "version": "0.0.0",
10746 "filename": "server/api/faxMessage/index.js",
10747 "groupTitle": "Fax_Messages"
10751 "url": "/api/fax/messages/describe",
10752 "title": "Gets table info about Messages",
10755 "title": "Example usage:",
10756 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10760 "name": "DescribeMessages",
10761 "group": "Fax_Messages",
10762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10763 "version": "0.0.0",
10764 "filename": "server/api/faxMessage/index.js",
10765 "groupTitle": "Fax_Messages"
10769 "url": "/api/fax/messages",
10770 "title": "Gets a list of Messages",
10773 "title": "Example usage:",
10774 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10778 "name": "GetMessages",
10779 "group": "Fax_Messages",
10780 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10781 "version": "0.0.0",
10782 "filename": "server/api/faxMessage/index.js",
10783 "groupTitle": "Fax_Messages"
10787 "url": "/api/fax/messages/{id}",
10788 "title": "Gets a single Message",
10791 "title": "Example usage:",
10792 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10796 "name": "ShowMessages",
10797 "group": "Fax_Messages",
10798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10799 "version": "0.0.0",
10800 "filename": "server/api/faxMessage/index.js",
10801 "groupTitle": "Fax_Messages"
10805 "url": "/api/fax/messages/{id}/accept",
10806 "title": "Accepts message",
10809 "title": "Example usage:",
10810 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10814 "name": "acceptMessage",
10815 "group": "Fax_Messages",
10816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10817 "version": "0.0.0",
10818 "filename": "server/api/faxMessage/index.js",
10819 "groupTitle": "Fax_Messages"
10823 "url": "/api/fax/messages",
10824 "title": "Create message and send Fax",
10827 "title": "Example usage:",
10828 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10832 "name": "rejectMessage",
10833 "group": "Fax_Messages",
10834 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10835 "version": "0.0.0",
10836 "filename": "server/api/faxMessage/index.js",
10837 "groupTitle": "Fax_Messages"
10841 "url": "/api/fax/messages/{id}/reject",
10842 "title": "Rejects message",
10845 "title": "Example usage:",
10846 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10850 "name": "rejectMessage",
10851 "group": "Fax_Messages",
10852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10853 "version": "0.0.0",
10854 "filename": "server/api/faxMessage/index.js",
10855 "groupTitle": "Fax_Messages"
10859 "url": "/api/fax/messages/{id}",
10860 "title": "Update an existing Message",
10863 "title": "Example usage:",
10864 "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",
10868 "name": "updateMessages",
10869 "group": "Fax_Messages",
10870 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10871 "version": "0.0.0",
10872 "filename": "server/api/faxMessage/index.js",
10873 "groupTitle": "Fax_Messages"
10877 "url": "/api/fax/reports/queue",
10878 "title": "Creates a new Fax Queue Report",
10881 "title": "Example usage:",
10882 "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",
10886 "name": "CreateFax_Queue_Reports",
10887 "group": "Fax_Queue_Reports",
10895 "field": "uniqueid",
10916 "field": "leaveAt",
10923 "field": "acceptAt",
10943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10944 "version": "0.0.0",
10945 "filename": "server/api/faxQueueReport/index.js",
10946 "groupTitle": "Fax_Queue_Reports"
10950 "url": "/api/fax/reports/queue/{id}",
10951 "title": "Deletes a Fax Queue Report",
10954 "title": "Example usage:",
10955 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10959 "name": "DeleteFax_Queue_Reports",
10960 "group": "Fax_Queue_Reports",
10961 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10962 "version": "0.0.0",
10963 "filename": "server/api/faxQueueReport/index.js",
10964 "groupTitle": "Fax_Queue_Reports"
10968 "url": "/api/fax/reports/queue/describe",
10969 "title": "Gets table info about Fax Queue Reports",
10972 "title": "Example usage:",
10973 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10977 "name": "DescribeFax_Queue_Reports",
10978 "group": "Fax_Queue_Reports",
10979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10980 "version": "0.0.0",
10981 "filename": "server/api/faxQueueReport/index.js",
10982 "groupTitle": "Fax_Queue_Reports"
10986 "url": "/api/fax/reports/queue",
10987 "title": "Gets a list of Fax Queue Reports",
10990 "title": "Example usage:",
10991 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10995 "name": "GetFax_Queue_Reports",
10996 "group": "Fax_Queue_Reports",
10997 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10998 "version": "0.0.0",
10999 "filename": "server/api/faxQueueReport/index.js",
11000 "groupTitle": "Fax_Queue_Reports"
11004 "url": "/api/fax/reports/queue/{id}",
11005 "title": "Gets a single Fax Queue Report",
11008 "title": "Example usage:",
11009 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11013 "name": "ShowFax_Queue_Reports",
11014 "group": "Fax_Queue_Reports",
11015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11016 "version": "0.0.0",
11017 "filename": "server/api/faxQueueReport/index.js",
11018 "groupTitle": "Fax_Queue_Reports"
11022 "url": "/api/fax/reports/queue/{id}",
11023 "title": "Update an existing Fax Queue Report",
11026 "title": "Example usage:",
11027 "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",
11031 "name": "updateFax_Queue_Reports",
11032 "group": "Fax_Queue_Reports",
11033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11034 "version": "0.0.0",
11035 "filename": "server/api/faxQueueReport/index.js",
11036 "groupTitle": "Fax_Queue_Reports"
11040 "url": "/api/fax/queues/{id}/users",
11041 "title": "Add agents to a queue",
11044 "title": "Example usage:",
11045 "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",
11049 "name": "AddAgents",
11050 "group": "Fax_Queues",
11051 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11052 "version": "0.0.0",
11053 "filename": "server/api/faxQueue/index.js",
11054 "groupTitle": "Fax_Queues"
11058 "url": "/api/fax/queues/{id}/teams",
11059 "title": "Add teams to a queue",
11062 "title": "Example usage:",
11063 "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",
11067 "name": "AddTeams",
11068 "group": "Fax_Queues",
11069 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11070 "version": "0.0.0",
11071 "filename": "server/api/faxQueue/index.js",
11072 "groupTitle": "Fax_Queues"
11076 "url": "/api/fax/queues",
11077 "title": "Creates a new Queue",
11080 "title": "Example usage:",
11081 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11085 "name": "CreateQueues",
11086 "group": "Fax_Queues",
11101 "field": "description",
11108 "field": "timeout",
11120 "field": "strategy",
11127 "field": "lastAgent",
11133 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11134 "version": "0.0.0",
11135 "filename": "server/api/faxQueue/index.js",
11136 "groupTitle": "Fax_Queues"
11140 "url": "/api/fax/queues/{id}",
11141 "title": "Deletes a Queue",
11144 "title": "Example usage:",
11145 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11149 "name": "DeleteQueues",
11150 "group": "Fax_Queues",
11151 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11152 "version": "0.0.0",
11153 "filename": "server/api/faxQueue/index.js",
11154 "groupTitle": "Fax_Queues"
11158 "url": "/api/fax/queues/describe",
11159 "title": "Gets table info about Queues",
11162 "title": "Example usage:",
11163 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11167 "name": "DescribeQueues",
11168 "group": "Fax_Queues",
11169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11170 "version": "0.0.0",
11171 "filename": "server/api/faxQueue/index.js",
11172 "groupTitle": "Fax_Queues"
11176 "url": "/api/fax/queues/{id}/users",
11177 "title": "Gets queue agents",
11180 "title": "Example usage:",
11181 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11185 "name": "GetAgents",
11186 "group": "Fax_Queues",
11187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11188 "version": "0.0.0",
11189 "filename": "server/api/faxQueue/index.js",
11190 "groupTitle": "Fax_Queues"
11194 "url": "/api/fax/queues/{id}/members",
11195 "title": "GetMembers",
11198 "title": "Example usage:",
11199 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11203 "name": "GetMembers",
11204 "group": "Fax_Queues",
11205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11206 "version": "0.0.0",
11207 "filename": "server/api/faxQueue/index.js",
11208 "groupTitle": "Fax_Queues"
11212 "url": "/api/fax/queues",
11213 "title": "Gets a list of Queues",
11216 "title": "Example usage:",
11217 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11221 "name": "GetQueues",
11222 "group": "Fax_Queues",
11223 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11224 "version": "0.0.0",
11225 "filename": "server/api/faxQueue/index.js",
11226 "groupTitle": "Fax_Queues"
11230 "url": "/api/fax/queues/{id}/teams",
11231 "title": "Gets queues list",
11234 "title": "Example usage:",
11235 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11239 "name": "GetTeams",
11240 "group": "Fax_Queues",
11241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11242 "version": "0.0.0",
11243 "filename": "server/api/faxQueue/index.js",
11244 "groupTitle": "Fax_Queues"
11248 "url": "/api/fax/queues/{id}/users",
11249 "title": "Removes agents from a queue",
11252 "title": "Example usage:",
11253 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11257 "name": "RemoveAgents",
11258 "group": "Fax_Queues",
11259 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11260 "version": "0.0.0",
11261 "filename": "server/api/faxQueue/index.js",
11262 "groupTitle": "Fax_Queues"
11266 "url": "/api/fax/queues/{id}",
11267 "title": "Gets a single Queue",
11270 "title": "Example usage:",
11271 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11275 "name": "ShowQueues",
11276 "group": "Fax_Queues",
11277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11278 "version": "0.0.0",
11279 "filename": "server/api/faxQueue/index.js",
11280 "groupTitle": "Fax_Queues"
11284 "url": "/api/fax/queues/{id}",
11285 "title": "Update an existing Queue",
11288 "title": "Example usage:",
11289 "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",
11293 "name": "updateQueues",
11294 "group": "Fax_Queues",
11295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11296 "version": "0.0.0",
11297 "filename": "server/api/faxQueue/index.js",
11298 "groupTitle": "Fax_Queues"
11302 "url": "/api/fax/reports/transfer",
11303 "title": "Creates a new Fax Transfer Report",
11306 "title": "Example usage:",
11307 "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",
11311 "name": "CreateFax_Transfer_Reports",
11312 "group": "Fax_Transfer_Reports",
11320 "field": "uniqueid",
11339 "field": "transferredAt",
11345 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11346 "version": "0.0.0",
11347 "filename": "server/api/faxTransferReport/index.js",
11348 "groupTitle": "Fax_Transfer_Reports"
11352 "url": "/api/fax/reports/transfer/{id}",
11353 "title": "Deletes a Fax Transfer Report",
11356 "title": "Example usage:",
11357 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11361 "name": "DeleteFax_Transfer_Reports",
11362 "group": "Fax_Transfer_Reports",
11363 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11364 "version": "0.0.0",
11365 "filename": "server/api/faxTransferReport/index.js",
11366 "groupTitle": "Fax_Transfer_Reports"
11370 "url": "/api/fax/reports/transfer/describe",
11371 "title": "Gets table info about Fax Transfer Reports",
11374 "title": "Example usage:",
11375 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11379 "name": "DescribeFax_Transfer_Reports",
11380 "group": "Fax_Transfer_Reports",
11381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11382 "version": "0.0.0",
11383 "filename": "server/api/faxTransferReport/index.js",
11384 "groupTitle": "Fax_Transfer_Reports"
11388 "url": "/api/fax/reports/transfer",
11389 "title": "Gets a list of Fax Transfer Reports",
11392 "title": "Example usage:",
11393 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11397 "name": "GetFax_Transfer_Reports",
11398 "group": "Fax_Transfer_Reports",
11399 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11400 "version": "0.0.0",
11401 "filename": "server/api/faxTransferReport/index.js",
11402 "groupTitle": "Fax_Transfer_Reports"
11406 "url": "/api/fax/reports/transfer/{id}",
11407 "title": "Gets a single Fax Transfer Report",
11410 "title": "Example usage:",
11411 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11415 "name": "ShowFax_Transfer_Reports",
11416 "group": "Fax_Transfer_Reports",
11417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11418 "version": "0.0.0",
11419 "filename": "server/api/faxTransferReport/index.js",
11420 "groupTitle": "Fax_Transfer_Reports"
11424 "url": "/api/fax/reports/transfer/{id}",
11425 "title": "Update an existing Fax Transfer Report",
11428 "title": "Example usage:",
11429 "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",
11433 "name": "updateFax_Transfer_Reports",
11434 "group": "Fax_Transfer_Reports",
11435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11436 "version": "0.0.0",
11437 "filename": "server/api/faxTransferReport/index.js",
11438 "groupTitle": "Fax_Transfer_Reports"
11442 "url": "/api/integrations/freshdesk/accounts",
11443 "title": "Creates a new Freshdesk Account",
11446 "title": "Example usage:",
11447 "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",
11451 "name": "CreateFreshdesk_Accounts",
11452 "group": "Freshdesk_Accounts",
11467 "field": "description",
11474 "field": "username",
11488 "field": "remoteUri",
11495 "field": "serverUrl",
11501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11502 "version": "0.0.0",
11503 "filename": "server/api/intFreshdeskAccount/index.js",
11504 "groupTitle": "Freshdesk_Accounts"
11508 "url": "/api/integrations/freshdesk/accounts/{id}",
11509 "title": "Deletes a Freshdesk Account",
11512 "title": "Example usage:",
11513 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11517 "name": "DeleteFreshdesk_Accounts",
11518 "group": "Freshdesk_Accounts",
11519 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11520 "version": "0.0.0",
11521 "filename": "server/api/intFreshdeskAccount/index.js",
11522 "groupTitle": "Freshdesk_Accounts"
11526 "url": "/api/integrations/freshdesk/accounts",
11527 "title": "Gets a list of Freshdesk Accounts",
11530 "title": "Example usage:",
11531 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11535 "name": "GetFreshdesk_Accounts",
11536 "group": "Freshdesk_Accounts",
11537 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11538 "version": "0.0.0",
11539 "filename": "server/api/intFreshdeskAccount/index.js",
11540 "groupTitle": "Freshdesk_Accounts"
11544 "url": "/api/integrations/freshdesk/accounts/{id}",
11545 "title": "Gets a single Freshdesk Account",
11548 "title": "Example usage:",
11549 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11553 "name": "ShowFreshdesk_Accounts",
11554 "group": "Freshdesk_Accounts",
11555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11556 "version": "0.0.0",
11557 "filename": "server/api/intFreshdeskAccount/index.js",
11558 "groupTitle": "Freshdesk_Accounts"
11562 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11563 "title": "Creates new configuration",
11566 "title": "Example usage:",
11567 "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",
11571 "name": "addConfiguration",
11572 "group": "Freshdesk_Accounts",
11573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11574 "version": "0.0.0",
11575 "filename": "server/api/intFreshdeskAccount/index.js",
11576 "groupTitle": "Freshdesk_Accounts"
11580 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11581 "title": "Gets account configurations",
11584 "title": "Example usage:",
11585 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11589 "name": "getConfigurations",
11590 "group": "Freshdesk_Accounts",
11591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11592 "version": "0.0.0",
11593 "filename": "server/api/intFreshdeskAccount/index.js",
11594 "groupTitle": "Freshdesk_Accounts"
11598 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11599 "title": "Gets account fields",
11602 "title": "Example usage:",
11603 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11607 "name": "getFields",
11608 "group": "Freshdesk_Accounts",
11609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11610 "version": "0.0.0",
11611 "filename": "server/api/intFreshdeskAccount/index.js",
11612 "groupTitle": "Freshdesk_Accounts"
11616 "url": "/api/integrations/freshdesk/accounts/{id}",
11617 "title": "Update an existing Freshdesk Account",
11620 "title": "Example usage:",
11621 "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",
11625 "name": "updateFreshdesk_Accounts",
11626 "group": "Freshdesk_Accounts",
11627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11628 "version": "0.0.0",
11629 "filename": "server/api/intFreshdeskAccount/index.js",
11630 "groupTitle": "Freshdesk_Accounts"
11634 "url": "/api/integrations/freshdesk/configurations",
11635 "title": "Creates a new Freshdesk Configuration",
11638 "title": "Example usage:",
11639 "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",
11643 "name": "CreateFreshdesk_Configurations",
11644 "group": "Freshdesk_Configurations",
11659 "field": "description",
11665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11666 "version": "0.0.0",
11667 "filename": "server/api/intFreshdeskConfiguration/index.js",
11668 "groupTitle": "Freshdesk_Configurations"
11672 "url": "/api/integrations/freshdesk/configurations/{id}",
11673 "title": "Deletes a Freshdesk Configuration",
11676 "title": "Example usage:",
11677 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11681 "name": "DeleteFreshdesk_Configurations",
11682 "group": "Freshdesk_Configurations",
11683 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11684 "version": "0.0.0",
11685 "filename": "server/api/intFreshdeskConfiguration/index.js",
11686 "groupTitle": "Freshdesk_Configurations"
11690 "url": "/api/integrations/freshdesk/configurations",
11691 "title": "Gets a list of Freshdesk Configurations",
11694 "title": "Example usage:",
11695 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11699 "name": "GetFreshdesk_Configurations",
11700 "group": "Freshdesk_Configurations",
11701 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11702 "version": "0.0.0",
11703 "filename": "server/api/intFreshdeskConfiguration/index.js",
11704 "groupTitle": "Freshdesk_Configurations"
11708 "url": "/api/integrations/freshdesk/configurations/{id}",
11709 "title": "Gets a single Freshdesk Configuration",
11712 "title": "Example usage:",
11713 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11717 "name": "ShowFreshdesk_Configurations",
11718 "group": "Freshdesk_Configurations",
11719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11720 "version": "0.0.0",
11721 "filename": "server/api/intFreshdeskConfiguration/index.js",
11722 "groupTitle": "Freshdesk_Configurations"
11726 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11727 "title": "Gets configurations descriptions",
11730 "title": "Example usage:",
11731 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11735 "name": "getDescriptions",
11736 "group": "Freshdesk_Configurations",
11737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11738 "version": "0.0.0",
11739 "filename": "server/api/intFreshdeskConfiguration/index.js",
11740 "groupTitle": "Freshdesk_Configurations"
11744 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11745 "title": "Gets configurations fields",
11748 "title": "Example usage:",
11749 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11753 "name": "getFields",
11754 "group": "Freshdesk_Configurations",
11755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11756 "version": "0.0.0",
11757 "filename": "server/api/intFreshdeskConfiguration/index.js",
11758 "groupTitle": "Freshdesk_Configurations"
11762 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11763 "title": "Gets configurations subjects",
11766 "title": "Example usage:",
11767 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11771 "name": "getSubjects",
11772 "group": "Freshdesk_Configurations",
11773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11774 "version": "0.0.0",
11775 "filename": "server/api/intFreshdeskConfiguration/index.js",
11776 "groupTitle": "Freshdesk_Configurations"
11780 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11781 "title": "Gets configurations tags",
11784 "title": "Example usage:",
11785 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11790 "group": "Freshdesk_Configurations",
11791 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11792 "version": "0.0.0",
11793 "filename": "server/api/intFreshdeskConfiguration/index.js",
11794 "groupTitle": "Freshdesk_Configurations"
11798 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11799 "title": "Sets new tags",
11802 "title": "Example usage:",
11803 "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",
11808 "group": "Freshdesk_Configurations",
11809 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11810 "version": "0.0.0",
11811 "filename": "server/api/intFreshdeskConfiguration/index.js",
11812 "groupTitle": "Freshdesk_Configurations"
11816 "url": "/api/integrations/freshdesk/configurations/{id}",
11817 "title": "Update an existing Freshdesk Configuration",
11820 "title": "Example usage:",
11821 "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",
11825 "name": "updateFreshdesk_Configurations",
11826 "group": "Freshdesk_Configurations",
11827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11828 "version": "0.0.0",
11829 "filename": "server/api/intFreshdeskConfiguration/index.js",
11830 "groupTitle": "Freshdesk_Configurations"
11834 "url": "/api/integrations/freshdesk/fields",
11835 "title": "Creates a new Freshdesk Field",
11838 "title": "Example usage:",
11839 "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",
11843 "name": "CreateFreshdesk_Fields",
11844 "group": "Freshdesk_Fields",
11854 "\"customVariable\"",
11865 "field": "content",
11881 "\"customVariable\""
11884 "field": "keyType",
11891 "field": "keyContent",
11898 "field": "idField",
11905 "field": "nameField",
11912 "field": "customField",
11919 "field": "variableName",
11925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11926 "version": "0.0.0",
11927 "filename": "server/api/intFreshdeskField/index.js",
11928 "groupTitle": "Freshdesk_Fields"
11932 "url": "/api/integrations/freshdesk/fields/{id}",
11933 "title": "Deletes a Freshdesk Field",
11936 "title": "Example usage:",
11937 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11941 "name": "DeleteFreshdesk_Fields",
11942 "group": "Freshdesk_Fields",
11943 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11944 "version": "0.0.0",
11945 "filename": "server/api/intFreshdeskField/index.js",
11946 "groupTitle": "Freshdesk_Fields"
11950 "url": "/api/integrations/freshdesk/fields",
11951 "title": "Gets a list of Freshdesk Fields",
11954 "title": "Example usage:",
11955 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11959 "name": "GetFreshdesk_Fields",
11960 "group": "Freshdesk_Fields",
11961 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11962 "version": "0.0.0",
11963 "filename": "server/api/intFreshdeskField/index.js",
11964 "groupTitle": "Freshdesk_Fields"
11968 "url": "/api/integrations/freshdesk/fields/{id}",
11969 "title": "Gets a single Freshdesk Field",
11972 "title": "Example usage:",
11973 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11977 "name": "ShowFreshdesk_Fields",
11978 "group": "Freshdesk_Fields",
11979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11980 "version": "0.0.0",
11981 "filename": "server/api/intFreshdeskField/index.js",
11982 "groupTitle": "Freshdesk_Fields"
11986 "url": "/api/integrations/freshdesk/fields/{id}",
11987 "title": "Update an existing Freshdesk Field",
11990 "title": "Example usage:",
11991 "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",
11995 "name": "updateFreshdesk_Fields",
11996 "group": "Freshdesk_Fields",
11997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11998 "version": "0.0.0",
11999 "filename": "server/api/intFreshdeskField/index.js",
12000 "groupTitle": "Freshdesk_Fields"
12004 "url": "/api/integrations/freshsales/accounts",
12005 "title": "Creates a new Freshsales Account",
12008 "title": "Example usage:",
12009 "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",
12013 "name": "CreateFreshsales_Accounts",
12014 "group": "Freshsales_Accounts",
12029 "field": "description",
12036 "field": "username",
12050 "field": "remoteUri",
12057 "field": "serverUrl",
12063 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12064 "version": "0.0.0",
12065 "filename": "server/api/intFreshsalesAccount/index.js",
12066 "groupTitle": "Freshsales_Accounts"
12070 "url": "/api/integrations/freshsales/accounts/{id}",
12071 "title": "Deletes a Freshsales Account",
12074 "title": "Example usage:",
12075 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12079 "name": "DeleteFreshsales_Accounts",
12080 "group": "Freshsales_Accounts",
12081 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12082 "version": "0.0.0",
12083 "filename": "server/api/intFreshsalesAccount/index.js",
12084 "groupTitle": "Freshsales_Accounts"
12088 "url": "/api/integrations/freshsales/accounts",
12089 "title": "Gets a list of Freshsales Accounts",
12092 "title": "Example usage:",
12093 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12097 "name": "GetFreshsales_Accounts",
12098 "group": "Freshsales_Accounts",
12099 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12100 "version": "0.0.0",
12101 "filename": "server/api/intFreshsalesAccount/index.js",
12102 "groupTitle": "Freshsales_Accounts"
12106 "url": "/api/integrations/freshsales/accounts/{id}",
12107 "title": "Gets a single Freshsales Account",
12110 "title": "Example usage:",
12111 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12115 "name": "ShowFreshsales_Accounts",
12116 "group": "Freshsales_Accounts",
12117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12118 "version": "0.0.0",
12119 "filename": "server/api/intFreshsalesAccount/index.js",
12120 "groupTitle": "Freshsales_Accounts"
12124 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12125 "title": "Creates new configuration",
12128 "title": "Example usage:",
12129 "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",
12133 "name": "addConfiguration",
12134 "group": "Freshsales_Accounts",
12135 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12136 "version": "0.0.0",
12137 "filename": "server/api/intFreshsalesAccount/index.js",
12138 "groupTitle": "Freshsales_Accounts"
12142 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12143 "title": "Gets account configurations",
12146 "title": "Example usage:",
12147 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12151 "name": "getConfigurations",
12152 "group": "Freshsales_Accounts",
12153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12154 "version": "0.0.0",
12155 "filename": "server/api/intFreshsalesAccount/index.js",
12156 "groupTitle": "Freshsales_Accounts"
12160 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12161 "title": "Gets account fields",
12164 "title": "Example usage:",
12165 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12169 "name": "getFields",
12170 "group": "Freshsales_Accounts",
12171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12172 "version": "0.0.0",
12173 "filename": "server/api/intFreshsalesAccount/index.js",
12174 "groupTitle": "Freshsales_Accounts"
12178 "url": "/api/integrations/freshsales/accounts/{id}",
12179 "title": "Update an existing Freshsales Account",
12182 "title": "Example usage:",
12183 "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",
12187 "name": "updateFreshsales_Accounts",
12188 "group": "Freshsales_Accounts",
12189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12190 "version": "0.0.0",
12191 "filename": "server/api/intFreshsalesAccount/index.js",
12192 "groupTitle": "Freshsales_Accounts"
12196 "url": "/api/integrations/freshsales/configurations",
12197 "title": "Creates a new Freshsales Configuration",
12200 "title": "Example usage:",
12201 "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",
12205 "name": "CreateFreshsales_Configurations",
12206 "group": "Freshsales_Configurations",
12221 "field": "description",
12227 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12228 "version": "0.0.0",
12229 "filename": "server/api/intFreshsalesConfiguration/index.js",
12230 "groupTitle": "Freshsales_Configurations"
12234 "url": "/api/integrations/freshsales/configurations/{id}",
12235 "title": "Deletes a Freshsales Configuration",
12238 "title": "Example usage:",
12239 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12243 "name": "DeleteFreshsales_Configurations",
12244 "group": "Freshsales_Configurations",
12245 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intFreshsalesConfiguration/index.js",
12248 "groupTitle": "Freshsales_Configurations"
12252 "url": "/api/integrations/freshsales/configurations",
12253 "title": "Gets a list of Freshsales Configurations",
12256 "title": "Example usage:",
12257 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12261 "name": "GetFreshsales_Configurations",
12262 "group": "Freshsales_Configurations",
12263 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12264 "version": "0.0.0",
12265 "filename": "server/api/intFreshsalesConfiguration/index.js",
12266 "groupTitle": "Freshsales_Configurations"
12270 "url": "/api/integrations/freshsales/configurations/{id}",
12271 "title": "Gets a single Freshsales Configuration",
12274 "title": "Example usage:",
12275 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12279 "name": "ShowFreshsales_Configurations",
12280 "group": "Freshsales_Configurations",
12281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12282 "version": "0.0.0",
12283 "filename": "server/api/intFreshsalesConfiguration/index.js",
12284 "groupTitle": "Freshsales_Configurations"
12288 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12289 "title": "Gets configurations descriptions",
12292 "title": "Example usage:",
12293 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12297 "name": "getDescriptions",
12298 "group": "Freshsales_Configurations",
12299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12300 "version": "0.0.0",
12301 "filename": "server/api/intFreshsalesConfiguration/index.js",
12302 "groupTitle": "Freshsales_Configurations"
12306 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12307 "title": "Gets configurations fields",
12310 "title": "Example usage:",
12311 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12315 "name": "getFields",
12316 "group": "Freshsales_Configurations",
12317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12318 "version": "0.0.0",
12319 "filename": "server/api/intFreshsalesConfiguration/index.js",
12320 "groupTitle": "Freshsales_Configurations"
12324 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12325 "title": "Gets configurations subjects",
12328 "title": "Example usage:",
12329 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12333 "name": "getSubjects",
12334 "group": "Freshsales_Configurations",
12335 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12336 "version": "0.0.0",
12337 "filename": "server/api/intFreshsalesConfiguration/index.js",
12338 "groupTitle": "Freshsales_Configurations"
12342 "url": "/api/integrations/freshsales/configurations/{id}",
12343 "title": "Update an existing Freshsales Configuration",
12346 "title": "Example usage:",
12347 "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",
12351 "name": "updateFreshsales_Configurations",
12352 "group": "Freshsales_Configurations",
12353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12354 "version": "0.0.0",
12355 "filename": "server/api/intFreshsalesConfiguration/index.js",
12356 "groupTitle": "Freshsales_Configurations"
12360 "url": "/api/integrations/freshsales/fields",
12361 "title": "Creates a new Freshsales Field",
12364 "title": "Example usage:",
12365 "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",
12369 "name": "CreateFreshsales_Fields",
12370 "group": "Freshsales_Fields",
12380 "\"customVariable\"",
12391 "field": "content",
12407 "\"customVariable\""
12410 "field": "keyType",
12417 "field": "keyContent",
12424 "field": "idField",
12431 "field": "nameField",
12438 "field": "customField",
12445 "field": "variableName",
12451 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12452 "version": "0.0.0",
12453 "filename": "server/api/intFreshsalesField/index.js",
12454 "groupTitle": "Freshsales_Fields"
12458 "url": "/api/integrations/freshsales/fields/{id}",
12459 "title": "Deletes a Freshsales Field",
12462 "title": "Example usage:",
12463 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12467 "name": "DeleteFreshsales_Fields",
12468 "group": "Freshsales_Fields",
12469 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12470 "version": "0.0.0",
12471 "filename": "server/api/intFreshsalesField/index.js",
12472 "groupTitle": "Freshsales_Fields"
12476 "url": "/api/integrations/freshsales/fields",
12477 "title": "Gets a list of Freshsales Fields",
12480 "title": "Example usage:",
12481 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12485 "name": "GetFreshsales_Fields",
12486 "group": "Freshsales_Fields",
12487 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12488 "version": "0.0.0",
12489 "filename": "server/api/intFreshsalesField/index.js",
12490 "groupTitle": "Freshsales_Fields"
12494 "url": "/api/integrations/freshsales/fields/{id}",
12495 "title": "Gets a single Freshsales Field",
12498 "title": "Example usage:",
12499 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12503 "name": "ShowFreshsales_Fields",
12504 "group": "Freshsales_Fields",
12505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12506 "version": "0.0.0",
12507 "filename": "server/api/intFreshsalesField/index.js",
12508 "groupTitle": "Freshsales_Fields"
12512 "url": "/api/integrations/freshsales/fields/{id}",
12513 "title": "Update an existing Freshsales Field",
12516 "title": "Example usage:",
12517 "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",
12521 "name": "updateFreshsales_Fields",
12522 "group": "Freshsales_Fields",
12523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12524 "version": "0.0.0",
12525 "filename": "server/api/intFreshsalesField/index.js",
12526 "groupTitle": "Freshsales_Fields"
12530 "url": "/api/campaigns/{id}/blacklists",
12531 "title": "Add blacklists to an IVR campaign",
12534 "title": "Example usage:",
12535 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12539 "name": "AddBlackLists",
12540 "group": "IVR_Campaigns",
12541 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542 "version": "0.0.0",
12543 "filename": "server/api/campaign/index.js",
12544 "groupTitle": "IVR_Campaigns"
12548 "url": "/api/campaigns/{id}/lists",
12549 "title": "Add lists to an IVR campaign",
12552 "title": "Example usage:",
12553 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12557 "name": "AddLists",
12558 "group": "IVR_Campaigns",
12559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560 "version": "0.0.0",
12561 "filename": "server/api/campaign/index.js",
12562 "groupTitle": "IVR_Campaigns"
12566 "url": "/api/campaigns/clone",
12567 "title": "Clone an existing IVR Campaign",
12570 "title": "Example usage:",
12571 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12575 "name": "CloneIVR_Campaigns",
12576 "group": "IVR_Campaigns",
12577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578 "version": "0.0.0",
12579 "filename": "server/api/campaign/index.js",
12580 "groupTitle": "IVR_Campaigns"
12584 "url": "/api/campaigns",
12585 "title": "Creates a new IVR Campaign",
12588 "title": "Example usage:",
12589 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12593 "name": "CreateIVR_Campaigns",
12594 "group": "IVR_Campaigns",
12619 "field": "description",
12627 "description": "<p>Active/Disactive Campaign</p>"
12633 "field": "limitCalls",
12634 "description": "<p>Max 200 calls.</p>"
12640 "field": "dialOriginateCallerIdName",
12647 "field": "dialOriginateCallerIdNumber",
12654 "field": "dialOriginateTimeout",
12655 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12661 "field": "dialCongestionMaxRetry",
12662 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12668 "field": "dialCongestionRetryFrequency",
12669 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12675 "field": "dialBusyMaxRetry",
12676 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12682 "field": "dialBusyRetryFrequency",
12683 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12689 "field": "dialNoAnswerMaxRetry",
12690 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12696 "field": "dialNoAnswerRetryFrequency",
12697 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12703 "field": "dialGlobalMaxRetry",
12704 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12710 "field": "dialTimezone",
12717 "field": "dialGlobalInterval",
12729 "field": "dialCheckDuplicateType",
12736 "field": "dialAMDActive",
12737 "description": "<p>Active/Disactive AMD</p>"
12743 "field": "dialAMDInitialSilence",
12744 "description": "<p>#AMD Initial Silence</p>"
12750 "field": "dialAMDGreeting",
12751 "description": "<p>#AMD Greeting</p>"
12757 "field": "dialAMDAfterGreetingSilence",
12758 "description": "<p>#AMD After Greeting Silence</p>"
12764 "field": "dialAMDTotalAnalysisTime",
12765 "description": "<p>#AMD Total Analysis Time</p>"
12771 "field": "dialAMDMinWordLength",
12772 "description": "<p>#AMD Min Word Length</p>"
12778 "field": "dialAMDBetweenWordsSilence",
12779 "description": "<p>#AMD Between Words Silence</p>"
12785 "field": "dialAMDMaximumNumberOfWords",
12786 "description": "<p>#AMD Maximum Number Of Words</p>"
12792 "field": "dialAMDSilenceThreshold",
12793 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12799 "field": "dialAMDMaximumWordLength",
12800 "description": "<p>#AMD Maximum Word Length</p>"
12810 "field": "dialOrderByScheduledAt",
12817 "field": "dialPrefix",
12824 "field": "dialRandomLastDigitCallerIdNumber",
12825 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12831 "field": "dialCutDigit",
12832 "description": "<p>Cut Digit (min:1, max:15)</p>"
12838 "field": "dialNoSuchNumberMaxRetry",
12839 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12845 "field": "dialNoSuchNumberRetryFrequency",
12846 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12852 "field": "dialDropMaxRetry",
12853 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12859 "field": "dialDropRetryFrequency",
12860 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12866 "field": "dialAbandonedMaxRetry",
12867 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12873 "field": "dialAbandonedRetryFrequency",
12874 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12880 "field": "dialMachineMaxRetry",
12881 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12887 "field": "dialMachineRetryFrequency",
12888 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12894 "field": "dialAgentRejectMaxRetry",
12895 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12901 "field": "dialAgentRejectRetryFrequency",
12902 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12907 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12908 "version": "0.0.0",
12909 "filename": "server/api/campaign/index.js",
12910 "groupTitle": "IVR_Campaigns"
12914 "url": "/api/campaigns/{id}",
12915 "title": "Deletes a IVR Campaign",
12918 "title": "Example usage:",
12919 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12923 "name": "DeleteIVR_Campaigns",
12924 "group": "IVR_Campaigns",
12925 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12926 "version": "0.0.0",
12927 "filename": "server/api/campaign/index.js",
12928 "groupTitle": "IVR_Campaigns"
12932 "url": "/api/campaigns/{id}/blacklists",
12933 "title": "Get IVR campaign blacklists",
12936 "title": "Example usage:",
12937 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12941 "name": "GetBlackLists",
12942 "group": "IVR_Campaigns",
12943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12944 "version": "0.0.0",
12945 "filename": "server/api/campaign/index.js",
12946 "groupTitle": "IVR_Campaigns"
12950 "url": "/api/campaigns/{id}/finals",
12951 "title": "Gets IVR campaign hopper finals",
12954 "title": "Example usage:",
12955 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12959 "name": "GetHopperFinals",
12960 "group": "IVR_Campaigns",
12961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12962 "version": "0.0.0",
12963 "filename": "server/api/campaign/index.js",
12964 "groupTitle": "IVR_Campaigns"
12968 "url": "/api/campaigns/{id}/hopper_histories",
12969 "title": "Gets IVR campaign hopper histories",
12972 "title": "Example usage:",
12973 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12977 "name": "GetHopperHistories",
12978 "group": "IVR_Campaigns",
12979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12980 "version": "0.0.0",
12981 "filename": "server/api/campaign/index.js",
12982 "groupTitle": "IVR_Campaigns"
12986 "url": "/api/campaigns/{id}/hoppers",
12987 "title": "Gets IVR campaign hoppers",
12990 "title": "Example usage:",
12991 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12995 "name": "GetHoppers",
12996 "group": "IVR_Campaigns",
12997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12998 "version": "0.0.0",
12999 "filename": "server/api/campaign/index.js",
13000 "groupTitle": "IVR_Campaigns"
13004 "url": "/api/campaigns",
13005 "title": "Gets a list of IVR Campaigns",
13008 "title": "Example usage:",
13009 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13013 "name": "GetIVR_Campaigns",
13014 "group": "IVR_Campaigns",
13015 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13016 "version": "0.0.0",
13017 "filename": "server/api/campaign/index.js",
13018 "groupTitle": "IVR_Campaigns"
13022 "url": "/api/campaigns/{id}/lists",
13023 "title": "Get IVR campaign lists",
13026 "title": "Example usage:",
13027 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13031 "name": "GetLists",
13032 "group": "IVR_Campaigns",
13033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13034 "version": "0.0.0",
13035 "filename": "server/api/campaign/index.js",
13036 "groupTitle": "IVR_Campaigns"
13040 "url": "/api/campaigns/{id}/blacklists",
13041 "title": "Remove blacklists from an IVR Campaign",
13044 "title": "Example usage:",
13045 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13049 "name": "RemoveBlackLists",
13050 "group": "IVR_Campaigns",
13051 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13052 "version": "0.0.0",
13053 "filename": "server/api/campaign/index.js",
13054 "groupTitle": "IVR_Campaigns"
13058 "url": "/api/campaigns/{id}/lists",
13059 "title": "Remove lists from an IVR Campaign",
13062 "title": "Example usage:",
13063 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13067 "name": "RemoveLists",
13068 "group": "IVR_Campaigns",
13069 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13070 "version": "0.0.0",
13071 "filename": "server/api/campaign/index.js",
13072 "groupTitle": "IVR_Campaigns"
13076 "url": "/api/campaigns/{id}",
13077 "title": "Gets a single IVR Campaign",
13080 "title": "Example usage:",
13081 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13085 "name": "ShowIVR_Campaigns",
13086 "group": "IVR_Campaigns",
13087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13088 "version": "0.0.0",
13089 "filename": "server/api/campaign/index.js",
13090 "groupTitle": "IVR_Campaigns"
13094 "url": "/api/campaigns/{id}/blacks",
13095 "title": "Gets IVR campaign hopper blacks",
13098 "title": "Example usage:",
13099 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13103 "name": "getHopperBlacks",
13104 "group": "IVR_Campaigns",
13105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13106 "version": "0.0.0",
13107 "filename": "server/api/campaign/index.js",
13108 "groupTitle": "IVR_Campaigns"
13112 "url": "/api/campaigns/{id}",
13113 "title": "Update an existing IVR Campaign",
13116 "title": "Example usage:",
13117 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13121 "name": "updateIVR_Campaigns",
13122 "group": "IVR_Campaigns",
13123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13124 "version": "0.0.0",
13125 "filename": "server/api/campaign/index.js",
13126 "groupTitle": "IVR_Campaigns"
13130 "url": "/api/integrations/reports",
13131 "title": "Creates a new Integration Report",
13134 "title": "Example usage:",
13135 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13139 "name": "CreateIntegration_Reports",
13140 "group": "Integration_Reports",
13148 "field": "integration",
13155 "field": "eventChannel",
13162 "field": "exitStatus",
13169 "field": "ticketId",
13176 "field": "integrationId",
13183 "field": "contacts",
13190 "field": "uniqueid",
13197 "field": "calleridnum",
13204 "field": "calleridname",
13218 "field": "interface",
13225 "field": "membername",
13232 "field": "agentcalledAt",
13239 "field": "agentconnectAt",
13246 "field": "holdtime",
13253 "field": "agentcomplete",
13260 "field": "agentcompleteAt",
13267 "field": "talktime",
13274 "field": "agentacw",
13281 "field": "acwtime",
13295 "field": "agentringnoanswer",
13302 "field": "agentringnoanswerAt",
13309 "field": "agentdump",
13316 "field": "agentdumpAt",
13323 "field": "lastevent",
13330 "field": "channel",
13337 "field": "channelstate",
13344 "field": "channelstatedesc",
13351 "field": "connectedlinenum",
13358 "field": "connectedlinename",
13365 "field": "language",
13372 "field": "accountcode",
13379 "field": "context",
13393 "field": "priority",
13400 "field": "destchannel",
13407 "field": "destchannelstate",
13414 "field": "destchannelstatedesc",
13421 "field": "destcalleridnum",
13428 "field": "destcalleridname",
13435 "field": "destconnectedlinenum",
13442 "field": "destconnectedlinename",
13449 "field": "destlanguage",
13456 "field": "destaccountcode",
13463 "field": "destcontext",
13470 "field": "destexten",
13477 "field": "destpriority",
13484 "field": "destuniqueid",
13491 "field": "messageId",
13498 "field": "inReplyTo",
13505 "field": "subject",
13533 "field": "attachment",
13581 "field": "appdata",
13588 "field": "projectId",
13594 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13595 "version": "0.0.0",
13596 "filename": "server/api/integrationReport/index.js",
13597 "groupTitle": "Integration_Reports"
13601 "url": "/api/integrations/reports/{id}",
13602 "title": "Deletes a Integration Report",
13605 "title": "Example usage:",
13606 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13610 "name": "DeleteIntegration_Reports",
13611 "group": "Integration_Reports",
13612 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13613 "version": "0.0.0",
13614 "filename": "server/api/integrationReport/index.js",
13615 "groupTitle": "Integration_Reports"
13619 "url": "/api/integrations/reports/describe",
13620 "title": "Gets table info about Integration Reports",
13623 "title": "Example usage:",
13624 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13628 "name": "DescribeIntegration_Reports",
13629 "group": "Integration_Reports",
13630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13631 "version": "0.0.0",
13632 "filename": "server/api/integrationReport/index.js",
13633 "groupTitle": "Integration_Reports"
13637 "url": "/api/integrations/reports",
13638 "title": "Gets a list of Integration Reports",
13641 "title": "Example usage:",
13642 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13646 "name": "GetIntegration_Reports",
13647 "group": "Integration_Reports",
13648 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13649 "version": "0.0.0",
13650 "filename": "server/api/integrationReport/index.js",
13651 "groupTitle": "Integration_Reports"
13655 "url": "/api/integrations/reports/{id}",
13656 "title": "Gets a single Integration Report",
13659 "title": "Example usage:",
13660 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13664 "name": "ShowIntegration_Reports",
13665 "group": "Integration_Reports",
13666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13667 "version": "0.0.0",
13668 "filename": "server/api/integrationReport/index.js",
13669 "groupTitle": "Integration_Reports"
13673 "url": "/api/integrations/reports/{id}",
13674 "title": "Update an existing Integration Report",
13677 "title": "Example usage:",
13678 "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",
13682 "name": "updateIntegration_Reports",
13683 "group": "Integration_Reports",
13684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13685 "version": "0.0.0",
13686 "filename": "server/api/integrationReport/index.js",
13687 "groupTitle": "Integration_Reports"
13691 "url": "/api/intervals",
13692 "title": "Creates a new Interval",
13695 "title": "Example usage:",
13696 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13700 "name": "CreateIntervals",
13701 "group": "Intervals",
13716 "field": "description",
13723 "field": "interval",
13729 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13730 "version": "0.0.0",
13731 "filename": "server/api/interval/index.js",
13732 "groupTitle": "Intervals"
13736 "url": "/api/intervals/{id}",
13737 "title": "Deletes a Interval",
13740 "title": "Example usage:",
13741 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13745 "name": "DeleteIntervals",
13746 "group": "Intervals",
13747 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13748 "version": "0.0.0",
13749 "filename": "server/api/interval/index.js",
13750 "groupTitle": "Intervals"
13754 "url": "/api/intervals",
13755 "title": "Gets a list of Intervals",
13758 "title": "Example usage:",
13759 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13763 "name": "GetIntervals",
13764 "group": "Intervals",
13765 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13766 "version": "0.0.0",
13767 "filename": "server/api/interval/index.js",
13768 "groupTitle": "Intervals"
13772 "url": "/api/intervals/{id}",
13773 "title": "Gets a single Interval",
13776 "title": "Example usage:",
13777 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13781 "name": "ShowIntervals",
13782 "group": "Intervals",
13783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13784 "version": "0.0.0",
13785 "filename": "server/api/interval/index.js",
13786 "groupTitle": "Intervals"
13790 "url": "/api/intervals/{id}/sub_intervals",
13791 "title": "Creates a new sub interval",
13794 "title": "Example usage:",
13795 "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",
13799 "name": "addInterval",
13800 "group": "Intervals",
13801 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13802 "version": "0.0.0",
13803 "filename": "server/api/interval/index.js",
13804 "groupTitle": "Intervals"
13808 "url": "/api/intervals/{id}/sub_intervals/create_many",
13809 "title": "Create new sub intervals set",
13812 "title": "Example usage:",
13813 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13817 "name": "addIntervals",
13818 "group": "Intervals",
13819 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13820 "version": "0.0.0",
13821 "filename": "server/api/interval/index.js",
13822 "groupTitle": "Intervals"
13826 "url": "/api/intervals/{id}/sub_intervals",
13827 "title": "Get sub intervals set",
13830 "title": "Example usage:",
13831 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13835 "name": "getIntervals",
13836 "group": "Intervals",
13837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13838 "version": "0.0.0",
13839 "filename": "server/api/interval/index.js",
13840 "groupTitle": "Intervals"
13844 "url": "/api/intervals/{id}",
13845 "title": "Update an existing Interval",
13848 "title": "Example usage:",
13849 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13853 "name": "updateIntervals",
13854 "group": "Intervals",
13855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13856 "version": "0.0.0",
13857 "filename": "server/api/interval/index.js",
13858 "groupTitle": "Intervals"
13862 "url": "/api/jira",
13863 "title": "Creates a new issue",
13866 "title": "Example usage:",
13867 "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}",
13871 "name": "Creates_Issue",
13883 "field": "issuetype",
13890 "field": "summary",
13897 "field": "description",
13903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13904 "version": "0.0.0",
13905 "filename": "server/api/jira/index.js",
13906 "groupTitle": "Issue"
13910 "url": "/api/jscripty/answers/reports",
13911 "title": "Creates a new Report",
13914 "title": "Example usage:",
13915 "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",
13919 "name": "CreateReports",
13920 "group": "JscriptyAnswerReport",
13928 "field": "question",
13942 "field": "membername",
13949 "field": "projectname",
13963 "field": "uniqueid",
13970 "field": "calleridname",
13977 "field": "calleridnum",
13984 "field": "questionId",
13990 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13991 "version": "0.0.0",
13992 "filename": "server/api/jscriptyAnswerReport/index.js",
13993 "groupTitle": "JscriptyAnswerReport"
13997 "url": "/api/jscripty/answers/reports/{id}",
13998 "title": "Deletes a Report",
14001 "title": "Example usage:",
14002 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14006 "name": "DeleteReports",
14007 "group": "JscriptyAnswerReport",
14008 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14009 "version": "0.0.0",
14010 "filename": "server/api/jscriptyAnswerReport/index.js",
14011 "groupTitle": "JscriptyAnswerReport"
14015 "url": "/api/jscripty/answers/reports/describe",
14016 "title": "Gets table info about Reports",
14019 "title": "Example usage:",
14020 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14024 "name": "DescribeReports",
14025 "group": "JscriptyAnswerReport",
14026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14027 "version": "0.0.0",
14028 "filename": "server/api/jscriptyAnswerReport/index.js",
14029 "groupTitle": "JscriptyAnswerReport"
14033 "url": "/api/jscripty/answers/reports",
14034 "title": "Gets a list of Reports",
14037 "title": "Example usage:",
14038 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14042 "name": "GetReports",
14043 "group": "JscriptyAnswerReport",
14044 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14045 "version": "0.0.0",
14046 "filename": "server/api/jscriptyAnswerReport/index.js",
14047 "groupTitle": "JscriptyAnswerReport"
14051 "url": "/api/jscripty/answers/reports/{id}",
14052 "title": "Gets a single Report",
14055 "title": "Example usage:",
14056 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14060 "name": "ShowReports",
14061 "group": "JscriptyAnswerReport",
14062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14063 "version": "0.0.0",
14064 "filename": "server/api/jscriptyAnswerReport/index.js",
14065 "groupTitle": "JscriptyAnswerReport"
14069 "url": "/api/jscripty/answers/reports/{id}",
14070 "title": "Update an existing Report",
14073 "title": "Example usage:",
14074 "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",
14078 "name": "updateReports",
14079 "group": "JscriptyAnswerReport",
14080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14081 "version": "0.0.0",
14082 "filename": "server/api/jscriptyAnswerReport/index.js",
14083 "groupTitle": "JscriptyAnswerReport"
14087 "url": "/api/jscripty/questions/reports",
14088 "title": "Creates a new Report",
14091 "title": "Example usage:",
14092 "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",
14096 "name": "CreateReports",
14097 "group": "JscriptyQuestionReport",
14105 "field": "question",
14119 "field": "membername",
14126 "field": "projectname",
14140 "field": "uniqueid",
14147 "field": "calleridname",
14154 "field": "calleridnum",
14161 "field": "questionId",
14167 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14168 "version": "0.0.0",
14169 "filename": "server/api/jscriptyQuestionReport/index.js",
14170 "groupTitle": "JscriptyQuestionReport"
14174 "url": "/api/jscripty/questions/reports/{id}",
14175 "title": "Deletes a Report",
14178 "title": "Example usage:",
14179 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14183 "name": "DeleteReports",
14184 "group": "JscriptyQuestionReport",
14185 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14186 "version": "0.0.0",
14187 "filename": "server/api/jscriptyQuestionReport/index.js",
14188 "groupTitle": "JscriptyQuestionReport"
14192 "url": "/api/jscripty/questions/reports/describe",
14193 "title": "Gets table info about Reports",
14196 "title": "Example usage:",
14197 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14201 "name": "DescribeReports",
14202 "group": "JscriptyQuestionReport",
14203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14204 "version": "0.0.0",
14205 "filename": "server/api/jscriptyQuestionReport/index.js",
14206 "groupTitle": "JscriptyQuestionReport"
14210 "url": "/api/jscripty/questions/reports",
14211 "title": "Gets a list of Reports",
14214 "title": "Example usage:",
14215 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14219 "name": "GetReports",
14220 "group": "JscriptyQuestionReport",
14221 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14222 "version": "0.0.0",
14223 "filename": "server/api/jscriptyQuestionReport/index.js",
14224 "groupTitle": "JscriptyQuestionReport"
14228 "url": "/api/jscripty/questions/reports/{id}",
14229 "title": "Gets a single Report",
14232 "title": "Example usage:",
14233 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14237 "name": "ShowReports",
14238 "group": "JscriptyQuestionReport",
14239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14240 "version": "0.0.0",
14241 "filename": "server/api/jscriptyQuestionReport/index.js",
14242 "groupTitle": "JscriptyQuestionReport"
14246 "url": "/api/jscripty/questions/reports/{id}",
14247 "title": "Update an existing Report",
14250 "title": "Example usage:",
14251 "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",
14255 "name": "updateReports",
14256 "group": "JscriptyQuestionReport",
14257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14258 "version": "0.0.0",
14259 "filename": "server/api/jscriptyQuestionReport/index.js",
14260 "groupTitle": "JscriptyQuestionReport"
14264 "url": "/api/jscripty/sessions/reports",
14265 "title": "Creates a new Report",
14268 "title": "Example usage:",
14269 "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",
14273 "name": "CreateReports",
14274 "group": "JscriptySessionReport",
14282 "field": "starttime",
14289 "field": "endtime",
14296 "field": "membername",
14303 "field": "projectname",
14317 "field": "uniqueid",
14324 "field": "calleridname",
14331 "field": "calleridnum",
14338 "field": "completed",
14344 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14345 "version": "0.0.0",
14346 "filename": "server/api/jscriptySessionReport/index.js",
14347 "groupTitle": "JscriptySessionReport"
14351 "url": "/api/jscripty/sessions/reports/{id}",
14352 "title": "Deletes a Report",
14355 "title": "Example usage:",
14356 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14360 "name": "DeleteReports",
14361 "group": "JscriptySessionReport",
14362 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14363 "version": "0.0.0",
14364 "filename": "server/api/jscriptySessionReport/index.js",
14365 "groupTitle": "JscriptySessionReport"
14369 "url": "/api/jscripty/sessions/reports/describe",
14370 "title": "Gets table info about Reports",
14373 "title": "Example usage:",
14374 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14378 "name": "DescribeReports",
14379 "group": "JscriptySessionReport",
14380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14381 "version": "0.0.0",
14382 "filename": "server/api/jscriptySessionReport/index.js",
14383 "groupTitle": "JscriptySessionReport"
14387 "url": "/api/jscripty/sessions/reports",
14388 "title": "Gets a list of Reports",
14391 "title": "Example usage:",
14392 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14396 "name": "GetReports",
14397 "group": "JscriptySessionReport",
14398 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14399 "version": "0.0.0",
14400 "filename": "server/api/jscriptySessionReport/index.js",
14401 "groupTitle": "JscriptySessionReport"
14405 "url": "/api/jscripty/sessions/reports/{id}",
14406 "title": "Gets a single Report",
14409 "title": "Example usage:",
14410 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14414 "name": "ShowReports",
14415 "group": "JscriptySessionReport",
14416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14417 "version": "0.0.0",
14418 "filename": "server/api/jscriptySessionReport/index.js",
14419 "groupTitle": "JscriptySessionReport"
14423 "url": "/api/jscripty/sessions/reports/{id}/questions",
14424 "title": "Gets Jscripty Session questions",
14427 "title": "Example usage:",
14428 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14432 "name": "getQuestions",
14433 "group": "JscriptySessionReport",
14434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14435 "version": "0.0.0",
14436 "filename": "server/api/jscriptySessionReport/index.js",
14437 "groupTitle": "JscriptySessionReport"
14441 "url": "/api/jscripty/sessions/reports/{id}",
14442 "title": "Update an existing Report",
14445 "title": "Example usage:",
14446 "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",
14450 "name": "updateReports",
14451 "group": "JscriptySessionReport",
14452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453 "version": "0.0.0",
14454 "filename": "server/api/jscriptySessionReport/index.js",
14455 "groupTitle": "JscriptySessionReport"
14459 "url": "/api/jscripty/projects/clone",
14460 "title": "Clone an existing Project",
14463 "title": "Example usage:",
14464 "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",
14468 "name": "CloneProjects",
14469 "group": "Jscripty_Projects",
14470 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471 "version": "0.0.0",
14472 "filename": "server/api/jscriptyProject/index.js",
14473 "groupTitle": "Jscripty_Projects"
14477 "url": "/api/jscripty/projects",
14478 "title": "Creates a new Project",
14481 "title": "Example usage:",
14482 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14486 "name": "CreateProjects",
14487 "group": "Jscripty_Projects",
14502 "field": "description",
14509 "field": "formData",
14516 "field": "enableUncompleteSave",
14523 "field": "sendUnpauseOnSubmit",
14529 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14530 "version": "0.0.0",
14531 "filename": "server/api/jscriptyProject/index.js",
14532 "groupTitle": "Jscripty_Projects"
14536 "url": "/api/jscripty/projects/{id}",
14537 "title": "Deletes a Project",
14540 "title": "Example usage:",
14541 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14545 "name": "DeleteProjects",
14546 "group": "Jscripty_Projects",
14547 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14548 "version": "0.0.0",
14549 "filename": "server/api/jscriptyProject/index.js",
14550 "groupTitle": "Jscripty_Projects"
14554 "url": "/api/jscripty/projects",
14555 "title": "Gets a list of Projects",
14558 "title": "Example usage:",
14559 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14563 "name": "GetProjects",
14564 "group": "Jscripty_Projects",
14565 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14566 "version": "0.0.0",
14567 "filename": "server/api/jscriptyProject/index.js",
14568 "groupTitle": "Jscripty_Projects"
14572 "url": "/api/jscripty/projects/{id}",
14573 "title": "Gets a single Project",
14576 "title": "Example usage:",
14577 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14581 "name": "ShowProjects",
14582 "group": "Jscripty_Projects",
14583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14584 "version": "0.0.0",
14585 "filename": "server/api/jscriptyProject/index.js",
14586 "groupTitle": "Jscripty_Projects"
14590 "url": "/api/jscripty/projects/{id}/answers",
14591 "title": "Gets jscripty project answers",
14594 "title": "Example usage:",
14595 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14599 "name": "getAnswers",
14600 "group": "Jscripty_Projects",
14601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14602 "version": "0.0.0",
14603 "filename": "server/api/jscriptyProject/index.js",
14604 "groupTitle": "Jscripty_Projects"
14608 "url": "/api/jscripty/projects/{id}/sessions",
14609 "title": "Gets jscripty project sessions",
14612 "title": "Example usage:",
14613 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14617 "name": "getSessions",
14618 "group": "Jscripty_Projects",
14619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14620 "version": "0.0.0",
14621 "filename": "server/api/jscriptyProject/index.js",
14622 "groupTitle": "Jscripty_Projects"
14626 "url": "/api/jscripty/projects/{id}/summary",
14627 "title": "Gets jscripty project summary",
14630 "title": "Example usage:",
14631 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14635 "name": "getSummary",
14636 "group": "Jscripty_Projects",
14637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14638 "version": "0.0.0",
14639 "filename": "server/api/jscriptyProject/index.js",
14640 "groupTitle": "Jscripty_Projects"
14644 "url": "/api/jscripty/projects/{id}",
14645 "title": "Update an existing Project",
14648 "title": "Example usage:",
14649 "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",
14653 "name": "updateProjects",
14654 "group": "Jscripty_Projects",
14655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14656 "version": "0.0.0",
14657 "filename": "server/api/jscriptyProject/index.js",
14658 "groupTitle": "Jscripty_Projects"
14662 "url": "/api/license",
14663 "title": "Gets License Info",
14666 "title": "Example usage:",
14667 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14672 "group": "License",
14673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14674 "version": "0.0.0",
14675 "filename": "server/api/license/index.js",
14676 "groupTitle": "License"
14680 "url": "/api/license/{id}",
14681 "title": "Update License Info",
14684 "title": "Example usage:",
14685 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14690 "group": "License",
14691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14692 "version": "0.0.0",
14693 "filename": "server/api/license/index.js",
14694 "groupTitle": "License"
14698 "url": "/api/mail/accounts/{id}/users",
14699 "title": "Add agents to a mail account",
14702 "title": "Example usage:",
14703 "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",
14707 "name": "AddAgents",
14708 "group": "Mail_Accounts",
14709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710 "version": "0.0.0",
14711 "filename": "server/api/mailAccount/index.js",
14712 "groupTitle": "Mail_Accounts"
14716 "url": "/api/mail/accounts/{id}/in_servers",
14717 "title": "Creates a new IMAP server",
14720 "title": "Example usage:",
14721 "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",
14726 "group": "Mail_Accounts",
14734 "field": "description",
14748 "field": "authentication",
14762 "field": "password",
14783 "field": "mailbox",
14790 "field": "connTimeout",
14797 "field": "authTimeout",
14804 "field": "service",
14810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14811 "version": "0.0.0",
14812 "filename": "server/api/mailAccount/index.js",
14813 "groupTitle": "Mail_Accounts"
14817 "url": "/api/mail/accounts/{id}/out_servers",
14818 "title": "Creates a new SMTP server",
14821 "title": "Example usage:",
14822 "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",
14827 "group": "Mail_Accounts",
14835 "field": "description",
14877 "field": "service",
14884 "field": "authentication",
14890 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14891 "version": "0.0.0",
14892 "filename": "server/api/mailAccount/index.js",
14893 "groupTitle": "Mail_Accounts"
14897 "url": "/api/mail/accounts/{id}",
14898 "title": "Deletes a mail account",
14901 "title": "Example usage:",
14902 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14906 "name": "DeleteMailAccounts",
14907 "group": "Mail_Accounts",
14908 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14909 "version": "0.0.0",
14910 "filename": "server/api/mailAccount/index.js",
14911 "groupTitle": "Mail_Accounts"
14915 "url": "/api/mail/accounts/describe",
14916 "title": "Gets table info about Accounts",
14919 "title": "Example usage:",
14920 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14924 "name": "DescribeAccounts",
14925 "group": "Mail_Accounts",
14926 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14927 "version": "0.0.0",
14928 "filename": "server/api/mailAccount/index.js",
14929 "groupTitle": "Mail_Accounts"
14933 "url": "/api/mail/accounts",
14934 "title": "Gets a list of Accounts",
14937 "title": "Example usage:",
14938 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14942 "name": "GetAccounts",
14943 "group": "Mail_Accounts",
14944 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14945 "version": "0.0.0",
14946 "filename": "server/api/mailAccount/index.js",
14947 "groupTitle": "Mail_Accounts"
14951 "url": "/api/mail/accounts/{id}/users",
14952 "title": "Gets agents from mail account",
14955 "title": "Example usage:",
14956 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14960 "name": "GetAgents",
14961 "group": "Mail_Accounts",
14962 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14963 "version": "0.0.0",
14964 "filename": "server/api/mailAccount/index.js",
14965 "groupTitle": "Mail_Accounts"
14969 "url": "/api/mail/accounts/{id}/in_servers",
14970 "title": "Gets account IMAP server",
14973 "title": "Example usage:",
14974 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14979 "group": "Mail_Accounts",
14980 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14981 "version": "0.0.0",
14982 "filename": "server/api/mailAccount/index.js",
14983 "groupTitle": "Mail_Accounts"
14987 "url": "/api/mail/accounts/{id}/out_servers",
14988 "title": "Gets account SMTP server",
14991 "title": "Example usage:",
14992 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14997 "group": "Mail_Accounts",
14998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14999 "version": "0.0.0",
15000 "filename": "server/api/mailAccount/index.js",
15001 "groupTitle": "Mail_Accounts"
15005 "url": "/api/mail/accounts/{id}/users",
15006 "title": "Removes agents from a mail account",
15009 "title": "Example usage:",
15010 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15014 "name": "RemoveAgents",
15015 "group": "Mail_Accounts",
15016 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15017 "version": "0.0.0",
15018 "filename": "server/api/mailAccount/index.js",
15019 "groupTitle": "Mail_Accounts"
15023 "url": "/api/mail/accounts/{id}/canned_answers",
15024 "title": "Removes canned answers from account",
15027 "title": "Example usage:",
15028 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15032 "name": "RemoveAnswers",
15033 "group": "Mail_Accounts",
15034 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15035 "version": "0.0.0",
15036 "filename": "server/api/mailAccount/index.js",
15037 "groupTitle": "Mail_Accounts"
15041 "url": "/api/mail/accounts/{id}/dispositions",
15042 "title": "Removes dispositions from account",
15045 "title": "Example usage:",
15046 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15050 "name": "RemoveDispositions",
15051 "group": "Mail_Accounts",
15052 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15053 "version": "0.0.0",
15054 "filename": "server/api/mailAccount/index.js",
15055 "groupTitle": "Mail_Accounts"
15059 "url": "/api/mail/accounts/{id}/in_servers",
15060 "title": "Removes IMAP server from an account",
15063 "title": "Example usage:",
15064 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15068 "name": "RemoveImmap",
15069 "group": "Mail_Accounts",
15070 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15071 "version": "0.0.0",
15072 "filename": "server/api/mailAccount/index.js",
15073 "groupTitle": "Mail_Accounts"
15077 "url": "/api/mail/accounts/{id}/out_servers",
15078 "title": "Removes SMTP server from an account",
15081 "title": "Example usage:",
15082 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15086 "name": "RemoveSmtp",
15087 "group": "Mail_Accounts",
15088 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15089 "version": "0.0.0",
15090 "filename": "server/api/mailAccount/index.js",
15091 "groupTitle": "Mail_Accounts"
15095 "url": "/api/mail/accounts/{id}",
15096 "title": "Gets a single Account",
15099 "title": "Example usage:",
15100 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15104 "name": "ShowAccounts",
15105 "group": "Mail_Accounts",
15106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15107 "version": "0.0.0",
15108 "filename": "server/api/mailAccount/index.js",
15109 "groupTitle": "Mail_Accounts"
15113 "url": "/api/mail/accounts/{id}/canned_answers",
15114 "title": "Creates new canned answer",
15117 "title": "Example usage:",
15118 "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",
15122 "name": "addAnswer",
15123 "group": "Mail_Accounts",
15145 "field": "description",
15158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15159 "version": "0.0.0",
15160 "filename": "server/api/mailAccount/index.js",
15161 "groupTitle": "Mail_Accounts"
15165 "url": "/api/mail/accounts/{id}/applications",
15166 "title": "Creates new applications",
15169 "title": "Example usage:",
15170 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15174 "name": "addApplications",
15175 "group": "Mail_Accounts",
15183 "field": "priority",
15197 "field": "appdata",
15204 "field": "description",
15211 "field": "interval",
15217 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15218 "version": "0.0.0",
15219 "filename": "server/api/mailAccount/index.js",
15220 "groupTitle": "Mail_Accounts"
15224 "url": "/api/mail/accounts/{id}/dispositions",
15225 "title": "Creates new disposition",
15228 "title": "Example usage:",
15229 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15233 "name": "addDisposition",
15234 "group": "Mail_Accounts",
15261 "field": "description",
15267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15268 "version": "0.0.0",
15269 "filename": "server/api/mailAccount/index.js",
15270 "groupTitle": "Mail_Accounts"
15274 "url": "/api/mail/accounts/{id}/interactions",
15275 "title": "Creates new interactions",
15278 "title": "Example usage:",
15279 "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",
15283 "name": "addInteraction",
15284 "group": "Mail_Accounts",
15299 "field": "closedAt",
15306 "field": "disposition",
15313 "field": "secondDisposition",
15320 "field": "thirdDisposition",
15334 "field": "inReplyTo",
15355 "field": "subject",
15369 "field": "read1stAt",
15376 "field": "substatus",
15383 "field": "substatusAt",
15394 "field": "firstMsgDirection",
15401 "field": "lastMsgAt",
15412 "field": "lastMsgDirection",
15419 "field": "lastMsgBody",
15426 "field": "lastMsgText",
15432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15433 "version": "0.0.0",
15434 "filename": "server/api/mailAccount/index.js",
15435 "groupTitle": "Mail_Accounts"
15439 "url": "/api/mail/accounts",
15440 "title": "Create a mail account",
15443 "title": "Example usage:",
15444 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15449 "group": "Mail_Accounts",
15450 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15451 "version": "0.0.0",
15452 "filename": "server/api/mailAccount/index.js",
15453 "groupTitle": "Mail_Accounts"
15457 "url": "/api/mail/accounts/{id}/canned_answers",
15458 "title": "Gets account canned answers",
15461 "title": "Example usage:",
15462 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15466 "name": "getAnswers",
15467 "group": "Mail_Accounts",
15468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15469 "version": "0.0.0",
15470 "filename": "server/api/mailAccount/index.js",
15471 "groupTitle": "Mail_Accounts"
15475 "url": "/api/mail/accounts/{id}/applications",
15476 "title": "Gets account applications",
15479 "title": "Example usage:",
15480 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15484 "name": "getApplications",
15485 "group": "Mail_Accounts",
15486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15487 "version": "0.0.0",
15488 "filename": "server/api/mailAccount/index.js",
15489 "groupTitle": "Mail_Accounts"
15493 "url": "/api/mail/accounts/{id}/dispositions",
15494 "title": "Gets account dispositions",
15497 "title": "Example usage:",
15498 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15502 "name": "getDispositions",
15503 "group": "Mail_Accounts",
15504 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15505 "version": "0.0.0",
15506 "filename": "server/api/mailAccount/index.js",
15507 "groupTitle": "Mail_Accounts"
15511 "url": "/api/mail/accounts/{id}/interactions",
15512 "title": "Gets account interactions",
15515 "title": "Example usage:",
15516 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15520 "name": "getInteraction",
15521 "group": "Mail_Accounts",
15522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15523 "version": "0.0.0",
15524 "filename": "server/api/mailAccount/index.js",
15525 "groupTitle": "Mail_Accounts"
15529 "url": "/api/mail/accounts/{id}/messages",
15530 "title": "Gets account messages",
15533 "title": "Example usage:",
15534 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15538 "name": "getMessages",
15539 "group": "Mail_Accounts",
15540 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15541 "version": "0.0.0",
15542 "filename": "server/api/mailAccount/index.js",
15543 "groupTitle": "Mail_Accounts"
15547 "url": "/api/mail/accounts/{id}/send",
15548 "title": "Send new mail",
15551 "title": "Example usage:",
15552 "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",
15556 "name": "sendMail",
15557 "group": "Mail_Accounts",
15558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15559 "version": "0.0.0",
15560 "filename": "server/api/mailAccount/index.js",
15561 "groupTitle": "Mail_Accounts"
15565 "url": "/api/mail/accounts/{id}",
15566 "title": "Update an existing Account",
15569 "title": "Example usage:",
15570 "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",
15574 "name": "updateAccounts",
15575 "group": "Mail_Accounts",
15576 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15577 "version": "0.0.0",
15578 "filename": "server/api/mailAccount/index.js",
15579 "groupTitle": "Mail_Accounts"
15583 "url": "/api/mail/accounts/{id}/verify",
15584 "title": "Verify mail account",
15587 "title": "Example usage:",
15588 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15592 "name": "verifySmtp",
15593 "group": "Mail_Accounts",
15594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15595 "version": "0.0.0",
15596 "filename": "server/api/mailAccount/index.js",
15597 "groupTitle": "Mail_Accounts"
15601 "url": "/api/mail/applications/{id}",
15602 "title": "Deletes a Application",
15605 "title": "Example usage:",
15606 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15610 "name": "DeleteApplications",
15611 "group": "Mail_Applications",
15612 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15613 "version": "0.0.0",
15614 "filename": "server/api/mailApplication/index.js",
15615 "groupTitle": "Mail_Applications"
15619 "url": "/api/mail/applications/{id}",
15620 "title": "Gets a single Application",
15623 "title": "Example usage:",
15624 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15628 "name": "ShowApplications",
15629 "group": "Mail_Applications",
15630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15631 "version": "0.0.0",
15632 "filename": "server/api/mailApplication/index.js",
15633 "groupTitle": "Mail_Applications"
15637 "url": "/api/mail/applications/{id}",
15638 "title": "Update an existing Application",
15641 "title": "Example usage:",
15642 "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",
15646 "name": "updateApplications",
15647 "group": "Mail_Applications",
15648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15649 "version": "0.0.0",
15650 "filename": "server/api/mailApplication/index.js",
15651 "groupTitle": "Mail_Applications"
15655 "url": "/api/mail/interactions/{id}/tags",
15656 "title": "Add tags to the interaction",
15659 "title": "Example usage:",
15660 "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",
15665 "group": "Mail_Interactions",
15666 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667 "version": "0.0.0",
15668 "filename": "server/api/mailInteraction/index.js",
15669 "groupTitle": "Mail_Interactions"
15673 "url": "/api/mail/interactions",
15674 "title": "Creates a new Interaction",
15677 "title": "Example usage:",
15678 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15682 "name": "CreateInteractions",
15683 "group": "Mail_Interactions",
15698 "field": "closedAt",
15705 "field": "disposition",
15712 "field": "secondDisposition",
15719 "field": "thirdDisposition",
15733 "field": "inReplyTo",
15754 "field": "subject",
15768 "field": "read1stAt",
15775 "field": "substatus",
15782 "field": "substatusAt",
15793 "field": "firstMsgDirection",
15800 "field": "lastMsgAt",
15811 "field": "lastMsgDirection",
15818 "field": "lastMsgBody",
15825 "field": "lastMsgText",
15831 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15832 "version": "0.0.0",
15833 "filename": "server/api/mailInteraction/index.js",
15834 "groupTitle": "Mail_Interactions"
15838 "url": "/api/mail/interactions/{id}",
15839 "title": "Deletes a Interaction",
15842 "title": "Example usage:",
15843 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15847 "name": "DeleteInteractions",
15848 "group": "Mail_Interactions",
15849 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15850 "version": "0.0.0",
15851 "filename": "server/api/mailInteraction/index.js",
15852 "groupTitle": "Mail_Interactions"
15856 "url": "/api/mail/interactions/describe",
15857 "title": "Gets table info about Interactions",
15860 "title": "Example usage:",
15861 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15865 "name": "DescribeInteractions",
15866 "group": "Mail_Interactions",
15867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15868 "version": "0.0.0",
15869 "filename": "server/api/mailInteraction/index.js",
15870 "groupTitle": "Mail_Interactions"
15874 "url": "/api/mail/interactions",
15875 "title": "Gets a list of Interactions",
15878 "title": "Example usage:",
15879 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15883 "name": "GetInteractions",
15884 "group": "Mail_Interactions",
15885 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15886 "version": "0.0.0",
15887 "filename": "server/api/mailInteraction/index.js",
15888 "groupTitle": "Mail_Interactions"
15892 "url": "/api/mail/interactions/{id}/tags",
15893 "title": "Removes tags from interaction",
15896 "title": "Example usage:",
15897 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15901 "name": "RemoveTags",
15902 "group": "Mail_Interactions",
15903 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15904 "version": "0.0.0",
15905 "filename": "server/api/mailInteraction/index.js",
15906 "groupTitle": "Mail_Interactions"
15910 "url": "/api/mail/interactions/{id}",
15911 "title": "Gets a single Interaction",
15914 "title": "Example usage:",
15915 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15919 "name": "ShowInteractions",
15920 "group": "Mail_Interactions",
15921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15922 "version": "0.0.0",
15923 "filename": "server/api/mailInteraction/index.js",
15924 "groupTitle": "Mail_Interactions"
15928 "url": "/api/mail/interactions/{id}/messages",
15929 "title": "Creates new message",
15932 "title": "Example usage:",
15933 "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",
15937 "name": "addMessage",
15938 "group": "Mail_Interactions",
15953 "field": "plainBody",
15971 "field": "direction",
15978 "field": "messageId",
16013 "field": "subject",
16048 "field": "originTo",
16055 "field": "originCc",
16061 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16062 "version": "0.0.0",
16063 "filename": "server/api/mailInteraction/index.js",
16064 "groupTitle": "Mail_Interactions"
16068 "url": "/api/mail/interactions/{id}/download",
16069 "title": "Gets interaction",
16072 "title": "Example usage:",
16073 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16077 "name": "download",
16078 "group": "Mail_Interactions",
16079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16080 "version": "0.0.0",
16081 "filename": "server/api/mailInteraction/index.js",
16082 "groupTitle": "Mail_Interactions"
16086 "url": "/api/mail/interactions/{id}/messages",
16087 "title": "Gets interaction messages",
16090 "title": "Example usage:",
16091 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16095 "name": "getMessages",
16096 "group": "Mail_Interactions",
16097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16098 "version": "0.0.0",
16099 "filename": "server/api/mailInteraction/index.js",
16100 "groupTitle": "Mail_Interactions"
16104 "url": "/api/mail/interactions/{id}",
16105 "title": "Update an existing Interaction",
16108 "title": "Example usage:",
16109 "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",
16113 "name": "updateInteractions",
16114 "group": "Mail_Interactions",
16115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16116 "version": "0.0.0",
16117 "filename": "server/api/mailInteraction/index.js",
16118 "groupTitle": "Mail_Interactions"
16122 "url": "/api/mail/messages/{id}",
16123 "title": "Deletes a Message",
16126 "title": "Example usage:",
16127 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16131 "name": "DeleteMessages",
16132 "group": "Mail_Messages",
16133 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16134 "version": "0.0.0",
16135 "filename": "server/api/mailMessage/index.js",
16136 "groupTitle": "Mail_Messages"
16140 "url": "/api/mail/messages/describe",
16141 "title": "Gets table info about Messages",
16144 "title": "Example usage:",
16145 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16149 "name": "DescribeMessages",
16150 "group": "Mail_Messages",
16151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16152 "version": "0.0.0",
16153 "filename": "server/api/mailMessage/index.js",
16154 "groupTitle": "Mail_Messages"
16158 "url": "/api/mail/messages",
16159 "title": "Gets a list of Messages",
16162 "title": "Example usage:",
16163 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16167 "name": "GetMessages",
16168 "group": "Mail_Messages",
16169 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16170 "version": "0.0.0",
16171 "filename": "server/api/mailMessage/index.js",
16172 "groupTitle": "Mail_Messages"
16176 "url": "/api/mail/messages/{id}",
16177 "title": "Gets a single Message",
16180 "title": "Example usage:",
16181 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16185 "name": "ShowMessages",
16186 "group": "Mail_Messages",
16187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16188 "version": "0.0.0",
16189 "filename": "server/api/mailMessage/index.js",
16190 "groupTitle": "Mail_Messages"
16194 "url": "/api/mail/messages/{id}/accept",
16195 "title": "Accepts message",
16198 "title": "Example usage:",
16199 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16203 "name": "acceptMessage",
16204 "group": "Mail_Messages",
16205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16206 "version": "0.0.0",
16207 "filename": "server/api/mailMessage/index.js",
16208 "groupTitle": "Mail_Messages"
16212 "url": "/api/mail/messages",
16213 "title": "Create a message",
16216 "title": "Example usage:",
16217 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16221 "name": "createMessage",
16222 "group": "Mail_Messages",
16223 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16224 "version": "0.0.0",
16225 "filename": "server/api/mailMessage/index.js",
16226 "groupTitle": "Mail_Messages"
16230 "url": "/api/mail/messages/{id}/download",
16231 "title": "Gets message",
16234 "title": "Example usage:",
16235 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16239 "name": "download",
16240 "group": "Mail_Messages",
16241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16242 "version": "0.0.0",
16243 "filename": "server/api/mailMessage/index.js",
16244 "groupTitle": "Mail_Messages"
16248 "url": "/api/mail/messages/{id}/reject",
16249 "title": "Rejects message",
16252 "title": "Example usage:",
16253 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16257 "name": "rejectMessage",
16258 "group": "Mail_Messages",
16259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16260 "version": "0.0.0",
16261 "filename": "server/api/mailMessage/index.js",
16262 "groupTitle": "Mail_Messages"
16266 "url": "/api/mail/messages/{id}",
16267 "title": "Update an existing Message",
16270 "title": "Example usage:",
16271 "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",
16275 "name": "updateMessages",
16276 "group": "Mail_Messages",
16277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16278 "version": "0.0.0",
16279 "filename": "server/api/mailMessage/index.js",
16280 "groupTitle": "Mail_Messages"
16284 "url": "/api/mail/reports/queue",
16285 "title": "Creates a new Mail Queue Report",
16288 "title": "Example usage:",
16289 "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",
16293 "name": "CreateMail_Queue_Reports",
16294 "group": "Mail_Queue_Reports",
16302 "field": "uniqueid",
16323 "field": "leaveAt",
16330 "field": "acceptAt",
16350 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16351 "version": "0.0.0",
16352 "filename": "server/api/mailQueueReport/index.js",
16353 "groupTitle": "Mail_Queue_Reports"
16357 "url": "/api/mail/reports/queue/{id}",
16358 "title": "Deletes a Mail Queue Report",
16361 "title": "Example usage:",
16362 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16366 "name": "DeleteMail_Queue_Reports",
16367 "group": "Mail_Queue_Reports",
16368 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16369 "version": "0.0.0",
16370 "filename": "server/api/mailQueueReport/index.js",
16371 "groupTitle": "Mail_Queue_Reports"
16375 "url": "/api/mail/reports/queue/describe",
16376 "title": "Gets table info about Mail Queue Reports",
16379 "title": "Example usage:",
16380 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16384 "name": "DescribeMail_Queue_Reports",
16385 "group": "Mail_Queue_Reports",
16386 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16387 "version": "0.0.0",
16388 "filename": "server/api/mailQueueReport/index.js",
16389 "groupTitle": "Mail_Queue_Reports"
16393 "url": "/api/mail/reports/queue",
16394 "title": "Gets a list of Mail Queue Reports",
16397 "title": "Example usage:",
16398 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16402 "name": "GetMail_Queue_Reports",
16403 "group": "Mail_Queue_Reports",
16404 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16405 "version": "0.0.0",
16406 "filename": "server/api/mailQueueReport/index.js",
16407 "groupTitle": "Mail_Queue_Reports"
16411 "url": "/api/mail/reports/queue/{id}",
16412 "title": "Gets a single Mail Queue Report",
16415 "title": "Example usage:",
16416 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16420 "name": "ShowMail_Queue_Reports",
16421 "group": "Mail_Queue_Reports",
16422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16423 "version": "0.0.0",
16424 "filename": "server/api/mailQueueReport/index.js",
16425 "groupTitle": "Mail_Queue_Reports"
16429 "url": "/api/mail/reports/queue/{id}",
16430 "title": "Update an existing Mail Queue Report",
16433 "title": "Example usage:",
16434 "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",
16438 "name": "updateMail_Queue_Reports",
16439 "group": "Mail_Queue_Reports",
16440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16441 "version": "0.0.0",
16442 "filename": "server/api/mailQueueReport/index.js",
16443 "groupTitle": "Mail_Queue_Reports"
16447 "url": "/api/mail/queues/{id}/users",
16448 "title": "Add agents to a queue",
16451 "title": "Example usage:",
16452 "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",
16456 "name": "AddAgents",
16457 "group": "Mail_Queues",
16458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16459 "version": "0.0.0",
16460 "filename": "server/api/mailQueue/index.js",
16461 "groupTitle": "Mail_Queues"
16465 "url": "/api/mail/queues/{id}/teams",
16466 "title": "Add teams to a queue",
16469 "title": "Example usage:",
16470 "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",
16474 "name": "AddTeams",
16475 "group": "Mail_Queues",
16476 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16477 "version": "0.0.0",
16478 "filename": "server/api/mailQueue/index.js",
16479 "groupTitle": "Mail_Queues"
16483 "url": "/api/mail/queues",
16484 "title": "Creates a new Queue",
16487 "title": "Example usage:",
16488 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16492 "name": "CreateQueues",
16493 "group": "Mail_Queues",
16508 "field": "description",
16515 "field": "timeout",
16527 "field": "strategy",
16533 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16534 "version": "0.0.0",
16535 "filename": "server/api/mailQueue/index.js",
16536 "groupTitle": "Mail_Queues"
16540 "url": "/api/mail/queues/{id}",
16541 "title": "Deletes a Queue",
16544 "title": "Example usage:",
16545 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16549 "name": "DeleteQueues",
16550 "group": "Mail_Queues",
16551 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16552 "version": "0.0.0",
16553 "filename": "server/api/mailQueue/index.js",
16554 "groupTitle": "Mail_Queues"
16558 "url": "/api/mail/queues/describe",
16559 "title": "Gets table info about Queues",
16562 "title": "Example usage:",
16563 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16567 "name": "DescribeQueues",
16568 "group": "Mail_Queues",
16569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16570 "version": "0.0.0",
16571 "filename": "server/api/mailQueue/index.js",
16572 "groupTitle": "Mail_Queues"
16576 "url": "/api/mail/queues/{id}/users",
16577 "title": "Gets queue agents",
16580 "title": "Example usage:",
16581 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16585 "name": "GetAgents",
16586 "group": "Mail_Queues",
16587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16588 "version": "0.0.0",
16589 "filename": "server/api/mailQueue/index.js",
16590 "groupTitle": "Mail_Queues"
16594 "url": "/api/mail/queues/{id}/members",
16595 "title": "GetMembers",
16598 "title": "Example usage:",
16599 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16603 "name": "GetMembers",
16604 "group": "Mail_Queues",
16605 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16606 "version": "0.0.0",
16607 "filename": "server/api/mailQueue/index.js",
16608 "groupTitle": "Mail_Queues"
16612 "url": "/api/mail/queues",
16613 "title": "Gets a list of Queues",
16616 "title": "Example usage:",
16617 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16621 "name": "GetQueues",
16622 "group": "Mail_Queues",
16623 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16624 "version": "0.0.0",
16625 "filename": "server/api/mailQueue/index.js",
16626 "groupTitle": "Mail_Queues"
16630 "url": "/api/mail/queues/{id}/teams",
16631 "title": "Gets queues list",
16634 "title": "Example usage:",
16635 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16639 "name": "GetTeams",
16640 "group": "Mail_Queues",
16641 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16642 "version": "0.0.0",
16643 "filename": "server/api/mailQueue/index.js",
16644 "groupTitle": "Mail_Queues"
16648 "url": "/api/mail/queues/{id}/users",
16649 "title": "Removes agents from a queue",
16652 "title": "Example usage:",
16653 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16657 "name": "RemoveAgents",
16658 "group": "Mail_Queues",
16659 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16660 "version": "0.0.0",
16661 "filename": "server/api/mailQueue/index.js",
16662 "groupTitle": "Mail_Queues"
16666 "url": "/api/mail/queues/{id}",
16667 "title": "Gets a single Queue",
16670 "title": "Example usage:",
16671 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16675 "name": "ShowQueues",
16676 "group": "Mail_Queues",
16677 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16678 "version": "0.0.0",
16679 "filename": "server/api/mailQueue/index.js",
16680 "groupTitle": "Mail_Queues"
16684 "url": "/api/mail/queues/{id}",
16685 "title": "Update an existing Queue",
16688 "title": "Example usage:",
16689 "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",
16693 "name": "updateQueues",
16694 "group": "Mail_Queues",
16695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16696 "version": "0.0.0",
16697 "filename": "server/api/mailQueue/index.js",
16698 "groupTitle": "Mail_Queues"
16702 "url": "/api/mail/out_servers",
16703 "title": "Creates a new SMTP",
16706 "title": "Example usage:",
16707 "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",
16711 "name": "CreateSMTPs",
16712 "group": "Mail_SMTP",
16720 "field": "description",
16762 "field": "service",
16769 "field": "authentication",
16775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16776 "version": "0.0.0",
16777 "filename": "server/api/mailServerOut/index.js",
16778 "groupTitle": "Mail_SMTP"
16782 "url": "/api/mail/out_servers/{id}",
16783 "title": "Deletes a SMTP",
16786 "title": "Example usage:",
16787 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16791 "name": "DeleteSMTPs",
16792 "group": "Mail_SMTP",
16793 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16794 "version": "0.0.0",
16795 "filename": "server/api/mailServerOut/index.js",
16796 "groupTitle": "Mail_SMTP"
16800 "url": "/api/mail/out_servers",
16801 "title": "Gets a list of SMTPs",
16804 "title": "Example usage:",
16805 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16809 "name": "GetSMTPs",
16810 "group": "Mail_SMTP",
16811 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16812 "version": "0.0.0",
16813 "filename": "server/api/mailServerOut/index.js",
16814 "groupTitle": "Mail_SMTP"
16818 "url": "/api/mail/out_servers/{id}",
16819 "title": "Gets a single SMTP",
16822 "title": "Example usage:",
16823 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16827 "name": "ShowSMTPs",
16828 "group": "Mail_SMTP",
16829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16830 "version": "0.0.0",
16831 "filename": "server/api/mailServerOut/index.js",
16832 "groupTitle": "Mail_SMTP"
16836 "url": "/api/mail/out_servers/{id}",
16837 "title": "Update an existing SMTP",
16840 "title": "Example usage:",
16841 "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",
16845 "name": "updateSMTPs",
16846 "group": "Mail_SMTP",
16847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16848 "version": "0.0.0",
16849 "filename": "server/api/mailServerOut/index.js",
16850 "groupTitle": "Mail_SMTP"
16854 "url": "/api/mail/substatuses",
16855 "title": "Creates a new Queue",
16858 "title": "Example usage:",
16859 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16863 "name": "CreateSubstatuses",
16864 "group": "Mail_Substatuses",
16879 "field": "description",
16885 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16886 "version": "0.0.0",
16887 "filename": "server/api/mailSubstatus/index.js",
16888 "groupTitle": "Mail_Substatuses"
16892 "url": "/api/mail/substatuses/{id}",
16893 "title": "Deletes a Queue",
16896 "title": "Example usage:",
16897 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16901 "name": "DeleteSubstatuses",
16902 "group": "Mail_Substatuses",
16903 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16904 "version": "0.0.0",
16905 "filename": "server/api/mailSubstatus/index.js",
16906 "groupTitle": "Mail_Substatuses"
16910 "url": "/api/mail/substatuses/describe",
16911 "title": "Gets table info about Substatuses",
16914 "title": "Example usage:",
16915 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16919 "name": "DescribeSubstatuses",
16920 "group": "Mail_Substatuses",
16921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16922 "version": "0.0.0",
16923 "filename": "server/api/mailSubstatus/index.js",
16924 "groupTitle": "Mail_Substatuses"
16928 "url": "/api/mail/substatuses",
16929 "title": "Gets a list of Substatuses",
16932 "title": "Example usage:",
16933 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16937 "name": "GetSubstatuses",
16938 "group": "Mail_Substatuses",
16939 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16940 "version": "0.0.0",
16941 "filename": "server/api/mailSubstatus/index.js",
16942 "groupTitle": "Mail_Substatuses"
16946 "url": "/api/mail/substatuses/{id}",
16947 "title": "Gets a single Queue",
16950 "title": "Example usage:",
16951 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16955 "name": "ShowSubstatuses",
16956 "group": "Mail_Substatuses",
16957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16958 "version": "0.0.0",
16959 "filename": "server/api/mailSubstatus/index.js",
16960 "groupTitle": "Mail_Substatuses"
16964 "url": "/api/mail/substatuses/{id}",
16965 "title": "Update an existing Queue",
16968 "title": "Example usage:",
16969 "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",
16973 "name": "updateSubstatuses",
16974 "group": "Mail_Substatuses",
16975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16976 "version": "0.0.0",
16977 "filename": "server/api/mailSubstatus/index.js",
16978 "groupTitle": "Mail_Substatuses"
16982 "url": "/api/mail/reports/transfer",
16983 "title": "Creates a new Mail Transfer Report",
16986 "title": "Example usage:",
16987 "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",
16991 "name": "CreateMail_Transfer_Reports",
16992 "group": "Mail_Transfer_Reports",
17000 "field": "uniqueid",
17019 "field": "transferredAt",
17025 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17026 "version": "0.0.0",
17027 "filename": "server/api/mailTransferReport/index.js",
17028 "groupTitle": "Mail_Transfer_Reports"
17032 "url": "/api/mail/reports/transfer/{id}",
17033 "title": "Deletes a Mail Transfer Report",
17036 "title": "Example usage:",
17037 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17041 "name": "DeleteMail_Transfer_Reports",
17042 "group": "Mail_Transfer_Reports",
17043 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17044 "version": "0.0.0",
17045 "filename": "server/api/mailTransferReport/index.js",
17046 "groupTitle": "Mail_Transfer_Reports"
17050 "url": "/api/mail/reports/transfer/describe",
17051 "title": "Gets table info about Mail Transfer Reports",
17054 "title": "Example usage:",
17055 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17059 "name": "DescribeMail_Transfer_Reports",
17060 "group": "Mail_Transfer_Reports",
17061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17062 "version": "0.0.0",
17063 "filename": "server/api/mailTransferReport/index.js",
17064 "groupTitle": "Mail_Transfer_Reports"
17068 "url": "/api/mail/reports/transfer",
17069 "title": "Gets a list of Mail Transfer Reports",
17072 "title": "Example usage:",
17073 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17077 "name": "GetMail_Transfer_Reports",
17078 "group": "Mail_Transfer_Reports",
17079 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17080 "version": "0.0.0",
17081 "filename": "server/api/mailTransferReport/index.js",
17082 "groupTitle": "Mail_Transfer_Reports"
17086 "url": "/api/mail/reports/transfer/{id}",
17087 "title": "Gets a single Mail Transfer Report",
17090 "title": "Example usage:",
17091 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17095 "name": "ShowMail_Transfer_Reports",
17096 "group": "Mail_Transfer_Reports",
17097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17098 "version": "0.0.0",
17099 "filename": "server/api/mailTransferReport/index.js",
17100 "groupTitle": "Mail_Transfer_Reports"
17104 "url": "/api/mail/reports/transfer/{id}",
17105 "title": "Update an existing Mail Transfer Report",
17108 "title": "Example usage:",
17109 "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",
17113 "name": "updateMail_Transfer_Reports",
17114 "group": "Mail_Transfer_Reports",
17115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17116 "version": "0.0.0",
17117 "filename": "server/api/mailTransferReport/index.js",
17118 "groupTitle": "Mail_Transfer_Reports"
17122 "url": "/api/members/reports/describe",
17123 "title": "Gets table info about Member Reports",
17126 "title": "Example usage:",
17127 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17131 "name": "DescribeMember_Reports",
17132 "group": "Member_Reports",
17133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17134 "version": "0.0.0",
17135 "filename": "server/api/memberReport/index.js",
17136 "groupTitle": "Member_Reports"
17140 "url": "/api/members/reports",
17141 "title": "Gets a list of Member Reports",
17144 "title": "Example usage:",
17145 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17149 "name": "GetMember_Reports",
17150 "group": "Member_Reports",
17151 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17152 "version": "0.0.0",
17153 "filename": "server/api/memberReport/index.js",
17154 "groupTitle": "Member_Reports"
17158 "url": "/api/members/reports/{id}",
17159 "title": "Gets a single Member Report",
17162 "title": "Example usage:",
17163 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17167 "name": "ShowMember_Reports",
17168 "group": "Member_Reports",
17169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17170 "version": "0.0.0",
17171 "filename": "server/api/memberReport/index.js",
17172 "groupTitle": "Member_Reports"
17176 "url": "/api/migrations",
17177 "title": "Gets a list of Migrations",
17180 "title": "Example usage:",
17181 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17185 "name": "GetMigrations",
17186 "group": "Migrations",
17187 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17188 "version": "0.0.0",
17189 "filename": "server/api/migration/index.js",
17190 "groupTitle": "Migrations"
17194 "url": "/api/voice/networks",
17195 "title": "Create a new network",
17198 "title": "Example usage:",
17199 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17204 "group": "Networks",
17205 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17206 "version": "0.0.0",
17207 "filename": "server/api/network/index.js",
17208 "groupTitle": "Networks"
17212 "url": "/api/voice/networks/{id}",
17213 "title": "Deletes a network",
17216 "title": "Example usage:",
17217 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17222 "group": "Networks",
17223 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17224 "version": "0.0.0",
17225 "filename": "server/api/network/index.js",
17226 "groupTitle": "Networks"
17230 "url": "/api/networks",
17231 "title": "Gets a list of Networks",
17234 "title": "Example usage:",
17235 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17239 "name": "GetNetworks",
17240 "group": "Networks",
17241 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17242 "version": "0.0.0",
17243 "filename": "server/api/network/index.js",
17244 "groupTitle": "Networks"
17248 "url": "/api/networks/{id}",
17249 "title": "Gets a single Network",
17252 "title": "Example usage:",
17253 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17257 "name": "ShowNetworks",
17258 "group": "Networks",
17259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17260 "version": "0.0.0",
17261 "filename": "server/api/network/index.js",
17262 "groupTitle": "Networks"
17266 "url": "/api/voice/networks/{id}",
17267 "title": "Update an existing network",
17270 "title": "Example usage:",
17271 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17276 "group": "Networks",
17277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17278 "version": "0.0.0",
17279 "filename": "server/api/network/index.js",
17280 "groupTitle": "Networks"
17284 "url": "/api/notifications",
17285 "title": "Send notification to user",
17288 "title": "Example usage:",
17289 "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17294 "group": "Notifications",
17295 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17296 "version": "0.0.0",
17297 "filename": "server/api/notification/index.js",
17298 "groupTitle": "Notifications"
17302 "url": "/api/openchannel/accounts/{id}/users",
17303 "title": "Add agents to a openchannel account",
17306 "title": "Example usage:",
17307 "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",
17311 "name": "AddAgents",
17312 "group": "Openchannel_Accounts",
17313 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17314 "version": "0.0.0",
17315 "filename": "server/api/openchannelAccount/index.js",
17316 "groupTitle": "Openchannel_Accounts"
17320 "url": "/api/openchannel/accounts",
17321 "title": "Creates a new Account",
17324 "title": "Example usage:",
17325 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17329 "name": "CreateAccounts",
17330 "group": "Openchannel_Accounts",
17345 "field": "description",
17359 "field": "replyUri",
17373 "field": "notificationTemplate",
17380 "field": "notificationSound",
17387 "field": "notificationShake",
17394 "field": "waitForTheAssignedAgent",
17408 "field": "queueTransfer",
17415 "field": "queueTransferTimeout",
17422 "field": "agentTransfer",
17429 "field": "agentTransferTimeout",
17436 "field": "mandatoryDispositionPauseId",
17437 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17443 "field": "mandatoryDisposition",
17444 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17449 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17450 "version": "0.0.0",
17451 "filename": "server/api/openchannelAccount/index.js",
17452 "groupTitle": "Openchannel_Accounts"
17456 "url": "/api/openchannel/accounts/{id}",
17457 "title": "Deletes a Account",
17460 "title": "Example usage:",
17461 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17465 "name": "DeleteAccounts",
17466 "group": "Openchannel_Accounts",
17467 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17468 "version": "0.0.0",
17469 "filename": "server/api/openchannelAccount/index.js",
17470 "groupTitle": "Openchannel_Accounts"
17474 "url": "/api/openchannel/accounts/describe",
17475 "title": "Gets table info about Accounts",
17478 "title": "Example usage:",
17479 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17483 "name": "DescribeAccounts",
17484 "group": "Openchannel_Accounts",
17485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17486 "version": "0.0.0",
17487 "filename": "server/api/openchannelAccount/index.js",
17488 "groupTitle": "Openchannel_Accounts"
17492 "url": "/api/openchannel/accounts",
17493 "title": "Gets a list of Accounts",
17496 "title": "Example usage:",
17497 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17501 "name": "GetAccounts",
17502 "group": "Openchannel_Accounts",
17503 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17504 "version": "0.0.0",
17505 "filename": "server/api/openchannelAccount/index.js",
17506 "groupTitle": "Openchannel_Accounts"
17510 "url": "/api/openchannel/accounts/{id}/users",
17511 "title": "Gets agents from openchannel account",
17514 "title": "Example usage:",
17515 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17519 "name": "GetAgents",
17520 "group": "Openchannel_Accounts",
17521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17522 "version": "0.0.0",
17523 "filename": "server/api/openchannelAccount/index.js",
17524 "groupTitle": "Openchannel_Accounts"
17528 "url": "/api/openchannel/accounts/{id}/users",
17529 "title": "Removes agents from a openchannel account",
17532 "title": "Example usage:",
17533 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17537 "name": "RemoveAgents",
17538 "group": "Openchannel_Accounts",
17539 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17540 "version": "0.0.0",
17541 "filename": "server/api/openchannelAccount/index.js",
17542 "groupTitle": "Openchannel_Accounts"
17546 "url": "/api/openchannel/accounts/{id}/canned_answers",
17547 "title": "Removes canned answers from account",
17550 "title": "Example usage:",
17551 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17555 "name": "RemoveAnswers",
17556 "group": "Openchannel_Accounts",
17557 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17558 "version": "0.0.0",
17559 "filename": "server/api/openchannelAccount/index.js",
17560 "groupTitle": "Openchannel_Accounts"
17564 "url": "/api/openchannel/accounts/{id}/dispositions",
17565 "title": "Removes dispositions from account",
17568 "title": "Example usage:",
17569 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17573 "name": "RemoveDispositions",
17574 "group": "Openchannel_Accounts",
17575 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17576 "version": "0.0.0",
17577 "filename": "server/api/openchannelAccount/index.js",
17578 "groupTitle": "Openchannel_Accounts"
17582 "url": "/api/openchannel/accounts/{id}",
17583 "title": "Gets a single Account",
17586 "title": "Example usage:",
17587 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17591 "name": "ShowAccounts",
17592 "group": "Openchannel_Accounts",
17593 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17594 "version": "0.0.0",
17595 "filename": "server/api/openchannelAccount/index.js",
17596 "groupTitle": "Openchannel_Accounts"
17600 "url": "/api/openchannel/accounts/{id}/canned_answers",
17601 "title": "Creates new canned answer",
17604 "title": "Example usage:",
17605 "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",
17609 "name": "addAnswer",
17610 "group": "Openchannel_Accounts",
17632 "field": "description",
17645 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17646 "version": "0.0.0",
17647 "filename": "server/api/openchannelAccount/index.js",
17648 "groupTitle": "Openchannel_Accounts"
17652 "url": "/api/openchannel/accounts/{id}/applications",
17653 "title": "Creates new applications",
17656 "title": "Example usage:",
17657 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17661 "name": "addApplications",
17662 "group": "Openchannel_Accounts",
17670 "field": "priority",
17684 "field": "appdata",
17691 "field": "description",
17698 "field": "interval",
17704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17705 "version": "0.0.0",
17706 "filename": "server/api/openchannelAccount/index.js",
17707 "groupTitle": "Openchannel_Accounts"
17711 "url": "/api/openchannel/accounts/{id}/dispositions",
17712 "title": "Creates new disposition",
17715 "title": "Example usage:",
17716 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17720 "name": "addDisposition",
17721 "group": "Openchannel_Accounts",
17748 "field": "description",
17754 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17755 "version": "0.0.0",
17756 "filename": "server/api/openchannelAccount/index.js",
17757 "groupTitle": "Openchannel_Accounts"
17761 "url": "/api/openchannel/accounts/{id}/canned_answers",
17762 "title": "Gets account canned answers",
17765 "title": "Example usage:",
17766 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17770 "name": "getAnswers",
17771 "group": "Openchannel_Accounts",
17772 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17773 "version": "0.0.0",
17774 "filename": "server/api/openchannelAccount/index.js",
17775 "groupTitle": "Openchannel_Accounts"
17779 "url": "/api/openchannel/accounts/{id}/applications",
17780 "title": "Gets account applications",
17783 "title": "Example usage:",
17784 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17788 "name": "getApplications",
17789 "group": "Openchannel_Accounts",
17790 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17791 "version": "0.0.0",
17792 "filename": "server/api/openchannelAccount/index.js",
17793 "groupTitle": "Openchannel_Accounts"
17797 "url": "/api/openchannel/accounts/{id}/dispositions",
17798 "title": "Gets account dispositions",
17801 "title": "Example usage:",
17802 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17806 "name": "getDispositions",
17807 "group": "Openchannel_Accounts",
17808 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17809 "version": "0.0.0",
17810 "filename": "server/api/openchannelAccount/index.js",
17811 "groupTitle": "Openchannel_Accounts"
17815 "url": "/api/openchannel/accounts/{id}/interactions",
17816 "title": "Gets Openchannel Account Interactions",
17819 "title": "Example usage:",
17820 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17824 "name": "getInteractions",
17825 "group": "Openchannel_Accounts",
17826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17827 "version": "0.0.0",
17828 "filename": "server/api/openchannelAccount/index.js",
17829 "groupTitle": "Openchannel_Accounts"
17833 "url": "/api/openchannel/accounts/{id}/notify",
17834 "title": "Notify new message",
17837 "title": "Example usage:",
17838 "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",
17843 "group": "Openchannel_Accounts",
17844 "description": "<p>Motion 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>",
17845 "version": "0.0.0",
17846 "filename": "server/api/openchannelAccount/index.js",
17847 "groupTitle": "Openchannel_Accounts"
17851 "url": "/api/openchannel/accounts/{id}/send",
17852 "title": "Send new openchannel message",
17855 "title": "Example usage:",
17856 "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",
17860 "name": "sendOpenchannel",
17861 "group": "Openchannel_Accounts",
17862 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17863 "version": "0.0.0",
17864 "filename": "server/api/openchannelAccount/index.js",
17865 "groupTitle": "Openchannel_Accounts"
17869 "url": "/api/openchannel/accounts/{id}",
17870 "title": "Update an existing Account",
17873 "title": "Example usage:",
17874 "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",
17878 "name": "updateAccounts",
17879 "group": "Openchannel_Accounts",
17880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17881 "version": "0.0.0",
17882 "filename": "server/api/openchannelAccount/index.js",
17883 "groupTitle": "Openchannel_Accounts"
17887 "url": "/api/openchannel/applications",
17888 "title": "Creates a new Application",
17891 "title": "Example usage:",
17892 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17896 "name": "CreateApplications",
17897 "group": "Openchannel_Applications",
17905 "field": "priority",
17919 "field": "appdata",
17926 "field": "description",
17933 "field": "interval",
17939 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17940 "version": "0.0.0",
17941 "filename": "server/api/openchannelApplication/index.js",
17942 "groupTitle": "Openchannel_Applications"
17946 "url": "/api/openchannel/applications/{id}",
17947 "title": "Deletes a Application",
17950 "title": "Example usage:",
17951 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17955 "name": "DeleteApplications",
17956 "group": "Openchannel_Applications",
17957 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17958 "version": "0.0.0",
17959 "filename": "server/api/openchannelApplication/index.js",
17960 "groupTitle": "Openchannel_Applications"
17964 "url": "/api/openchannel/applications",
17965 "title": "Gets a list of Applications",
17968 "title": "Example usage:",
17969 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17973 "name": "GetApplications",
17974 "group": "Openchannel_Applications",
17975 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17976 "version": "0.0.0",
17977 "filename": "server/api/openchannelApplication/index.js",
17978 "groupTitle": "Openchannel_Applications"
17982 "url": "/api/openchannel/applications/{id}",
17983 "title": "Gets a single Application",
17986 "title": "Example usage:",
17987 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17991 "name": "ShowApplications",
17992 "group": "Openchannel_Applications",
17993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17994 "version": "0.0.0",
17995 "filename": "server/api/openchannelApplication/index.js",
17996 "groupTitle": "Openchannel_Applications"
18000 "url": "/api/openchannel/applications/{id}",
18001 "title": "Update an existing Application",
18004 "title": "Example usage:",
18005 "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",
18009 "name": "updateApplications",
18010 "group": "Openchannel_Applications",
18011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18012 "version": "0.0.0",
18013 "filename": "server/api/openchannelApplication/index.js",
18014 "groupTitle": "Openchannel_Applications"
18018 "url": "/api/openchannel/interactions/{id}/tags",
18019 "title": "Add tags to the interaction",
18022 "title": "Example usage:",
18023 "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",
18028 "group": "Openchannel_Interactions",
18029 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18030 "version": "0.0.0",
18031 "filename": "server/api/openchannelInteraction/index.js",
18032 "groupTitle": "Openchannel_Interactions"
18036 "url": "/api/openchannel/interactions",
18037 "title": "Creates a new Interaction",
18040 "title": "Example usage:",
18041 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18045 "name": "CreateInteractions",
18046 "group": "Openchannel_Interactions",
18061 "field": "closedAt",
18068 "field": "disposition",
18075 "field": "secondDisposition",
18082 "field": "thirdDisposition",
18096 "field": "read1stAt",
18103 "field": "threadId",
18110 "field": "externalUrl",
18117 "field": "lastMsgAt",
18128 "field": "lastMsgDirection",
18141 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18142 "version": "0.0.0",
18143 "filename": "server/api/openchannelInteraction/index.js",
18144 "groupTitle": "Openchannel_Interactions"
18148 "url": "/api/openchannel/interactions/{id}",
18149 "title": "Deletes a Interaction",
18152 "title": "Example usage:",
18153 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18157 "name": "DeleteInteractions",
18158 "group": "Openchannel_Interactions",
18159 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18160 "version": "0.0.0",
18161 "filename": "server/api/openchannelInteraction/index.js",
18162 "groupTitle": "Openchannel_Interactions"
18166 "url": "/api/openchannel/interactions/describe",
18167 "title": "Gets table info about Interactions",
18170 "title": "Example usage:",
18171 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18175 "name": "DescribeInteractions",
18176 "group": "Openchannel_Interactions",
18177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18178 "version": "0.0.0",
18179 "filename": "server/api/openchannelInteraction/index.js",
18180 "groupTitle": "Openchannel_Interactions"
18184 "url": "/api/openchannel/interactions",
18185 "title": "Gets a list of Interactions",
18188 "title": "Example usage:",
18189 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18193 "name": "GetInteractions",
18194 "group": "Openchannel_Interactions",
18195 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18196 "version": "0.0.0",
18197 "filename": "server/api/openchannelInteraction/index.js",
18198 "groupTitle": "Openchannel_Interactions"
18202 "url": "/api/openchannel/interactions/{id}/tags",
18203 "title": "Removes tags from interaction",
18206 "title": "Example usage:",
18207 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18211 "name": "RemoveTags",
18212 "group": "Openchannel_Interactions",
18213 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18214 "version": "0.0.0",
18215 "filename": "server/api/openchannelInteraction/index.js",
18216 "groupTitle": "Openchannel_Interactions"
18220 "url": "/api/openchannel/interactions/{id}",
18221 "title": "Gets a single Interaction",
18224 "title": "Example usage:",
18225 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18229 "name": "ShowInteractions",
18230 "group": "Openchannel_Interactions",
18231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18232 "version": "0.0.0",
18233 "filename": "server/api/openchannelInteraction/index.js",
18234 "groupTitle": "Openchannel_Interactions"
18238 "url": "/api/openchannel/interactions/{id}/messages",
18239 "title": "Creates new messages",
18242 "title": "Example usage:",
18243 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18247 "name": "addMessage",
18248 "group": "Openchannel_Interactions",
18281 "field": "direction",
18295 "field": "providerName",
18302 "field": "providerResponse",
18308 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18309 "version": "0.0.0",
18310 "filename": "server/api/openchannelInteraction/index.js",
18311 "groupTitle": "Openchannel_Interactions"
18315 "url": "/api/openchannel/interactions/{id}/download",
18316 "title": "Gets interaction",
18319 "title": "Example usage:",
18320 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18324 "name": "download",
18325 "group": "Openchannel_Interactions",
18326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18327 "version": "0.0.0",
18328 "filename": "server/api/openchannelInteraction/index.js",
18329 "groupTitle": "Openchannel_Interactions"
18333 "url": "/api/openchannel/interactions/{id}/messages",
18334 "title": "Gets interaction messages",
18337 "title": "Example usage:",
18338 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18342 "name": "getMessages",
18343 "group": "Openchannel_Interactions",
18344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18345 "version": "0.0.0",
18346 "filename": "server/api/openchannelInteraction/index.js",
18347 "groupTitle": "Openchannel_Interactions"
18351 "url": "/api/openchannel/interactions/{id}",
18352 "title": "Update an existing Interaction",
18355 "title": "Example usage:",
18356 "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",
18360 "name": "updateInteractions",
18361 "group": "Openchannel_Interactions",
18362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18363 "version": "0.0.0",
18364 "filename": "server/api/openchannelInteraction/index.js",
18365 "groupTitle": "Openchannel_Interactions"
18369 "url": "/api/openchannel/messages",
18370 "title": "Creates a new Message",
18373 "title": "Example usage:",
18374 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18378 "name": "CreateMessages",
18379 "group": "Openchannel_Messages",
18412 "field": "direction",
18426 "field": "providerName",
18433 "field": "providerResponse",
18439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18440 "version": "0.0.0",
18441 "filename": "server/api/openchannelMessage/index.js",
18442 "groupTitle": "Openchannel_Messages"
18446 "url": "/api/openchannel/messages/{id}",
18447 "title": "Deletes a Message",
18450 "title": "Example usage:",
18451 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18455 "name": "DeleteMessages",
18456 "group": "Openchannel_Messages",
18457 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18458 "version": "0.0.0",
18459 "filename": "server/api/openchannelMessage/index.js",
18460 "groupTitle": "Openchannel_Messages"
18464 "url": "/api/openchannel/messages/describe",
18465 "title": "Gets table info about Messages",
18468 "title": "Example usage:",
18469 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18473 "name": "DescribeMessages",
18474 "group": "Openchannel_Messages",
18475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18476 "version": "0.0.0",
18477 "filename": "server/api/openchannelMessage/index.js",
18478 "groupTitle": "Openchannel_Messages"
18482 "url": "/api/openchannel/messages",
18483 "title": "Gets a list of Messages",
18486 "title": "Example usage:",
18487 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18491 "name": "GetMessages",
18492 "group": "Openchannel_Messages",
18493 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18494 "version": "0.0.0",
18495 "filename": "server/api/openchannelMessage/index.js",
18496 "groupTitle": "Openchannel_Messages"
18500 "url": "/api/openchannel/messages/{id}",
18501 "title": "Gets a single Message",
18504 "title": "Example usage:",
18505 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18509 "name": "ShowMessages",
18510 "group": "Openchannel_Messages",
18511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18512 "version": "0.0.0",
18513 "filename": "server/api/openchannelMessage/index.js",
18514 "groupTitle": "Openchannel_Messages"
18518 "url": "/api/openchannel/messages/{id}/accept",
18519 "title": "Accepts message",
18522 "title": "Example usage:",
18523 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18527 "name": "acceptMessage",
18528 "group": "Openchannel_Messages",
18529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18530 "version": "0.0.0",
18531 "filename": "server/api/openchannelMessage/index.js",
18532 "groupTitle": "Openchannel_Messages"
18536 "url": "/api/openchannel/messages/{id}/reject",
18537 "title": "Rejects message",
18540 "title": "Example usage:",
18541 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18545 "name": "rejectMessage",
18546 "group": "Openchannel_Messages",
18547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18548 "version": "0.0.0",
18549 "filename": "server/api/openchannelMessage/index.js",
18550 "groupTitle": "Openchannel_Messages"
18554 "url": "/api/openchannel/messages/{id}",
18555 "title": "Update an existing Message",
18558 "title": "Example usage:",
18559 "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",
18563 "name": "updateMessages",
18564 "group": "Openchannel_Messages",
18565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18566 "version": "0.0.0",
18567 "filename": "server/api/openchannelMessage/index.js",
18568 "groupTitle": "Openchannel_Messages"
18572 "url": "/api/openchannel/reports/queue",
18573 "title": "Creates a new Openchannel Queue Report",
18576 "title": "Example usage:",
18577 "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",
18581 "name": "CreateOpenchannel_Queue_Reports",
18582 "group": "Openchannel_Queue_Reports",
18590 "field": "uniqueid",
18611 "field": "leaveAt",
18618 "field": "acceptAt",
18638 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18639 "version": "0.0.0",
18640 "filename": "server/api/openchannelQueueReport/index.js",
18641 "groupTitle": "Openchannel_Queue_Reports"
18645 "url": "/api/openchannel/reports/queue/{id}",
18646 "title": "Deletes a Openchannel Queue Report",
18649 "title": "Example usage:",
18650 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18654 "name": "DeleteOpenchannel_Queue_Reports",
18655 "group": "Openchannel_Queue_Reports",
18656 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18657 "version": "0.0.0",
18658 "filename": "server/api/openchannelQueueReport/index.js",
18659 "groupTitle": "Openchannel_Queue_Reports"
18663 "url": "/api/openchannel/reports/queue/describe",
18664 "title": "Gets table info about Openchannel Queue Reports",
18667 "title": "Example usage:",
18668 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18672 "name": "DescribeOpenchannel_Queue_Reports",
18673 "group": "Openchannel_Queue_Reports",
18674 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18675 "version": "0.0.0",
18676 "filename": "server/api/openchannelQueueReport/index.js",
18677 "groupTitle": "Openchannel_Queue_Reports"
18681 "url": "/api/openchannel/reports/queue",
18682 "title": "Gets a list of Openchannel Queue Reports",
18685 "title": "Example usage:",
18686 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18690 "name": "GetOpenchannel_Queue_Reports",
18691 "group": "Openchannel_Queue_Reports",
18692 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18693 "version": "0.0.0",
18694 "filename": "server/api/openchannelQueueReport/index.js",
18695 "groupTitle": "Openchannel_Queue_Reports"
18699 "url": "/api/openchannel/reports/queue/{id}",
18700 "title": "Gets a single Openchannel Queue Report",
18703 "title": "Example usage:",
18704 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18708 "name": "ShowOpenchannel_Queue_Reports",
18709 "group": "Openchannel_Queue_Reports",
18710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18711 "version": "0.0.0",
18712 "filename": "server/api/openchannelQueueReport/index.js",
18713 "groupTitle": "Openchannel_Queue_Reports"
18717 "url": "/api/openchannel/reports/queue/{id}",
18718 "title": "Update an existing Openchannel Queue Report",
18721 "title": "Example usage:",
18722 "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",
18726 "name": "updateOpenchannel_Queue_Reports",
18727 "group": "Openchannel_Queue_Reports",
18728 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18729 "version": "0.0.0",
18730 "filename": "server/api/openchannelQueueReport/index.js",
18731 "groupTitle": "Openchannel_Queue_Reports"
18735 "url": "/api/openchannel/queues/{id}/users",
18736 "title": "Add agents to a queue",
18739 "title": "Example usage:",
18740 "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",
18744 "name": "AddAgents",
18745 "group": "Openchannel_Queues",
18746 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18747 "version": "0.0.0",
18748 "filename": "server/api/openchannelQueue/index.js",
18749 "groupTitle": "Openchannel_Queues"
18753 "url": "/api/openchannel/queues/{id}/teams",
18754 "title": "Add teams to a queue",
18757 "title": "Example usage:",
18758 "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",
18762 "name": "AddTeams",
18763 "group": "Openchannel_Queues",
18764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18765 "version": "0.0.0",
18766 "filename": "server/api/openchannelQueue/index.js",
18767 "groupTitle": "Openchannel_Queues"
18771 "url": "/api/openchannel/queues",
18772 "title": "Creates a new Queue",
18775 "title": "Example usage:",
18776 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18780 "name": "CreateQueues",
18781 "group": "Openchannel_Queues",
18796 "field": "description",
18803 "field": "timeout",
18815 "field": "strategy",
18821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18822 "version": "0.0.0",
18823 "filename": "server/api/openchannelQueue/index.js",
18824 "groupTitle": "Openchannel_Queues"
18828 "url": "/api/openchannel/queues/{id}",
18829 "title": "Deletes a Queue",
18832 "title": "Example usage:",
18833 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18837 "name": "DeleteQueues",
18838 "group": "Openchannel_Queues",
18839 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18840 "version": "0.0.0",
18841 "filename": "server/api/openchannelQueue/index.js",
18842 "groupTitle": "Openchannel_Queues"
18846 "url": "/api/openchannel/queues/describe",
18847 "title": "Gets table info about Queues",
18850 "title": "Example usage:",
18851 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18855 "name": "DescribeQueues",
18856 "group": "Openchannel_Queues",
18857 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18858 "version": "0.0.0",
18859 "filename": "server/api/openchannelQueue/index.js",
18860 "groupTitle": "Openchannel_Queues"
18864 "url": "/api/openchannel/queues/{id}/users",
18865 "title": "Gets queue agents",
18868 "title": "Example usage:",
18869 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18873 "name": "GetAgents",
18874 "group": "Openchannel_Queues",
18875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18876 "version": "0.0.0",
18877 "filename": "server/api/openchannelQueue/index.js",
18878 "groupTitle": "Openchannel_Queues"
18882 "url": "/api/openchannel/queues/{id}/members",
18883 "title": "GetMembers",
18886 "title": "Example usage:",
18887 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18891 "name": "GetMembers",
18892 "group": "Openchannel_Queues",
18893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18894 "version": "0.0.0",
18895 "filename": "server/api/openchannelQueue/index.js",
18896 "groupTitle": "Openchannel_Queues"
18900 "url": "/api/openchannel/queues",
18901 "title": "Gets a list of Queues",
18904 "title": "Example usage:",
18905 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18909 "name": "GetQueues",
18910 "group": "Openchannel_Queues",
18911 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18912 "version": "0.0.0",
18913 "filename": "server/api/openchannelQueue/index.js",
18914 "groupTitle": "Openchannel_Queues"
18918 "url": "/api/openchannel/queues/{id}/teams",
18919 "title": "Gets queues list",
18922 "title": "Example usage:",
18923 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18927 "name": "GetTeams",
18928 "group": "Openchannel_Queues",
18929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18930 "version": "0.0.0",
18931 "filename": "server/api/openchannelQueue/index.js",
18932 "groupTitle": "Openchannel_Queues"
18936 "url": "/api/openchannel/queues/{id}/users",
18937 "title": "Removes agents from a queue",
18940 "title": "Example usage:",
18941 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18945 "name": "RemoveAgents",
18946 "group": "Openchannel_Queues",
18947 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18948 "version": "0.0.0",
18949 "filename": "server/api/openchannelQueue/index.js",
18950 "groupTitle": "Openchannel_Queues"
18954 "url": "/api/openchannel/queues/{id}",
18955 "title": "Gets a single Queue",
18958 "title": "Example usage:",
18959 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18963 "name": "ShowQueues",
18964 "group": "Openchannel_Queues",
18965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18966 "version": "0.0.0",
18967 "filename": "server/api/openchannelQueue/index.js",
18968 "groupTitle": "Openchannel_Queues"
18972 "url": "/api/openchannel/queues/{id}",
18973 "title": "Update an existing Queue",
18976 "title": "Example usage:",
18977 "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",
18981 "name": "updateQueues",
18982 "group": "Openchannel_Queues",
18983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18984 "version": "0.0.0",
18985 "filename": "server/api/openchannelQueue/index.js",
18986 "groupTitle": "Openchannel_Queues"
18990 "url": "/api/openchannel/reports/transfer",
18991 "title": "Creates a new Openchannel Transfer Report",
18994 "title": "Example usage:",
18995 "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",
18999 "name": "CreateOpenchannel_Transfer_Reports",
19000 "group": "Openchannel_Transfer_Reports",
19008 "field": "uniqueid",
19027 "field": "transferredAt",
19033 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19034 "version": "0.0.0",
19035 "filename": "server/api/openchannelTransferReport/index.js",
19036 "groupTitle": "Openchannel_Transfer_Reports"
19040 "url": "/api/openchannel/reports/transfer/{id}",
19041 "title": "Deletes a Openchannel Transfer Report",
19044 "title": "Example usage:",
19045 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19049 "name": "DeleteOpenchannel_Transfer_Reports",
19050 "group": "Openchannel_Transfer_Reports",
19051 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19052 "version": "0.0.0",
19053 "filename": "server/api/openchannelTransferReport/index.js",
19054 "groupTitle": "Openchannel_Transfer_Reports"
19058 "url": "/api/openchannel/reports/transfer/describe",
19059 "title": "Gets table info about Openchannel Transfer Reports",
19062 "title": "Example usage:",
19063 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19067 "name": "DescribeOpenchannel_Transfer_Reports",
19068 "group": "Openchannel_Transfer_Reports",
19069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19070 "version": "0.0.0",
19071 "filename": "server/api/openchannelTransferReport/index.js",
19072 "groupTitle": "Openchannel_Transfer_Reports"
19076 "url": "/api/openchannel/reports/transfer",
19077 "title": "Gets a list of Openchannel Transfer Reports",
19080 "title": "Example usage:",
19081 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19085 "name": "GetOpenchannel_Transfer_Reports",
19086 "group": "Openchannel_Transfer_Reports",
19087 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19088 "version": "0.0.0",
19089 "filename": "server/api/openchannelTransferReport/index.js",
19090 "groupTitle": "Openchannel_Transfer_Reports"
19094 "url": "/api/openchannel/reports/transfer/{id}",
19095 "title": "Gets a single Openchannel Transfer Report",
19098 "title": "Example usage:",
19099 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19103 "name": "ShowOpenchannel_Transfer_Reports",
19104 "group": "Openchannel_Transfer_Reports",
19105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19106 "version": "0.0.0",
19107 "filename": "server/api/openchannelTransferReport/index.js",
19108 "groupTitle": "Openchannel_Transfer_Reports"
19112 "url": "/api/openchannel/reports/transfer/{id}",
19113 "title": "Update an existing Openchannel Transfer Report",
19116 "title": "Example usage:",
19117 "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",
19121 "name": "updateOpenchannel_Transfer_Reports",
19122 "group": "Openchannel_Transfer_Reports",
19123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19124 "version": "0.0.0",
19125 "filename": "server/api/openchannelTransferReport/index.js",
19126 "groupTitle": "Openchannel_Transfer_Reports"
19130 "url": "/api/pauses",
19131 "title": "Creates a new Pause",
19134 "title": "Example usage:",
19135 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19139 "name": "CreatePauses",
19155 "field": "description",
19161 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19162 "version": "0.0.0",
19163 "filename": "server/api/pause/index.js",
19164 "groupTitle": "Pauses"
19168 "url": "/api/pauses/{id}",
19169 "title": "Deletes a Pause",
19172 "title": "Example usage:",
19173 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19177 "name": "DeletePauses",
19179 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19180 "version": "0.0.0",
19181 "filename": "server/api/pause/index.js",
19182 "groupTitle": "Pauses"
19186 "url": "/api/pauses",
19187 "title": "Gets a list of Pauses",
19190 "title": "Example usage:",
19191 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19195 "name": "GetPauses",
19197 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19198 "version": "0.0.0",
19199 "filename": "server/api/pause/index.js",
19200 "groupTitle": "Pauses"
19204 "url": "/api/pauses/{id}",
19205 "title": "Gets a single Pause",
19208 "title": "Example usage:",
19209 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19213 "name": "ShowPauses",
19215 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19216 "version": "0.0.0",
19217 "filename": "server/api/pause/index.js",
19218 "groupTitle": "Pauses"
19222 "url": "/api/pauses/{id}",
19223 "title": "Update an existing Pause",
19226 "title": "Example usage:",
19227 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19231 "name": "updatePauses",
19233 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19234 "version": "0.0.0",
19235 "filename": "server/api/pause/index.js",
19236 "groupTitle": "Pauses"
19240 "url": "/api/plugins",
19241 "title": "Gets a list of Plugins",
19244 "title": "Example usage:",
19245 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19249 "name": "GetPlugins",
19250 "group": "Plugins",
19251 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19252 "version": "0.0.0",
19253 "filename": "server/api/plugin/index.js",
19254 "groupTitle": "Plugins"
19258 "url": "/api/plugins/{id}",
19259 "title": "Gets a single Plugin",
19262 "title": "Example usage:",
19263 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19267 "name": "ShowPlugins",
19268 "group": "Plugins",
19269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19270 "version": "0.0.0",
19271 "filename": "server/api/plugin/index.js",
19272 "groupTitle": "Plugins"
19276 "url": "/api/plugins/{id}",
19277 "title": "Delete a plugin",
19280 "title": "Example usage:",
19281 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19285 "name": "destroyPlugin",
19286 "group": "Plugins",
19287 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19288 "version": "0.0.0",
19289 "filename": "server/api/plugin/index.js",
19290 "groupTitle": "Plugins"
19294 "url": "/api/plugins/{id}/download",
19295 "title": "Download plugin source code",
19298 "title": "Example usage:",
19299 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19303 "name": "download",
19304 "group": "Plugins",
19305 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19306 "version": "0.0.0",
19307 "filename": "server/api/plugin/index.js",
19308 "groupTitle": "Plugins"
19312 "url": "/api/plugins/{id}",
19313 "title": "Update an existing plugin",
19316 "title": "Example usage:",
19317 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19321 "name": "updatePlugin",
19322 "group": "Plugins",
19323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19324 "version": "0.0.0",
19325 "filename": "server/api/plugin/index.js",
19326 "groupTitle": "Plugins"
19330 "url": "/api/plugins",
19331 "title": "Upload new plugin",
19334 "title": "Example usage:",
19335 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19339 "name": "uploadPlugin",
19340 "group": "Plugins",
19341 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19342 "version": "0.0.0",
19343 "filename": "server/api/plugin/index.js",
19344 "groupTitle": "Plugins"
19348 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19349 "title": "Redirect a plugin request to the specified path",
19352 "title": "Example usage:",
19353 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19357 "name": "webhookPlugin",
19358 "group": "Plugins",
19359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19360 "version": "0.0.0",
19361 "filename": "server/api/plugin/index.js",
19362 "groupTitle": "Plugins"
19366 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19367 "title": "Redirect a plugin request to the specified path",
19370 "title": "Example usage:",
19371 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19375 "name": "webhookPlugin",
19376 "group": "Plugins",
19377 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19378 "version": "0.0.0",
19379 "filename": "server/api/plugin/index.js",
19380 "groupTitle": "Plugins"
19384 "url": "/api/pm2/{id}",
19385 "title": "Deletes an existing process",
19388 "title": "Example usage:",
19389 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19393 "name": "DeletePm2Process",
19395 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19396 "version": "0.0.0",
19397 "filename": "server/api/pm2/index.js",
19398 "groupTitle": "Pm2"
19402 "url": "/api/pm2/{id}",
19403 "title": "Gets a single pm2 process",
19406 "title": "Example usage:",
19407 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19411 "name": "GetPm2Process",
19413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19414 "version": "0.0.0",
19415 "filename": "server/api/pm2/index.js",
19416 "groupTitle": "Pm2"
19421 "title": "Gets pm2 processes",
19424 "title": "Example usage:",
19425 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19429 "name": "GetPm2Processes",
19431 "description": "<p>Motion returns the pm2 processes list.</p>",
19432 "version": "0.0.0",
19433 "filename": "server/api/pm2/index.js",
19434 "groupTitle": "Pm2"
19439 "title": "Start a single pm2 process",
19442 "title": "Example usage:",
19443 "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",
19447 "name": "StartPm2Process",
19469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19470 "version": "0.0.0",
19471 "filename": "server/api/pm2/index.js",
19472 "groupTitle": "Pm2"
19476 "url": "/api/pm2/{id}",
19477 "title": "Update an existing process",
19480 "title": "Example usage:",
19481 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19485 "name": "UpdatePm2Process",
19487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19488 "version": "0.0.0",
19489 "filename": "server/api/pm2/index.js",
19490 "groupTitle": "Pm2"
19494 "url": "/api/rpc/campaigns/",
19495 "title": "Gets a list of campaigns",
19498 "title": "Example usage:",
19499 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19503 "name": "Campaigns",
19504 "group": "RPC_Realtime",
19505 "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>",
19506 "version": "0.0.0",
19507 "filename": "server/api/rpc/index.js",
19508 "groupTitle": "RPC_Realtime"
19512 "url": "/api/rpc/fax/accounts",
19513 "title": "Gets a list of FaxAccounts",
19516 "title": "Example usage:",
19517 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19521 "name": "FaxAccounts",
19522 "group": "RPC_Realtime",
19523 "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>",
19524 "version": "0.0.0",
19525 "filename": "server/api/rpc/index.js",
19526 "groupTitle": "RPC_Realtime"
19530 "url": "/api/rpc/agents/:id/capacity",
19531 "title": "Sets agent capacity",
19534 "title": "Example usage:",
19535 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19539 "name": "RTAgentCapacity",
19540 "group": "RPC_Realtime",
19541 "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>",
19542 "version": "0.0.0",
19543 "filename": "server/api/rpc/index.js",
19544 "groupTitle": "RPC_Realtime"
19548 "url": "/api/rpc/agents",
19549 "title": "Gets a list of RTAgents",
19552 "title": "Example usage:",
19553 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19557 "name": "RTAgents",
19558 "group": "RPC_Realtime",
19559 "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>",
19560 "version": "0.0.0",
19561 "filename": "server/api/rpc/index.js",
19562 "groupTitle": "RPC_Realtime"
19566 "url": "/api/rpc/chat/queues",
19567 "title": "Gets a list of RTChatQueues",
19570 "title": "Example usage:",
19571 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19575 "name": "RTChatQueues",
19576 "group": "RPC_Realtime",
19577 "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>",
19578 "version": "0.0.0",
19579 "filename": "server/api/rpc/index.js",
19580 "groupTitle": "RPC_Realtime"
19584 "url": "/api/rpc/fax/queues",
19585 "title": "Gets a list of RTFaxQueues",
19588 "title": "Example usage:",
19589 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19593 "name": "RTFaxQueues",
19594 "group": "RPC_Realtime",
19595 "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>",
19596 "version": "0.0.0",
19597 "filename": "server/api/rpc/index.js",
19598 "groupTitle": "RPC_Realtime"
19602 "url": "/api/rpc/mail/accounts",
19603 "title": "Gets a list of RTMailAccounts",
19606 "title": "Example usage:",
19607 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19611 "name": "RTMailAccounts",
19612 "group": "RPC_Realtime",
19613 "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>",
19614 "version": "0.0.0",
19615 "filename": "server/api/rpc/index.js",
19616 "groupTitle": "RPC_Realtime"
19620 "url": "/api/rpc/mail/queues",
19621 "title": "Gets a list of RTMailQueues",
19624 "title": "Example usage:",
19625 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19629 "name": "RTMailQueues",
19630 "group": "RPC_Realtime",
19631 "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>",
19632 "version": "0.0.0",
19633 "filename": "server/api/rpc/index.js",
19634 "groupTitle": "RPC_Realtime"
19638 "url": "/api/rpc/openchannel/queues",
19639 "title": "Gets a list of RTOpenchannelQueues",
19642 "title": "Example usage:",
19643 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19647 "name": "RTOpenchannelQueues",
19648 "group": "RPC_Realtime",
19649 "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>",
19650 "version": "0.0.0",
19651 "filename": "server/api/rpc/index.js",
19652 "groupTitle": "RPC_Realtime"
19656 "url": "/api/rpc/outbound/channels",
19657 "title": "Gets a list of RTOutboundChannels",
19660 "title": "Example usage:",
19661 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19665 "name": "RTOutboundChannels",
19666 "group": "RPC_Realtime",
19667 "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>",
19668 "version": "0.0.0",
19669 "filename": "server/api/rpc/index.js",
19670 "groupTitle": "RPC_Realtime"
19674 "url": "/api/rpc/sms/queues",
19675 "title": "Gets a list of RTSmsQueues",
19678 "title": "Example usage:",
19679 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19683 "name": "RTSmsQueues",
19684 "group": "RPC_Realtime",
19685 "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>",
19686 "version": "0.0.0",
19687 "filename": "server/api/rpc/index.js",
19688 "groupTitle": "RPC_Realtime"
19692 "url": "/api/rpc/telephones",
19693 "title": "Gets a list of RTTelephones",
19696 "title": "Example usage:",
19697 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19701 "name": "RTTelephones",
19702 "group": "RPC_Realtime",
19703 "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>",
19704 "version": "0.0.0",
19705 "filename": "server/api/rpc/index.js",
19706 "groupTitle": "RPC_Realtime"
19710 "url": "/api/rpc/trunks",
19711 "title": "Gets a list of RTTrunks",
19714 "title": "Example usage:",
19715 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19719 "name": "RTTrunks",
19720 "group": "RPC_Realtime",
19721 "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>",
19722 "version": "0.0.0",
19723 "filename": "server/api/rpc/index.js",
19724 "groupTitle": "RPC_Realtime"
19728 "url": "/api/rpc/voice/channels",
19729 "title": "Gets a list of RTVoiceChannelMixMonitor",
19732 "title": "Example usage:",
19733 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19737 "name": "RTVoiceChannelMixMonitor",
19738 "group": "RPC_Realtime",
19739 "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>",
19740 "version": "0.0.0",
19741 "filename": "server/api/rpc/index.js",
19742 "groupTitle": "RPC_Realtime"
19746 "url": "/api/rpc/voice/channels",
19747 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19750 "title": "Example usage:",
19751 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19755 "name": "RTVoiceChannelStopMixMonitor",
19756 "group": "RPC_Realtime",
19757 "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>",
19758 "version": "0.0.0",
19759 "filename": "server/api/rpc/index.js",
19760 "groupTitle": "RPC_Realtime"
19764 "url": "/api/rpc/voice/channels",
19765 "title": "Gets a list of RTVoiceChannels",
19768 "title": "Example usage:",
19769 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19773 "name": "RTVoiceChannels",
19774 "group": "RPC_Realtime",
19775 "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>",
19776 "version": "0.0.0",
19777 "filename": "server/api/rpc/index.js",
19778 "groupTitle": "RPC_Realtime"
19782 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19783 "title": "Gets a single RTVoiceQueueChannel",
19786 "title": "Example usage:",
19787 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19791 "name": "RTVoiceQueueChannel",
19792 "group": "RPC_Realtime",
19793 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19794 "version": "0.0.0",
19795 "filename": "server/api/rpc/index.js",
19796 "groupTitle": "RPC_Realtime"
19800 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19801 "title": "Hangup a single RTVoiceQueueChannel",
19804 "title": "Example usage:",
19805 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19809 "name": "RTVoiceQueueChannelHangup",
19810 "group": "RPC_Realtime",
19811 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19812 "version": "0.0.0",
19813 "filename": "server/api/rpc/index.js",
19814 "groupTitle": "RPC_Realtime"
19818 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19819 "title": "Hangup a single RTVoiceQueueChannel",
19822 "title": "Example usage:",
19823 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19827 "name": "RTVoiceQueueChannelRedirect",
19828 "group": "RPC_Realtime",
19829 "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>",
19830 "version": "0.0.0",
19831 "filename": "server/api/rpc/index.js",
19832 "groupTitle": "RPC_Realtime"
19836 "url": "/api/rpc/voice/queues/preview/{id}",
19837 "title": "Gets a single preview contact",
19840 "title": "Example usage:",
19841 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19845 "name": "RTVoiceQueuePreview",
19846 "group": "RPC_Realtime",
19847 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19848 "version": "0.0.0",
19849 "filename": "server/api/rpc/index.js",
19850 "groupTitle": "RPC_Realtime"
19854 "url": "/api/rpc/outbound",
19855 "title": "Gets a list of RTOutbound",
19858 "title": "Example usage:",
19859 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19863 "name": "RTVoiceQueues",
19864 "group": "RPC_Realtime",
19865 "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>",
19866 "version": "0.0.0",
19867 "filename": "server/api/rpc/index.js",
19868 "groupTitle": "RPC_Realtime"
19872 "url": "/api/rpc/voice/queues",
19873 "title": "Gets a list of RTVoiceQueues",
19876 "title": "Example usage:",
19877 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19881 "name": "RTVoiceQueues",
19882 "group": "RPC_Realtime",
19883 "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>",
19884 "version": "0.0.0",
19885 "filename": "server/api/rpc/index.js",
19886 "groupTitle": "RPC_Realtime"
19890 "url": "/api/rpc/voice/queues/channels",
19891 "title": "Gets a list of RTVoiceQueuesChannels",
19894 "title": "Example usage:",
19895 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19899 "name": "RTVoiceQueuesChannels",
19900 "group": "RPC_Realtime",
19901 "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>",
19902 "version": "0.0.0",
19903 "filename": "server/api/rpc/index.js",
19904 "groupTitle": "RPC_Realtime"
19908 "url": "/api/rpc/chat/queues/{id}",
19909 "title": "Gets a single RTChatQueue",
19912 "title": "Example usage:",
19913 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19917 "name": "ShowRTChatQueues",
19918 "group": "RPC_Realtime",
19919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19920 "version": "0.0.0",
19921 "filename": "server/api/rpc/index.js",
19922 "groupTitle": "RPC_Realtime"
19926 "url": "/api/rpc/fax/queues/{id}",
19927 "title": "Gets a single RTFaxQueue",
19930 "title": "Example usage:",
19931 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19935 "name": "ShowRTFaxQueues",
19936 "group": "RPC_Realtime",
19937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19938 "version": "0.0.0",
19939 "filename": "server/api/rpc/index.js",
19940 "groupTitle": "RPC_Realtime"
19944 "url": "/api/rpc/mail/queues/{id}",
19945 "title": "Gets a single RTMailQueue",
19948 "title": "Example usage:",
19949 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19953 "name": "ShowRTMailQueues",
19954 "group": "RPC_Realtime",
19955 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19956 "version": "0.0.0",
19957 "filename": "server/api/rpc/index.js",
19958 "groupTitle": "RPC_Realtime"
19962 "url": "/api/rpc/openchannel/queues/{id}",
19963 "title": "Gets a single RTOpenchannelQueue",
19966 "title": "Example usage:",
19967 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19971 "name": "ShowRTOpenchannelQueues",
19972 "group": "RPC_Realtime",
19973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19974 "version": "0.0.0",
19975 "filename": "server/api/rpc/index.js",
19976 "groupTitle": "RPC_Realtime"
19980 "url": "/api/rpc/sms/queues/{id}",
19981 "title": "Gets a single RTSmsQueue",
19984 "title": "Example usage:",
19985 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19989 "name": "ShowRTSmsQueues",
19990 "group": "RPC_Realtime",
19991 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19992 "version": "0.0.0",
19993 "filename": "server/api/rpc/index.js",
19994 "groupTitle": "RPC_Realtime"
19998 "url": "/api/rpc/voice/queues/{id}",
19999 "title": "Gets a single RTVoiceQueue",
20002 "title": "Example usage:",
20003 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20007 "name": "ShowRTVoiceQueues",
20008 "group": "RPC_Realtime",
20009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20010 "version": "0.0.0",
20011 "filename": "server/api/rpc/index.js",
20012 "groupTitle": "RPC_Realtime"
20016 "url": "/api/rpc/agents/:id/notify",
20017 "title": "Notify message to a specific agent",
20020 "title": "Example usage:",
20021 "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",
20025 "name": "agentNotify",
20026 "group": "RPC_Realtime",
20027 "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>",
20028 "version": "0.0.0",
20029 "filename": "server/api/rpc/index.js",
20030 "groupTitle": "RPC_Realtime"
20034 "url": "/api/rpc/chat/queues/:id/notify",
20035 "title": "Notify message to a specific queue",
20038 "title": "Example usage:",
20039 "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",
20043 "name": "chatQueueNotify",
20044 "group": "RPC_Realtime",
20045 "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>",
20046 "version": "0.0.0",
20047 "filename": "server/api/rpc/index.js",
20048 "groupTitle": "RPC_Realtime"
20052 "url": "/api/rpc/chat/queues/waitinginteractions",
20053 "title": "Gets a list of chatQueuesWaitingInteractions",
20056 "title": "Example usage:",
20057 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20061 "name": "chatQueuesWaitingInteractions",
20062 "group": "RPC_Realtime",
20063 "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>",
20064 "version": "0.0.0",
20065 "filename": "server/api/rpc/index.js",
20066 "groupTitle": "RPC_Realtime"
20070 "url": "/api/rpc/fax/queues/:id/notify",
20071 "title": "Notify message to a specific queue",
20074 "title": "Example usage:",
20075 "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",
20079 "name": "faxQueueNotify",
20080 "group": "RPC_Realtime",
20081 "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>",
20082 "version": "0.0.0",
20083 "filename": "server/api/rpc/index.js",
20084 "groupTitle": "RPC_Realtime"
20088 "url": "/api/rpc/fax/queues/waitinginteractions",
20089 "title": "Gets a list of faxQueuesWaitingInteractions",
20092 "title": "Example usage:",
20093 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20097 "name": "faxQueuesWaitingInteractions",
20098 "group": "RPC_Realtime",
20099 "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>",
20100 "version": "0.0.0",
20101 "filename": "server/api/rpc/index.js",
20102 "groupTitle": "RPC_Realtime"
20106 "url": "/api/rpc/mail/queues/:id/notify",
20107 "title": "Notify message to a specific queue",
20110 "title": "Example usage:",
20111 "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",
20115 "name": "mailQueueNotify",
20116 "group": "RPC_Realtime",
20117 "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>",
20118 "version": "0.0.0",
20119 "filename": "server/api/rpc/index.js",
20120 "groupTitle": "RPC_Realtime"
20124 "url": "/api/rpc/mail/queues/waitinginteractions",
20125 "title": "Gets a list of mailQueuesWaitingInteractions",
20128 "title": "Example usage:",
20129 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20133 "name": "mailQueuesWaitingInteractions",
20134 "group": "RPC_Realtime",
20135 "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>",
20136 "version": "0.0.0",
20137 "filename": "server/api/rpc/index.js",
20138 "groupTitle": "RPC_Realtime"
20142 "url": "/api/rpc/openchannel/queues/:id/notify",
20143 "title": "Notify message to a specific queue",
20146 "title": "Example usage:",
20147 "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",
20151 "name": "openchannelQueueNotify",
20152 "group": "RPC_Realtime",
20153 "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>",
20154 "version": "0.0.0",
20155 "filename": "server/api/rpc/index.js",
20156 "groupTitle": "RPC_Realtime"
20160 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20161 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20164 "title": "Example usage:",
20165 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20169 "name": "openchannelQueuesIdWaitingInteractions",
20170 "group": "RPC_Realtime",
20171 "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>",
20172 "version": "0.0.0",
20173 "filename": "server/api/rpc/index.js",
20174 "groupTitle": "RPC_Realtime"
20178 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20179 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20182 "title": "Example usage:",
20183 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20187 "name": "openchannelQueuesWaitingInteractions",
20188 "group": "RPC_Realtime",
20189 "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>",
20190 "version": "0.0.0",
20191 "filename": "server/api/rpc/index.js",
20192 "groupTitle": "RPC_Realtime"
20196 "url": "/api/rpc/sms/queues/:id/notify",
20197 "title": "Notify message to a specific queue",
20200 "title": "Example usage:",
20201 "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",
20205 "name": "smsQueueNotify",
20206 "group": "RPC_Realtime",
20207 "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>",
20208 "version": "0.0.0",
20209 "filename": "server/api/rpc/index.js",
20210 "groupTitle": "RPC_Realtime"
20214 "url": "/api/rpc/sms/queues/waitinginteractions",
20215 "title": "Gets a list of smsQueuesWaitingInteractions",
20218 "title": "Example usage:",
20219 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20223 "name": "smsQueuesWaitingInteractions",
20224 "group": "RPC_Realtime",
20225 "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>",
20226 "version": "0.0.0",
20227 "filename": "server/api/rpc/index.js",
20228 "groupTitle": "RPC_Realtime"
20232 "url": "/api/integrations/salesforce/accounts",
20233 "title": "Creates a new Salesforce Account",
20236 "title": "Example usage:",
20237 "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",
20241 "name": "CreateSalesforce_Accounts",
20242 "group": "Salesforce_Accounts",
20257 "field": "description",
20264 "field": "username",
20271 "field": "remoteUri",
20278 "field": "password",
20285 "field": "clientId",
20292 "field": "clientSecret",
20299 "field": "securityToken",
20306 "field": "serverUrl",
20313 "\"integrationTab\"",
20323 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20324 "version": "0.0.0",
20325 "filename": "server/api/intSalesforceAccount/index.js",
20326 "groupTitle": "Salesforce_Accounts"
20330 "url": "/api/integrations/salesforce/accounts/{id}",
20331 "title": "Deletes a Salesforce Account",
20334 "title": "Example usage:",
20335 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20339 "name": "DeleteSalesforce_Accounts",
20340 "group": "Salesforce_Accounts",
20341 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20342 "version": "0.0.0",
20343 "filename": "server/api/intSalesforceAccount/index.js",
20344 "groupTitle": "Salesforce_Accounts"
20348 "url": "/api/integrations/salesforce/accounts",
20349 "title": "Gets a list of Salesforce Accounts",
20352 "title": "Example usage:",
20353 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20357 "name": "GetSalesforce_Accounts",
20358 "group": "Salesforce_Accounts",
20359 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20360 "version": "0.0.0",
20361 "filename": "server/api/intSalesforceAccount/index.js",
20362 "groupTitle": "Salesforce_Accounts"
20366 "url": "/api/integrations/salesforce/accounts/{id}",
20367 "title": "Gets a single Salesforce Account",
20370 "title": "Example usage:",
20371 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20375 "name": "ShowSalesforce_Accounts",
20376 "group": "Salesforce_Accounts",
20377 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20378 "version": "0.0.0",
20379 "filename": "server/api/intSalesforceAccount/index.js",
20380 "groupTitle": "Salesforce_Accounts"
20384 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20385 "title": "Creates new configuration",
20388 "title": "Example usage:",
20389 "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",
20393 "name": "addConfiguration",
20394 "group": "Salesforce_Accounts",
20395 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20396 "version": "0.0.0",
20397 "filename": "server/api/intSalesforceAccount/index.js",
20398 "groupTitle": "Salesforce_Accounts"
20402 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20403 "title": "Gets account configurations",
20406 "title": "Example usage:",
20407 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20411 "name": "getConfigurations",
20412 "group": "Salesforce_Accounts",
20413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20414 "version": "0.0.0",
20415 "filename": "server/api/intSalesforceAccount/index.js",
20416 "groupTitle": "Salesforce_Accounts"
20420 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20421 "title": "Gets account fields",
20424 "title": "Example usage:",
20425 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20429 "name": "getFields",
20430 "group": "Salesforce_Accounts",
20431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20432 "version": "0.0.0",
20433 "filename": "server/api/intSalesforceAccount/index.js",
20434 "groupTitle": "Salesforce_Accounts"
20438 "url": "/api/integrations/salesforce/accounts/{id}",
20439 "title": "Update an existing Salesforce Account",
20442 "title": "Example usage:",
20443 "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",
20447 "name": "updateSalesforce_Accounts",
20448 "group": "Salesforce_Accounts",
20449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20450 "version": "0.0.0",
20451 "filename": "server/api/intSalesforceAccount/index.js",
20452 "groupTitle": "Salesforce_Accounts"
20456 "url": "/api/integrations/salesforce/configurations",
20457 "title": "Creates a new Salesforce Configuration",
20460 "title": "Example usage:",
20461 "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",
20465 "name": "CreateSalesforce_Configurations",
20466 "group": "Salesforce_Configurations",
20481 "field": "description",
20492 "field": "ticketType",
20499 "\"contact_lead\"",
20504 "field": "moduleSearch",
20516 "field": "moduleCreate",
20522 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20523 "version": "0.0.0",
20524 "filename": "server/api/intSalesforceConfiguration/index.js",
20525 "groupTitle": "Salesforce_Configurations"
20529 "url": "/api/integrations/salesforce/configurations/{id}",
20530 "title": "Deletes a Salesforce Configuration",
20533 "title": "Example usage:",
20534 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20538 "name": "DeleteSalesforce_Configurations",
20539 "group": "Salesforce_Configurations",
20540 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20541 "version": "0.0.0",
20542 "filename": "server/api/intSalesforceConfiguration/index.js",
20543 "groupTitle": "Salesforce_Configurations"
20547 "url": "/api/integrations/salesforce/configurations",
20548 "title": "Gets a list of Salesforce Configurations",
20551 "title": "Example usage:",
20552 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20556 "name": "GetSalesforce_Configurations",
20557 "group": "Salesforce_Configurations",
20558 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20559 "version": "0.0.0",
20560 "filename": "server/api/intSalesforceConfiguration/index.js",
20561 "groupTitle": "Salesforce_Configurations"
20565 "url": "/api/integrations/salesforce/configurations/{id}",
20566 "title": "Gets a single Salesforce Configuration",
20569 "title": "Example usage:",
20570 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20574 "name": "ShowSalesforce_Configurations",
20575 "group": "Salesforce_Configurations",
20576 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20577 "version": "0.0.0",
20578 "filename": "server/api/intSalesforceConfiguration/index.js",
20579 "groupTitle": "Salesforce_Configurations"
20583 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20584 "title": "Gets configurations descriptions",
20587 "title": "Example usage:",
20588 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20592 "name": "getDescriptions",
20593 "group": "Salesforce_Configurations",
20594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20595 "version": "0.0.0",
20596 "filename": "server/api/intSalesforceConfiguration/index.js",
20597 "groupTitle": "Salesforce_Configurations"
20601 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20602 "title": "Gets configurations fields",
20605 "title": "Example usage:",
20606 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20610 "name": "getFields",
20611 "group": "Salesforce_Configurations",
20612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20613 "version": "0.0.0",
20614 "filename": "server/api/intSalesforceConfiguration/index.js",
20615 "groupTitle": "Salesforce_Configurations"
20619 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20620 "title": "Gets configurations subjects",
20623 "title": "Example usage:",
20624 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20628 "name": "getSubjects",
20629 "group": "Salesforce_Configurations",
20630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20631 "version": "0.0.0",
20632 "filename": "server/api/intSalesforceConfiguration/index.js",
20633 "groupTitle": "Salesforce_Configurations"
20637 "url": "/api/integrations/salesforce/configurations/{id}",
20638 "title": "Update an existing Salesforce Configuration",
20641 "title": "Example usage:",
20642 "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",
20646 "name": "updateSalesforce_Configurations",
20647 "group": "Salesforce_Configurations",
20648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20649 "version": "0.0.0",
20650 "filename": "server/api/intSalesforceConfiguration/index.js",
20651 "groupTitle": "Salesforce_Configurations"
20655 "url": "/api/integrations/salesforce/fields",
20656 "title": "Creates a new Salesforce Field",
20659 "title": "Example usage:",
20660 "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",
20664 "name": "CreateSalesforce_Fields",
20665 "group": "Salesforce_Fields",
20675 "\"customVariable\"",
20686 "field": "content",
20702 "\"customVariable\""
20705 "field": "keyType",
20712 "field": "keyContent",
20719 "field": "idField",
20726 "field": "variableName",
20732 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20733 "version": "0.0.0",
20734 "filename": "server/api/intSalesforceField/index.js",
20735 "groupTitle": "Salesforce_Fields"
20739 "url": "/api/integrations/salesforce/fields/{id}",
20740 "title": "Deletes a Salesforce Field",
20743 "title": "Example usage:",
20744 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20748 "name": "DeleteSalesforce_Fields",
20749 "group": "Salesforce_Fields",
20750 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20751 "version": "0.0.0",
20752 "filename": "server/api/intSalesforceField/index.js",
20753 "groupTitle": "Salesforce_Fields"
20757 "url": "/api/integrations/salesforce/fields",
20758 "title": "Gets a list of Salesforce Fields",
20761 "title": "Example usage:",
20762 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20766 "name": "GetSalesforce_Fields",
20767 "group": "Salesforce_Fields",
20768 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20769 "version": "0.0.0",
20770 "filename": "server/api/intSalesforceField/index.js",
20771 "groupTitle": "Salesforce_Fields"
20775 "url": "/api/integrations/salesforce/fields/{id}",
20776 "title": "Gets a single Salesforce Field",
20779 "title": "Example usage:",
20780 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20784 "name": "ShowSalesforce_Fields",
20785 "group": "Salesforce_Fields",
20786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20787 "version": "0.0.0",
20788 "filename": "server/api/intSalesforceField/index.js",
20789 "groupTitle": "Salesforce_Fields"
20793 "url": "/api/integrations/salesforce/fields/{id}",
20794 "title": "Update an existing Salesforce Field",
20797 "title": "Example usage:",
20798 "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",
20802 "name": "updateSalesforce_Fields",
20803 "group": "Salesforce_Fields",
20804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/schedules",
20812 "title": "Creates a new Schedule",
20815 "title": "Example usage:",
20816 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20820 "name": "CreateSchedules",
20821 "group": "Schedules",
20836 "field": "description",
20857 "field": "startAt",
20871 "field": "subtractNumber",
20887 "field": "subtractUnit",
20917 "field": "sendMail",
20945 "field": "sendIfEmpty",
20951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20952 "version": "0.0.0",
20953 "filename": "server/api/schedule/index.js",
20954 "groupTitle": "Schedules"
20958 "url": "/api/schedules/{id}",
20959 "title": "Deletes a Schedule",
20962 "title": "Example usage:",
20963 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20967 "name": "DeleteSchedules",
20968 "group": "Schedules",
20969 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20970 "version": "0.0.0",
20971 "filename": "server/api/schedule/index.js",
20972 "groupTitle": "Schedules"
20976 "url": "/api/schedules",
20977 "title": "Gets a list of Schedules",
20980 "title": "Example usage:",
20981 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20985 "name": "GetSchedules",
20986 "group": "Schedules",
20987 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20988 "version": "0.0.0",
20989 "filename": "server/api/schedule/index.js",
20990 "groupTitle": "Schedules"
20994 "url": "/api/schedules/{id}",
20995 "title": "Gets a single Schedule",
20998 "title": "Example usage:",
20999 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21003 "name": "ShowSchedules",
21004 "group": "Schedules",
21005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21006 "version": "0.0.0",
21007 "filename": "server/api/schedule/index.js",
21008 "groupTitle": "Schedules"
21012 "url": "/api/schedules/{id}/run",
21013 "title": "Run Scheduler",
21016 "title": "Example usage:",
21017 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21022 "group": "Schedules",
21023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Update an existing Schedule",
21034 "title": "Example usage:",
21035 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21039 "name": "updateSchedules",
21040 "group": "Schedules",
21041 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/screen/recordings",
21049 "title": "Creates a new Recording",
21052 "title": "Example usage:",
21053 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21057 "name": "CreateRecordings",
21058 "group": "Screen_Recordings",
21073 "field": "interactionid",
21080 "field": "channel",
21101 "field": "duration",
21108 "field": "startedAt",
21115 "field": "closedAt",
21122 "field": "createdAt",
21129 "field": "updatedAt",
21135 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21136 "version": "0.0.0",
21137 "filename": "server/api/screenRecording/index.js",
21138 "groupTitle": "Screen_Recordings"
21142 "url": "/api/screen/recordings/describe",
21143 "title": "Gets table info about Recordings",
21146 "title": "Example usage:",
21147 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21151 "name": "DescribeRecordings",
21152 "group": "Screen_Recordings",
21153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21154 "version": "0.0.0",
21155 "filename": "server/api/screenRecording/index.js",
21156 "groupTitle": "Screen_Recordings"
21160 "url": "/api/screen/recordings",
21161 "title": "Gets a list of Recordings",
21164 "title": "Example usage:",
21165 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21169 "name": "GetRecordings",
21170 "group": "Screen_Recordings",
21171 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21172 "version": "0.0.0",
21173 "filename": "server/api/screenRecording/index.js",
21174 "groupTitle": "Screen_Recordings"
21178 "url": "/api/screen/recordings/{id}",
21179 "title": "Gets a single Recording",
21182 "title": "Example usage:",
21183 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21187 "name": "ShowRecordings",
21188 "group": "Screen_Recordings",
21189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21190 "version": "0.0.0",
21191 "filename": "server/api/screenRecording/index.js",
21192 "groupTitle": "Screen_Recordings"
21196 "url": "/api/screen/recordings/{id}",
21197 "title": "Delete screen recording",
21200 "title": "Example usage:",
21201 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21206 "group": "Screen_Recordings",
21207 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/{id}/download",
21215 "title": "Download Recording",
21218 "title": "Example usage:",
21219 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21223 "name": "download",
21224 "group": "Screen_Recordings",
21225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/{id}",
21233 "title": "Update an existing Recording",
21236 "title": "Example usage:",
21237 "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",
21241 "name": "updateRecordings",
21242 "group": "Screen_Recordings",
21243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21244 "version": "0.0.0",
21245 "filename": "server/api/screenRecording/index.js",
21246 "groupTitle": "Screen_Recordings"
21250 "url": "/api/integrations/servicenow/accounts",
21251 "title": "Creates a new Servicenow Account",
21254 "title": "Example usage:",
21255 "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",
21259 "name": "CreateServicenow_Accounts",
21260 "group": "Servicenow_Accounts",
21275 "field": "description",
21282 "field": "username",
21289 "field": "password",
21303 "field": "remoteUri",
21310 "field": "serverUrl",
21316 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21317 "version": "0.0.0",
21318 "filename": "server/api/intServicenowAccount/index.js",
21319 "groupTitle": "Servicenow_Accounts"
21323 "url": "/api/integrations/servicenow/accounts/{id}",
21324 "title": "Deletes a Servicenow Account",
21327 "title": "Example usage:",
21328 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21332 "name": "DeleteServicenow_Accounts",
21333 "group": "Servicenow_Accounts",
21334 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21335 "version": "0.0.0",
21336 "filename": "server/api/intServicenowAccount/index.js",
21337 "groupTitle": "Servicenow_Accounts"
21341 "url": "/api/integrations/servicenow/accounts",
21342 "title": "Gets a list of Servicenow Accounts",
21345 "title": "Example usage:",
21346 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21350 "name": "GetServicenow_Accounts",
21351 "group": "Servicenow_Accounts",
21352 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21353 "version": "0.0.0",
21354 "filename": "server/api/intServicenowAccount/index.js",
21355 "groupTitle": "Servicenow_Accounts"
21359 "url": "/api/integrations/servicenow/accounts/{id}",
21360 "title": "Gets a single Servicenow Account",
21363 "title": "Example usage:",
21364 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21368 "name": "ShowServicenow_Accounts",
21369 "group": "Servicenow_Accounts",
21370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21371 "version": "0.0.0",
21372 "filename": "server/api/intServicenowAccount/index.js",
21373 "groupTitle": "Servicenow_Accounts"
21377 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21378 "title": "Creates new configuration",
21381 "title": "Example usage:",
21382 "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",
21386 "name": "addConfiguration",
21387 "group": "Servicenow_Accounts",
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}/configurations",
21396 "title": "Gets account configurations",
21399 "title": "Example usage:",
21400 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21404 "name": "getConfigurations",
21405 "group": "Servicenow_Accounts",
21406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/{id}/fields",
21414 "title": "Gets account fields",
21417 "title": "Example usage:",
21418 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21422 "name": "getFields",
21423 "group": "Servicenow_Accounts",
21424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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": "Update an existing Servicenow Account",
21435 "title": "Example usage:",
21436 "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",
21440 "name": "updateServicenow_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/configurations",
21450 "title": "Creates a new Servicenow Configuration",
21453 "title": "Example usage:",
21454 "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",
21458 "name": "CreateServicenow_Configurations",
21459 "group": "Servicenow_Configurations",
21474 "field": "description",
21480 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21481 "version": "0.0.0",
21482 "filename": "server/api/intServicenowConfiguration/index.js",
21483 "groupTitle": "Servicenow_Configurations"
21487 "url": "/api/integrations/servicenow/configurations/{id}",
21488 "title": "Deletes a Servicenow Configuration",
21491 "title": "Example usage:",
21492 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21496 "name": "DeleteServicenow_Configurations",
21497 "group": "Servicenow_Configurations",
21498 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21499 "version": "0.0.0",
21500 "filename": "server/api/intServicenowConfiguration/index.js",
21501 "groupTitle": "Servicenow_Configurations"
21505 "url": "/api/integrations/servicenow/configurations",
21506 "title": "Gets a list of Servicenow Configurations",
21509 "title": "Example usage:",
21510 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21514 "name": "GetServicenow_Configurations",
21515 "group": "Servicenow_Configurations",
21516 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21517 "version": "0.0.0",
21518 "filename": "server/api/intServicenowConfiguration/index.js",
21519 "groupTitle": "Servicenow_Configurations"
21523 "url": "/api/integrations/servicenow/configurations/{id}",
21524 "title": "Gets a single Servicenow Configuration",
21527 "title": "Example usage:",
21528 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21532 "name": "ShowServicenow_Configurations",
21533 "group": "Servicenow_Configurations",
21534 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21535 "version": "0.0.0",
21536 "filename": "server/api/intServicenowConfiguration/index.js",
21537 "groupTitle": "Servicenow_Configurations"
21541 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21542 "title": "Gets configurations descriptions",
21545 "title": "Example usage:",
21546 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21550 "name": "getDescriptions",
21551 "group": "Servicenow_Configurations",
21552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
21560 "title": "Gets configurations fields",
21563 "title": "Example usage:",
21564 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21568 "name": "getFields",
21569 "group": "Servicenow_Configurations",
21570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/{id}/subjects",
21578 "title": "Gets configurations subjects",
21581 "title": "Example usage:",
21582 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21586 "name": "getSubjects",
21587 "group": "Servicenow_Configurations",
21588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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": "Update an existing Servicenow Configuration",
21599 "title": "Example usage:",
21600 "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",
21604 "name": "updateServicenow_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/fields",
21614 "title": "Creates a new Servicenow Field",
21617 "title": "Example usage:",
21618 "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",
21622 "name": "CreateServicenow_Fields",
21623 "group": "Servicenow_Fields",
21633 "\"customVariable\"",
21644 "field": "content",
21660 "\"customVariable\""
21663 "field": "keyType",
21670 "field": "keyContent",
21677 "field": "idField",
21684 "field": "nameField",
21691 "field": "customField",
21698 "field": "variableName",
21704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21705 "version": "0.0.0",
21706 "filename": "server/api/intServicenowField/index.js",
21707 "groupTitle": "Servicenow_Fields"
21711 "url": "/api/integrations/servicenow/fields/{id}",
21712 "title": "Deletes a Servicenow Field",
21715 "title": "Example usage:",
21716 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21720 "name": "DeleteServicenow_Fields",
21721 "group": "Servicenow_Fields",
21722 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21723 "version": "0.0.0",
21724 "filename": "server/api/intServicenowField/index.js",
21725 "groupTitle": "Servicenow_Fields"
21729 "url": "/api/integrations/servicenow/fields",
21730 "title": "Gets a list of Servicenow Fields",
21733 "title": "Example usage:",
21734 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21738 "name": "GetServicenow_Fields",
21739 "group": "Servicenow_Fields",
21740 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21741 "version": "0.0.0",
21742 "filename": "server/api/intServicenowField/index.js",
21743 "groupTitle": "Servicenow_Fields"
21747 "url": "/api/integrations/servicenow/fields/{id}",
21748 "title": "Gets a single Servicenow Field",
21751 "title": "Example usage:",
21752 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21756 "name": "ShowServicenow_Fields",
21757 "group": "Servicenow_Fields",
21758 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21759 "version": "0.0.0",
21760 "filename": "server/api/intServicenowField/index.js",
21761 "groupTitle": "Servicenow_Fields"
21765 "url": "/api/integrations/servicenow/fields/{id}",
21766 "title": "Update an existing Servicenow Field",
21769 "title": "Example usage:",
21770 "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",
21774 "name": "updateServicenow_Fields",
21775 "group": "Servicenow_Fields",
21776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21777 "version": "0.0.0",
21778 "filename": "server/api/intServicenowField/index.js",
21779 "groupTitle": "Servicenow_Fields"
21783 "url": "/api/settings",
21784 "title": "Gets a list of Settings",
21787 "title": "Example usage:",
21788 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21792 "name": "GetSettings",
21793 "group": "Settings",
21794 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21795 "version": "0.0.0",
21796 "filename": "server/api/setting/index.js",
21797 "groupTitle": "Settings"
21801 "url": "/api/settings/{id}",
21802 "title": "Gets a single Setting",
21805 "title": "Example usage:",
21806 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21810 "name": "ShowSettings",
21811 "group": "Settings",
21812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21813 "version": "0.0.0",
21814 "filename": "server/api/setting/index.js",
21815 "groupTitle": "Settings"
21819 "url": "/api/settings/{id}/favicon",
21820 "title": "Add Favicon",
21823 "title": "Example usage:",
21824 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21828 "name": "addFavicon",
21829 "group": "Settings",
21830 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21831 "version": "0.0.0",
21832 "filename": "server/api/setting/index.js",
21833 "groupTitle": "Settings"
21837 "url": "/api/settings/{id}/logo",
21838 "title": "Add logo",
21841 "title": "Example usage:",
21842 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21847 "group": "Settings",
21848 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21849 "version": "0.0.0",
21850 "filename": "server/api/setting/index.js",
21851 "groupTitle": "Settings"
21855 "url": "/api/settings/{id}/logo_login",
21856 "title": "Add logo login",
21859 "title": "Example usage:",
21860 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21864 "name": "addLogoLogin",
21865 "group": "Settings",
21866 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21867 "version": "0.0.0",
21868 "filename": "server/api/setting/index.js",
21869 "groupTitle": "Settings"
21873 "url": "/api/settings/{id}/preferred",
21874 "title": "Add Preferred",
21877 "title": "Example usage:",
21878 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21882 "name": "addPreferred",
21883 "group": "Settings",
21884 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21885 "version": "0.0.0",
21886 "filename": "server/api/setting/index.js",
21887 "groupTitle": "Settings"
21891 "url": "/api/settings/now",
21892 "title": "Get Server Current Date",
21895 "title": "Example usage:",
21896 "content": "curl https://{domain}/api/settings/now -v -X GET",
21901 "group": "Settings",
21902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21903 "version": "0.0.0",
21904 "filename": "server/api/setting/index.js",
21905 "groupTitle": "Settings"
21909 "url": "/api/settings/{id}/favicon",
21910 "title": "Get Favicon",
21913 "title": "Example usage:",
21914 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21918 "name": "getFavicon",
21919 "group": "Settings",
21920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21921 "version": "0.0.0",
21922 "filename": "server/api/setting/index.js",
21923 "groupTitle": "Settings"
21927 "url": "/api/settings/{id}/gdpr",
21928 "title": "Get gdpr settings",
21931 "title": "Example usage:",
21932 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21937 "group": "Settings",
21938 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21939 "version": "0.0.0",
21940 "filename": "server/api/setting/index.js",
21941 "groupTitle": "Settings"
21945 "url": "/api/settings/{id}/logo",
21946 "title": "Get logo",
21949 "title": "Example usage:",
21950 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21955 "group": "Settings",
21956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21957 "version": "0.0.0",
21958 "filename": "server/api/setting/index.js",
21959 "groupTitle": "Settings"
21963 "url": "/api/settings/{id}/logo_login",
21964 "title": "Get logo login",
21967 "title": "Example usage:",
21968 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21972 "name": "getLogoLogin",
21973 "group": "Settings",
21974 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21975 "version": "0.0.0",
21976 "filename": "server/api/setting/index.js",
21977 "groupTitle": "Settings"
21981 "url": "/api/settings/{id}/preferred",
21982 "title": "Get Preferred",
21985 "title": "Example usage:",
21986 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21990 "name": "getPreferred",
21991 "group": "Settings",
21992 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21993 "version": "0.0.0",
21994 "filename": "server/api/setting/index.js",
21995 "groupTitle": "Settings"
21999 "url": "/api/settings/{id}",
22000 "title": "Update an existing Setting",
22003 "title": "Example usage:",
22004 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22008 "name": "updateSettings",
22009 "group": "Settings",
22010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22011 "version": "0.0.0",
22012 "filename": "server/api/setting/index.js",
22013 "groupTitle": "Settings"
22017 "url": "/api/sms/accounts/{id}/users",
22018 "title": "Add agents to a sms account",
22021 "title": "Example usage:",
22022 "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",
22026 "name": "AddAgents",
22027 "group": "Sms_Accounts",
22028 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029 "version": "0.0.0",
22030 "filename": "server/api/smsAccount/index.js",
22031 "groupTitle": "Sms_Accounts"
22035 "url": "/api/sms/accounts",
22036 "title": "Creates a new Account",
22039 "title": "Example usage:",
22040 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22044 "name": "CreateAccounts",
22045 "group": "Sms_Accounts",
22106 "field": "accountSid",
22120 "field": "authToken",
22132 "field": "smsMethod",
22139 "field": "username",
22146 "field": "password",
22160 "field": "senderString",
22167 "field": "deliveryReport",
22174 "field": "description",
22181 "field": "notificationTemplate",
22188 "field": "notificationSound",
22195 "field": "notificationShake",
22202 "field": "waitForTheAssignedAgent",
22209 "field": "queueTransfer",
22216 "field": "queueTransferTimeout",
22223 "field": "agentTransfer",
22230 "field": "agentTransferTimeout",
22237 "field": "baseUrl",
22244 "field": "mandatoryDispositionPauseId",
22245 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22251 "field": "mandatoryDisposition",
22252 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22258 "version": "0.0.0",
22259 "filename": "server/api/smsAccount/index.js",
22260 "groupTitle": "Sms_Accounts"
22264 "url": "/api/sms/accounts/{id}",
22265 "title": "Deletes a Account",
22268 "title": "Example usage:",
22269 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22273 "name": "DeleteAccounts",
22274 "group": "Sms_Accounts",
22275 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22276 "version": "0.0.0",
22277 "filename": "server/api/smsAccount/index.js",
22278 "groupTitle": "Sms_Accounts"
22282 "url": "/api/sms/accounts/describe",
22283 "title": "Gets table info about Accounts",
22286 "title": "Example usage:",
22287 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22291 "name": "DescribeAccounts",
22292 "group": "Sms_Accounts",
22293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22294 "version": "0.0.0",
22295 "filename": "server/api/smsAccount/index.js",
22296 "groupTitle": "Sms_Accounts"
22300 "url": "/api/sms/accounts",
22301 "title": "Gets a list of Accounts",
22304 "title": "Example usage:",
22305 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22309 "name": "GetAccounts",
22310 "group": "Sms_Accounts",
22311 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22312 "version": "0.0.0",
22313 "filename": "server/api/smsAccount/index.js",
22314 "groupTitle": "Sms_Accounts"
22318 "url": "/api/sms/accounts/{id}/users",
22319 "title": "Gets agents from sms account",
22322 "title": "Example usage:",
22323 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22327 "name": "GetAgents",
22328 "group": "Sms_Accounts",
22329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22330 "version": "0.0.0",
22331 "filename": "server/api/smsAccount/index.js",
22332 "groupTitle": "Sms_Accounts"
22336 "url": "/api/sms/accounts/{id}/users",
22337 "title": "Removes agents from a sms account",
22340 "title": "Example usage:",
22341 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22345 "name": "RemoveAgents",
22346 "group": "Sms_Accounts",
22347 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22348 "version": "0.0.0",
22349 "filename": "server/api/smsAccount/index.js",
22350 "groupTitle": "Sms_Accounts"
22354 "url": "/api/sms/accounts/{id}/canned_answers",
22355 "title": "Removes canned answers from account",
22358 "title": "Example usage:",
22359 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22363 "name": "RemoveAnswers",
22364 "group": "Sms_Accounts",
22365 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22366 "version": "0.0.0",
22367 "filename": "server/api/smsAccount/index.js",
22368 "groupTitle": "Sms_Accounts"
22372 "url": "/api/sms/accounts/{id}/dispositions",
22373 "title": "Removes dispositions from account",
22376 "title": "Example usage:",
22377 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22381 "name": "RemoveDispositions",
22382 "group": "Sms_Accounts",
22383 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22384 "version": "0.0.0",
22385 "filename": "server/api/smsAccount/index.js",
22386 "groupTitle": "Sms_Accounts"
22390 "url": "/api/sms/accounts/{id}",
22391 "title": "Gets a single Account",
22394 "title": "Example usage:",
22395 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22399 "name": "ShowAccounts",
22400 "group": "Sms_Accounts",
22401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22402 "version": "0.0.0",
22403 "filename": "server/api/smsAccount/index.js",
22404 "groupTitle": "Sms_Accounts"
22408 "url": "/api/sms/messages/{id}/accept",
22409 "title": "Accepts message",
22412 "title": "Example usage:",
22413 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22417 "name": "acceptMessage",
22418 "group": "Sms_Accounts",
22419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22420 "version": "0.0.0",
22421 "filename": "server/api/smsMessage/index.js",
22422 "groupTitle": "Sms_Accounts"
22426 "url": "/api/sms/accounts/{id}/canned_answers",
22427 "title": "Creates new canned answer",
22430 "title": "Example usage:",
22431 "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",
22435 "name": "addAnswer",
22436 "group": "Sms_Accounts",
22458 "field": "description",
22471 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/applications",
22479 "title": "Creates new applications",
22482 "title": "Example usage:",
22483 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22487 "name": "addApplications",
22488 "group": "Sms_Accounts",
22496 "field": "priority",
22510 "field": "appdata",
22517 "field": "description",
22524 "field": "interval",
22530 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22531 "version": "0.0.0",
22532 "filename": "server/api/smsAccount/index.js",
22533 "groupTitle": "Sms_Accounts"
22537 "url": "/api/sms/accounts/{id}/dispositions",
22538 "title": "Creates new disposition",
22541 "title": "Example usage:",
22542 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22546 "name": "addDisposition",
22547 "group": "Sms_Accounts",
22574 "field": "description",
22580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22581 "version": "0.0.0",
22582 "filename": "server/api/smsAccount/index.js",
22583 "groupTitle": "Sms_Accounts"
22587 "url": "/api/sms/accounts/{id}/canned_answers",
22588 "title": "Gets account canned answers",
22591 "title": "Example usage:",
22592 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22596 "name": "getAnswers",
22597 "group": "Sms_Accounts",
22598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22599 "version": "0.0.0",
22600 "filename": "server/api/smsAccount/index.js",
22601 "groupTitle": "Sms_Accounts"
22605 "url": "/api/sms/accounts/{id}/applications",
22606 "title": "Gets account applications",
22609 "title": "Example usage:",
22610 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22614 "name": "getApplications",
22615 "group": "Sms_Accounts",
22616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22617 "version": "0.0.0",
22618 "filename": "server/api/smsAccount/index.js",
22619 "groupTitle": "Sms_Accounts"
22623 "url": "/api/sms/accounts/{id}/dispositions",
22624 "title": "Gets account dispositions",
22627 "title": "Example usage:",
22628 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22632 "name": "getDispositions",
22633 "group": "Sms_Accounts",
22634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22635 "version": "0.0.0",
22636 "filename": "server/api/smsAccount/index.js",
22637 "groupTitle": "Sms_Accounts"
22641 "url": "/api/sms/accounts/{id}/interactions",
22642 "title": "Gets Sms Account interactions",
22645 "title": "Example usage:",
22646 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22650 "name": "getInteractions",
22651 "group": "Sms_Accounts",
22652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22653 "version": "0.0.0",
22654 "filename": "server/api/smsAccount/index.js",
22655 "groupTitle": "Sms_Accounts"
22659 "url": "/api/sms/accounts/{id}/notify",
22660 "title": "Notify new message",
22663 "title": "Example usage:",
22664 "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",
22669 "group": "Sms_Accounts",
22670 "description": "<p>Motion 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>",
22671 "version": "0.0.0",
22672 "filename": "server/api/smsAccount/index.js",
22673 "groupTitle": "Sms_Accounts"
22677 "url": "/api/sms/messages/{id}/reject",
22678 "title": "Rejects message",
22681 "title": "Example usage:",
22682 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22686 "name": "rejectMessage",
22687 "group": "Sms_Accounts",
22688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22689 "version": "0.0.0",
22690 "filename": "server/api/smsMessage/index.js",
22691 "groupTitle": "Sms_Accounts"
22695 "url": "/api/sms/accounts/{id}/send",
22696 "title": "Send new sms message",
22699 "title": "Example usage:",
22700 "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",
22705 "group": "Sms_Accounts",
22706 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22707 "version": "0.0.0",
22708 "filename": "server/api/smsAccount/index.js",
22709 "groupTitle": "Sms_Accounts"
22713 "url": "/api/sms/accounts/{id}/status",
22714 "title": "Receive message status as get request",
22717 "title": "Example usage:",
22718 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22722 "name": "statusMessage",
22723 "group": "Sms_Accounts",
22724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22725 "version": "0.0.0",
22726 "filename": "server/api/smsAccount/index.js",
22727 "groupTitle": "Sms_Accounts"
22731 "url": "/api/sms/messages/{id}/status",
22732 "title": "Receive message status",
22735 "title": "Example usage:",
22736 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22740 "name": "statusMessage",
22741 "group": "Sms_Accounts",
22742 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22743 "version": "0.0.0",
22744 "filename": "server/api/smsMessage/index.js",
22745 "groupTitle": "Sms_Accounts"
22749 "url": "/api/sms/accounts/{id}/status",
22750 "title": "Receive message status",
22753 "title": "Example usage:",
22754 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22758 "name": "statusMessage",
22759 "group": "Sms_Accounts",
22760 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22761 "version": "0.0.0",
22762 "filename": "server/api/smsAccount/index.js",
22763 "groupTitle": "Sms_Accounts"
22767 "url": "/api/sms/accounts/{id}",
22768 "title": "Update an existing Account",
22771 "title": "Example usage:",
22772 "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",
22776 "name": "updateAccounts",
22777 "group": "Sms_Accounts",
22778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22779 "version": "0.0.0",
22780 "filename": "server/api/smsAccount/index.js",
22781 "groupTitle": "Sms_Accounts"
22785 "url": "/api/sms/applications",
22786 "title": "Creates a new Application",
22789 "title": "Example usage:",
22790 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22794 "name": "CreateApplications",
22795 "group": "Sms_Applications",
22803 "field": "priority",
22817 "field": "appdata",
22824 "field": "description",
22831 "field": "interval",
22837 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22838 "version": "0.0.0",
22839 "filename": "server/api/smsApplication/index.js",
22840 "groupTitle": "Sms_Applications"
22844 "url": "/api/sms/applications/{id}",
22845 "title": "Deletes a Application",
22848 "title": "Example usage:",
22849 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22853 "name": "DeleteApplications",
22854 "group": "Sms_Applications",
22855 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22856 "version": "0.0.0",
22857 "filename": "server/api/smsApplication/index.js",
22858 "groupTitle": "Sms_Applications"
22862 "url": "/api/sms/applications",
22863 "title": "Gets a list of Applications",
22866 "title": "Example usage:",
22867 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22871 "name": "GetApplications",
22872 "group": "Sms_Applications",
22873 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22874 "version": "0.0.0",
22875 "filename": "server/api/smsApplication/index.js",
22876 "groupTitle": "Sms_Applications"
22880 "url": "/api/sms/applications/{id}",
22881 "title": "Gets a single Application",
22884 "title": "Example usage:",
22885 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22889 "name": "ShowApplications",
22890 "group": "Sms_Applications",
22891 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22892 "version": "0.0.0",
22893 "filename": "server/api/smsApplication/index.js",
22894 "groupTitle": "Sms_Applications"
22898 "url": "/api/sms/applications/{id}",
22899 "title": "Update an existing Application",
22902 "title": "Example usage:",
22903 "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",
22907 "name": "updateApplications",
22908 "group": "Sms_Applications",
22909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22910 "version": "0.0.0",
22911 "filename": "server/api/smsApplication/index.js",
22912 "groupTitle": "Sms_Applications"
22916 "url": "/api/sms/interactions/{id}/tags",
22917 "title": "Add tags to the interaction",
22920 "title": "Example usage:",
22921 "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",
22926 "group": "Sms_Interactions",
22927 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22928 "version": "0.0.0",
22929 "filename": "server/api/smsInteraction/index.js",
22930 "groupTitle": "Sms_Interactions"
22934 "url": "/api/sms/interactions",
22935 "title": "Creates a new Interaction",
22938 "title": "Example usage:",
22939 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22943 "name": "CreateInteractions",
22944 "group": "Sms_Interactions",
22959 "field": "closedAt",
22966 "field": "disposition",
22973 "field": "secondDisposition",
22980 "field": "thirdDisposition",
23001 "field": "read1stAt",
23012 "field": "firstMsgDirection",
23019 "field": "lastMsgAt",
23030 "field": "lastMsgDirection",
23036 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23037 "version": "0.0.0",
23038 "filename": "server/api/smsInteraction/index.js",
23039 "groupTitle": "Sms_Interactions"
23043 "url": "/api/sms/interactions/{id}",
23044 "title": "Deletes a Interaction",
23047 "title": "Example usage:",
23048 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23052 "name": "DeleteInteractions",
23053 "group": "Sms_Interactions",
23054 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23055 "version": "0.0.0",
23056 "filename": "server/api/smsInteraction/index.js",
23057 "groupTitle": "Sms_Interactions"
23061 "url": "/api/sms/interactions/describe",
23062 "title": "Gets table info about Interactions",
23065 "title": "Example usage:",
23066 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23070 "name": "DescribeInteractions",
23071 "group": "Sms_Interactions",
23072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23073 "version": "0.0.0",
23074 "filename": "server/api/smsInteraction/index.js",
23075 "groupTitle": "Sms_Interactions"
23079 "url": "/api/sms/interactions",
23080 "title": "Gets a list of Interactions",
23083 "title": "Example usage:",
23084 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23088 "name": "GetInteractions",
23089 "group": "Sms_Interactions",
23090 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23091 "version": "0.0.0",
23092 "filename": "server/api/smsInteraction/index.js",
23093 "groupTitle": "Sms_Interactions"
23097 "url": "/api/sms/interactions/{id}/tags",
23098 "title": "Removes tags from interaction",
23101 "title": "Example usage:",
23102 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23106 "name": "RemoveTags",
23107 "group": "Sms_Interactions",
23108 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23109 "version": "0.0.0",
23110 "filename": "server/api/smsInteraction/index.js",
23111 "groupTitle": "Sms_Interactions"
23115 "url": "/api/sms/interactions/{id}",
23116 "title": "Gets a single Interaction",
23119 "title": "Example usage:",
23120 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23124 "name": "ShowInteractions",
23125 "group": "Sms_Interactions",
23126 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23127 "version": "0.0.0",
23128 "filename": "server/api/smsInteraction/index.js",
23129 "groupTitle": "Sms_Interactions"
23133 "url": "/api/sms/interactions/{id}/messages",
23134 "title": "Creates new messages",
23137 "title": "Example usage:",
23138 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23142 "name": "addMessage",
23143 "group": "Sms_Interactions",
23169 "field": "direction",
23176 "field": "messageId",
23204 "field": "providerName",
23211 "field": "providerResponse",
23217 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23218 "version": "0.0.0",
23219 "filename": "server/api/smsInteraction/index.js",
23220 "groupTitle": "Sms_Interactions"
23224 "url": "/api/sms/interactions/{id}/download",
23225 "title": "Gets interaction",
23228 "title": "Example usage:",
23229 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23233 "name": "download",
23234 "group": "Sms_Interactions",
23235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23236 "version": "0.0.0",
23237 "filename": "server/api/smsInteraction/index.js",
23238 "groupTitle": "Sms_Interactions"
23242 "url": "/api/sms/interactions/{id}/messages",
23243 "title": "Gets interaction messages",
23246 "title": "Example usage:",
23247 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23251 "name": "getMessages",
23252 "group": "Sms_Interactions",
23253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23254 "version": "0.0.0",
23255 "filename": "server/api/smsInteraction/index.js",
23256 "groupTitle": "Sms_Interactions"
23260 "url": "/api/sms/interactions/{id}",
23261 "title": "Update an existing Interaction",
23264 "title": "Example usage:",
23265 "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",
23269 "name": "updateInteractions",
23270 "group": "Sms_Interactions",
23271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23272 "version": "0.0.0",
23273 "filename": "server/api/smsInteraction/index.js",
23274 "groupTitle": "Sms_Interactions"
23278 "url": "/api/sms/messages",
23279 "title": "Creates a new Message",
23282 "title": "Example usage:",
23283 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23287 "name": "CreateMessages",
23288 "group": "Sms_Messages",
23314 "field": "direction",
23321 "field": "messageId",
23349 "field": "providerName",
23356 "field": "providerResponse",
23362 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23363 "version": "0.0.0",
23364 "filename": "server/api/smsMessage/index.js",
23365 "groupTitle": "Sms_Messages"
23369 "url": "/api/sms/messages/{id}",
23370 "title": "Deletes a Message",
23373 "title": "Example usage:",
23374 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23378 "name": "DeleteMessages",
23379 "group": "Sms_Messages",
23380 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23381 "version": "0.0.0",
23382 "filename": "server/api/smsMessage/index.js",
23383 "groupTitle": "Sms_Messages"
23387 "url": "/api/sms/messages/describe",
23388 "title": "Gets table info about Messages",
23391 "title": "Example usage:",
23392 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23396 "name": "DescribeMessages",
23397 "group": "Sms_Messages",
23398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23399 "version": "0.0.0",
23400 "filename": "server/api/smsMessage/index.js",
23401 "groupTitle": "Sms_Messages"
23405 "url": "/api/sms/messages",
23406 "title": "Gets a list of Messages",
23409 "title": "Example usage:",
23410 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23414 "name": "GetMessages",
23415 "group": "Sms_Messages",
23416 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23417 "version": "0.0.0",
23418 "filename": "server/api/smsMessage/index.js",
23419 "groupTitle": "Sms_Messages"
23423 "url": "/api/sms/messages/{id}",
23424 "title": "Gets a single Message",
23427 "title": "Example usage:",
23428 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23432 "name": "ShowMessages",
23433 "group": "Sms_Messages",
23434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23435 "version": "0.0.0",
23436 "filename": "server/api/smsMessage/index.js",
23437 "groupTitle": "Sms_Messages"
23441 "url": "/api/sms/messages/{id}",
23442 "title": "Update an existing Message",
23445 "title": "Example usage:",
23446 "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",
23450 "name": "updateMessages",
23451 "group": "Sms_Messages",
23452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23453 "version": "0.0.0",
23454 "filename": "server/api/smsMessage/index.js",
23455 "groupTitle": "Sms_Messages"
23459 "url": "/api/sms/reports/queue",
23460 "title": "Creates a new Sms Queue Report",
23463 "title": "Example usage:",
23464 "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",
23468 "name": "CreateSms_Queue_Reports",
23469 "group": "Sms_Queue_Reports",
23477 "field": "uniqueid",
23498 "field": "leaveAt",
23505 "field": "acceptAt",
23525 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23526 "version": "0.0.0",
23527 "filename": "server/api/smsQueueReport/index.js",
23528 "groupTitle": "Sms_Queue_Reports"
23532 "url": "/api/sms/reports/queue/{id}",
23533 "title": "Deletes a Sms Queue Report",
23536 "title": "Example usage:",
23537 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23541 "name": "DeleteSms_Queue_Reports",
23542 "group": "Sms_Queue_Reports",
23543 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23544 "version": "0.0.0",
23545 "filename": "server/api/smsQueueReport/index.js",
23546 "groupTitle": "Sms_Queue_Reports"
23550 "url": "/api/sms/reports/queue/describe",
23551 "title": "Gets table info about Sms Queue Reports",
23554 "title": "Example usage:",
23555 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23559 "name": "DescribeSms_Queue_Reports",
23560 "group": "Sms_Queue_Reports",
23561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23562 "version": "0.0.0",
23563 "filename": "server/api/smsQueueReport/index.js",
23564 "groupTitle": "Sms_Queue_Reports"
23568 "url": "/api/sms/reports/queue",
23569 "title": "Gets a list of Sms Queue Reports",
23572 "title": "Example usage:",
23573 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23577 "name": "GetSms_Queue_Reports",
23578 "group": "Sms_Queue_Reports",
23579 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23580 "version": "0.0.0",
23581 "filename": "server/api/smsQueueReport/index.js",
23582 "groupTitle": "Sms_Queue_Reports"
23586 "url": "/api/sms/reports/queue/{id}",
23587 "title": "Gets a single Sms Queue Report",
23590 "title": "Example usage:",
23591 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23595 "name": "ShowSms_Queue_Reports",
23596 "group": "Sms_Queue_Reports",
23597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23598 "version": "0.0.0",
23599 "filename": "server/api/smsQueueReport/index.js",
23600 "groupTitle": "Sms_Queue_Reports"
23604 "url": "/api/sms/reports/queue/{id}",
23605 "title": "Update an existing Sms Queue Report",
23608 "title": "Example usage:",
23609 "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",
23613 "name": "updateSms_Queue_Reports",
23614 "group": "Sms_Queue_Reports",
23615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23616 "version": "0.0.0",
23617 "filename": "server/api/smsQueueReport/index.js",
23618 "groupTitle": "Sms_Queue_Reports"
23622 "url": "/api/sms/queues/{id}/users",
23623 "title": "Add agents to a queue",
23626 "title": "Example usage:",
23627 "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",
23631 "name": "AddAgents",
23632 "group": "Sms_Queues",
23633 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23634 "version": "0.0.0",
23635 "filename": "server/api/smsQueue/index.js",
23636 "groupTitle": "Sms_Queues"
23640 "url": "/api/sms/queues/{id}/teams",
23641 "title": "Add teams to a queue",
23644 "title": "Example usage:",
23645 "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",
23649 "name": "AddTeams",
23650 "group": "Sms_Queues",
23651 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23652 "version": "0.0.0",
23653 "filename": "server/api/smsQueue/index.js",
23654 "groupTitle": "Sms_Queues"
23658 "url": "/api/sms/queues",
23659 "title": "Creates a new Queue",
23662 "title": "Example usage:",
23663 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23667 "name": "CreateQueues",
23668 "group": "Sms_Queues",
23683 "field": "description",
23690 "field": "timeout",
23702 "field": "strategy",
23708 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23709 "version": "0.0.0",
23710 "filename": "server/api/smsQueue/index.js",
23711 "groupTitle": "Sms_Queues"
23715 "url": "/api/sms/queues/{id}",
23716 "title": "Deletes a Queue",
23719 "title": "Example usage:",
23720 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23724 "name": "DeleteQueues",
23725 "group": "Sms_Queues",
23726 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23727 "version": "0.0.0",
23728 "filename": "server/api/smsQueue/index.js",
23729 "groupTitle": "Sms_Queues"
23733 "url": "/api/sms/queues/describe",
23734 "title": "Gets table info about Queues",
23737 "title": "Example usage:",
23738 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23742 "name": "DescribeQueues",
23743 "group": "Sms_Queues",
23744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23745 "version": "0.0.0",
23746 "filename": "server/api/smsQueue/index.js",
23747 "groupTitle": "Sms_Queues"
23751 "url": "/api/sms/queues/{id}/users",
23752 "title": "Gets queue agents",
23755 "title": "Example usage:",
23756 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23760 "name": "GetAgents",
23761 "group": "Sms_Queues",
23762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23763 "version": "0.0.0",
23764 "filename": "server/api/smsQueue/index.js",
23765 "groupTitle": "Sms_Queues"
23769 "url": "/api/sms/queues/{id}/members",
23770 "title": "GetMembers",
23773 "title": "Example usage:",
23774 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23778 "name": "GetMembers",
23779 "group": "Sms_Queues",
23780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23781 "version": "0.0.0",
23782 "filename": "server/api/smsQueue/index.js",
23783 "groupTitle": "Sms_Queues"
23787 "url": "/api/sms/queues",
23788 "title": "Gets a list of Queues",
23791 "title": "Example usage:",
23792 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23796 "name": "GetQueues",
23797 "group": "Sms_Queues",
23798 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23799 "version": "0.0.0",
23800 "filename": "server/api/smsQueue/index.js",
23801 "groupTitle": "Sms_Queues"
23805 "url": "/api/sms/queues/{id}/teams",
23806 "title": "Gets queues list",
23809 "title": "Example usage:",
23810 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23814 "name": "GetTeams",
23815 "group": "Sms_Queues",
23816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23817 "version": "0.0.0",
23818 "filename": "server/api/smsQueue/index.js",
23819 "groupTitle": "Sms_Queues"
23823 "url": "/api/sms/queues/{id}/users",
23824 "title": "Removes agents from a queue",
23827 "title": "Example usage:",
23828 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23832 "name": "RemoveAgents",
23833 "group": "Sms_Queues",
23834 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23835 "version": "0.0.0",
23836 "filename": "server/api/smsQueue/index.js",
23837 "groupTitle": "Sms_Queues"
23841 "url": "/api/sms/queues/{id}",
23842 "title": "Gets a single Queue",
23845 "title": "Example usage:",
23846 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23850 "name": "ShowQueues",
23851 "group": "Sms_Queues",
23852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23853 "version": "0.0.0",
23854 "filename": "server/api/smsQueue/index.js",
23855 "groupTitle": "Sms_Queues"
23859 "url": "/api/sms/queues/{id}",
23860 "title": "Update an existing Queue",
23863 "title": "Example usage:",
23864 "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",
23868 "name": "updateQueues",
23869 "group": "Sms_Queues",
23870 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23871 "version": "0.0.0",
23872 "filename": "server/api/smsQueue/index.js",
23873 "groupTitle": "Sms_Queues"
23877 "url": "/api/sms/reports/transfer",
23878 "title": "Creates a new Sms Transfer Report",
23881 "title": "Example usage:",
23882 "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",
23886 "name": "CreateSms_Transfer_Reports",
23887 "group": "Sms_Transfer_Reports",
23895 "field": "uniqueid",
23914 "field": "transferredAt",
23920 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23921 "version": "0.0.0",
23922 "filename": "server/api/smsTransferReport/index.js",
23923 "groupTitle": "Sms_Transfer_Reports"
23927 "url": "/api/sms/reports/transfer/{id}",
23928 "title": "Deletes a Sms Transfer Report",
23931 "title": "Example usage:",
23932 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23936 "name": "DeleteSms_Transfer_Reports",
23937 "group": "Sms_Transfer_Reports",
23938 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23939 "version": "0.0.0",
23940 "filename": "server/api/smsTransferReport/index.js",
23941 "groupTitle": "Sms_Transfer_Reports"
23945 "url": "/api/sms/reports/transfer/describe",
23946 "title": "Gets table info about Sms Transfer Reports",
23949 "title": "Example usage:",
23950 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23954 "name": "DescribeSms_Transfer_Reports",
23955 "group": "Sms_Transfer_Reports",
23956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23957 "version": "0.0.0",
23958 "filename": "server/api/smsTransferReport/index.js",
23959 "groupTitle": "Sms_Transfer_Reports"
23963 "url": "/api/sms/reports/transfer",
23964 "title": "Gets a list of Sms Transfer Reports",
23967 "title": "Example usage:",
23968 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23972 "name": "GetSms_Transfer_Reports",
23973 "group": "Sms_Transfer_Reports",
23974 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23975 "version": "0.0.0",
23976 "filename": "server/api/smsTransferReport/index.js",
23977 "groupTitle": "Sms_Transfer_Reports"
23981 "url": "/api/sms/reports/transfer/{id}",
23982 "title": "Gets a single Sms Transfer Report",
23985 "title": "Example usage:",
23986 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23990 "name": "ShowSms_Transfer_Reports",
23991 "group": "Sms_Transfer_Reports",
23992 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23993 "version": "0.0.0",
23994 "filename": "server/api/smsTransferReport/index.js",
23995 "groupTitle": "Sms_Transfer_Reports"
23999 "url": "/api/sms/reports/transfer/{id}",
24000 "title": "Update an existing Sms Transfer Report",
24003 "title": "Example usage:",
24004 "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",
24008 "name": "updateSms_Transfer_Reports",
24009 "group": "Sms_Transfer_Reports",
24010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24011 "version": "0.0.0",
24012 "filename": "server/api/smsTransferReport/index.js",
24013 "groupTitle": "Sms_Transfer_Reports"
24017 "url": "/api/sounds",
24018 "title": "Gets a list of Sounds",
24021 "title": "Example usage:",
24022 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24026 "name": "GetSounds",
24028 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24029 "version": "0.0.0",
24030 "filename": "server/api/sound/index.js",
24031 "groupTitle": "Sounds"
24035 "url": "/api/sounds/{id}",
24036 "title": "Gets a single Sound",
24039 "title": "Example usage:",
24040 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24044 "name": "ShowSounds",
24046 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24047 "version": "0.0.0",
24048 "filename": "server/api/sound/index.js",
24049 "groupTitle": "Sounds"
24053 "url": "/api/sounds",
24054 "title": "Create a new sound",
24057 "title": "Example usage:",
24058 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24062 "name": "addSound",
24064 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24065 "version": "0.0.0",
24066 "filename": "server/api/sound/index.js",
24067 "groupTitle": "Sounds"
24071 "url": "/api/sounds/{id}",
24072 "title": "Deletes a sound",
24075 "title": "Example usage:",
24076 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24080 "name": "destroySound",
24082 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24083 "version": "0.0.0",
24084 "filename": "server/api/sound/index.js",
24085 "groupTitle": "Sounds"
24089 "url": "/api/sounds/{id}/download",
24090 "title": "Download Sound",
24093 "title": "Example usage:",
24094 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24098 "name": "download",
24100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24101 "version": "0.0.0",
24102 "filename": "server/api/sound/index.js",
24103 "groupTitle": "Sounds"
24107 "url": "/api/sounds",
24108 "title": "Update an existing new sound",
24111 "title": "Example usage:",
24112 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24116 "name": "updateSound",
24118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24119 "version": "0.0.0",
24120 "filename": "server/api/sound/index.js",
24121 "groupTitle": "Sounds"
24125 "url": "/api/square/details/reports",
24126 "title": "Creates a new Square Detail Report",
24129 "title": "Example usage:",
24130 "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",
24134 "name": "CreateSquare_Detail_Reports",
24135 "group": "Square_Details_Reports",
24143 "field": "uniqueid",
24157 "field": "application",
24171 "field": "project_name",
24178 "field": "callerid",
24184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24185 "version": "0.0.0",
24186 "filename": "server/api/squareReportDetail/index.js",
24187 "groupTitle": "Square_Details_Reports"
24191 "url": "/api/square/details/reports/{id}",
24192 "title": "Deletes a Square Detail Report",
24195 "title": "Example usage:",
24196 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24200 "name": "DeleteSquare_Detail_Reports",
24201 "group": "Square_Details_Reports",
24202 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24203 "version": "0.0.0",
24204 "filename": "server/api/squareReportDetail/index.js",
24205 "groupTitle": "Square_Details_Reports"
24209 "url": "/api/square/details/reports/describe",
24210 "title": "Gets table info about Square Detail Reports",
24213 "title": "Example usage:",
24214 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24218 "name": "DescribeSquare_Detail_Reports",
24219 "group": "Square_Details_Reports",
24220 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24221 "version": "0.0.0",
24222 "filename": "server/api/squareReportDetail/index.js",
24223 "groupTitle": "Square_Details_Reports"
24227 "url": "/api/square/details/reports",
24228 "title": "Gets a list of Square Detail Reports",
24231 "title": "Example usage:",
24232 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24236 "name": "GetSquare_Detail_Reports",
24237 "group": "Square_Details_Reports",
24238 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24239 "version": "0.0.0",
24240 "filename": "server/api/squareReportDetail/index.js",
24241 "groupTitle": "Square_Details_Reports"
24245 "url": "/api/square/details/reports/{id}",
24246 "title": "Gets a single Square Detail Report",
24249 "title": "Example usage:",
24250 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24254 "name": "ShowSquare_Detail_Reports",
24255 "group": "Square_Details_Reports",
24256 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24257 "version": "0.0.0",
24258 "filename": "server/api/squareReportDetail/index.js",
24259 "groupTitle": "Square_Details_Reports"
24263 "url": "/api/square/details/reports/{id}",
24264 "title": "Update an existing Square Detail Report",
24267 "title": "Example usage:",
24268 "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",
24272 "name": "updateSquare_Detail_Reports",
24273 "group": "Square_Details_Reports",
24274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24275 "version": "0.0.0",
24276 "filename": "server/api/squareReportDetail/index.js",
24277 "groupTitle": "Square_Details_Reports"
24281 "url": "/api/square/messages",
24282 "title": "Creates a new Message",
24285 "title": "Example usage:",
24286 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24290 "name": "CreateMessages",
24291 "group": "Square_Messages",
24299 "field": "uniqueid",
24317 "field": "direction",
24324 "field": "providerName",
24331 "field": "providerResponse",
24337 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24338 "version": "0.0.0",
24339 "filename": "server/api/squareMessage/index.js",
24340 "groupTitle": "Square_Messages"
24344 "url": "/api/square/messages/{id}",
24345 "title": "Deletes a Message",
24348 "title": "Example usage:",
24349 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24353 "name": "DeleteMessages",
24354 "group": "Square_Messages",
24355 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24356 "version": "0.0.0",
24357 "filename": "server/api/squareMessage/index.js",
24358 "groupTitle": "Square_Messages"
24362 "url": "/api/square/messages",
24363 "title": "Gets a list of Messages",
24366 "title": "Example usage:",
24367 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24371 "name": "GetMessages",
24372 "group": "Square_Messages",
24373 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24374 "version": "0.0.0",
24375 "filename": "server/api/squareMessage/index.js",
24376 "groupTitle": "Square_Messages"
24380 "url": "/api/square/messages/{id}",
24381 "title": "Gets a single Message",
24384 "title": "Example usage:",
24385 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24389 "name": "ShowMessages",
24390 "group": "Square_Messages",
24391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24392 "version": "0.0.0",
24393 "filename": "server/api/squareMessage/index.js",
24394 "groupTitle": "Square_Messages"
24398 "url": "/api/square/messages/{id}",
24399 "title": "Update an existing Message",
24402 "title": "Example usage:",
24403 "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",
24407 "name": "updateMessages",
24408 "group": "Square_Messages",
24409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24410 "version": "0.0.0",
24411 "filename": "server/api/squareMessage/index.js",
24412 "groupTitle": "Square_Messages"
24416 "url": "/api/square/odbc",
24417 "title": "Creates a new ODBC",
24420 "title": "Example usage:",
24421 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24425 "name": "CreateODBCs",
24426 "group": "Square_ODBC",
24448 "field": "description",
24454 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24455 "version": "0.0.0",
24456 "filename": "server/api/squareOdbc/index.js",
24457 "groupTitle": "Square_ODBC"
24461 "url": "/api/square/odbc/{id}",
24462 "title": "Deletes a ODBC",
24465 "title": "Example usage:",
24466 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24470 "name": "DeleteODBCs",
24471 "group": "Square_ODBC",
24472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24473 "version": "0.0.0",
24474 "filename": "server/api/squareOdbc/index.js",
24475 "groupTitle": "Square_ODBC"
24479 "url": "/api/square/odbc",
24480 "title": "Gets a list of ODBCs",
24483 "title": "Example usage:",
24484 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24488 "name": "GetODBCs",
24489 "group": "Square_ODBC",
24490 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24491 "version": "0.0.0",
24492 "filename": "server/api/squareOdbc/index.js",
24493 "groupTitle": "Square_ODBC"
24497 "url": "/api/square/odbc/{id}",
24498 "title": "Gets a single ODBC",
24501 "title": "Example usage:",
24502 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24506 "name": "ShowODBCs",
24507 "group": "Square_ODBC",
24508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24509 "version": "0.0.0",
24510 "filename": "server/api/squareOdbc/index.js",
24511 "groupTitle": "Square_ODBC"
24515 "url": "/api/square/odbc/{id}/test",
24516 "title": "Test Odbc",
24519 "title": "Example usage:",
24520 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24525 "group": "Square_ODBC",
24526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24527 "version": "0.0.0",
24528 "filename": "server/api/squareOdbc/index.js",
24529 "groupTitle": "Square_ODBC"
24533 "url": "/api/square/odbc/{id}",
24534 "title": "Update an existing ODBC",
24537 "title": "Example usage:",
24538 "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",
24542 "name": "updateODBCs",
24543 "group": "Square_ODBC",
24544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24545 "version": "0.0.0",
24546 "filename": "server/api/squareOdbc/index.js",
24547 "groupTitle": "Square_ODBC"
24551 "url": "/api/square/projects",
24552 "title": "Creates a new Project",
24555 "title": "Example usage:",
24556 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24560 "name": "CreateProjects",
24561 "group": "Square_Projects",
24576 "field": "description",
24590 "field": "preproduction",
24597 "field": "production",
24603 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24604 "version": "0.0.0",
24605 "filename": "server/api/squareProject/index.js",
24606 "groupTitle": "Square_Projects"
24610 "url": "/api/square/projects/{id}",
24611 "title": "Deletes a Project",
24614 "title": "Example usage:",
24615 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24619 "name": "DeleteProjects",
24620 "group": "Square_Projects",
24621 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24622 "version": "0.0.0",
24623 "filename": "server/api/squareProject/index.js",
24624 "groupTitle": "Square_Projects"
24628 "url": "/api/square/projects",
24629 "title": "Gets a list of Projects",
24632 "title": "Example usage:",
24633 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24637 "name": "GetProjects",
24638 "group": "Square_Projects",
24639 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24640 "version": "0.0.0",
24641 "filename": "server/api/squareProject/index.js",
24642 "groupTitle": "Square_Projects"
24646 "url": "/api/square/projects/{id}",
24647 "title": "Gets a single Project",
24650 "title": "Example usage:",
24651 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24655 "name": "ShowProjects",
24656 "group": "Square_Projects",
24657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24658 "version": "0.0.0",
24659 "filename": "server/api/squareProject/index.js",
24660 "groupTitle": "Square_Projects"
24664 "url": "/api/square/projects/{id}/users",
24665 "title": "Adds user permissions to a Project",
24668 "title": "Example usage:",
24669 "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",
24673 "name": "addUsers",
24674 "group": "Square_Projects",
24675 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24676 "version": "0.0.0",
24677 "filename": "server/api/squareProject/index.js",
24678 "groupTitle": "Square_Projects"
24682 "url": "/api/square/projects/{id}/users",
24683 "title": "Gets users permissions from Project",
24686 "title": "Example usage:",
24687 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24691 "name": "getUsers",
24692 "group": "Square_Projects",
24693 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24694 "version": "0.0.0",
24695 "filename": "server/api/squareProject/index.js",
24696 "groupTitle": "Square_Projects"
24700 "url": "/api/square/projects/{id}/users",
24701 "title": "Removes user permissions from a Project",
24704 "title": "Example usage:",
24705 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24709 "name": "removeUsers",
24710 "group": "Square_Projects",
24711 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24712 "version": "0.0.0",
24713 "filename": "server/api/squareProject/index.js",
24714 "groupTitle": "Square_Projects"
24718 "url": "/api/square/projects/{id}",
24719 "title": "Update an existing Project",
24722 "title": "Example usage:",
24723 "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",
24727 "name": "updateProjects",
24728 "group": "Square_Projects",
24729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24730 "version": "0.0.0",
24731 "filename": "server/api/squareProject/index.js",
24732 "groupTitle": "Square_Projects"
24736 "url": "/api/square/recordings",
24737 "title": "Creates a new Recording",
24740 "title": "Example usage:",
24741 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24745 "name": "CreateRecordings",
24746 "group": "Square_Recordings",
24754 "field": "uniqueid",
24761 "field": "callerid",
24768 "field": "calleridname",
24775 "field": "context",
24782 "field": "extension",
24789 "field": "priority",
24796 "field": "accountcode",
24810 "field": "projectName",
24817 "field": "saveName",
24824 "field": "filename",
24831 "field": "savePath",
24844 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24845 "version": "0.0.0",
24846 "filename": "server/api/squareRecording/index.js",
24847 "groupTitle": "Square_Recordings"
24851 "url": "/api/square/recordings",
24852 "title": "Gets a list of Recordings",
24855 "title": "Example usage:",
24856 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24860 "name": "GetRecordings",
24861 "group": "Square_Recordings",
24862 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24863 "version": "0.0.0",
24864 "filename": "server/api/squareRecording/index.js",
24865 "groupTitle": "Square_Recordings"
24869 "url": "/api/square/recordings/{id}",
24870 "title": "Gets a single Recording",
24873 "title": "Example usage:",
24874 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24878 "name": "ShowRecordings",
24879 "group": "Square_Recordings",
24880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24881 "version": "0.0.0",
24882 "filename": "server/api/squareRecording/index.js",
24883 "groupTitle": "Square_Recordings"
24887 "url": "/api/square/recordings/{id}/delete",
24888 "title": "Delete recording",
24891 "title": "Example usage:",
24892 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24897 "group": "Square_Recordings",
24898 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24899 "version": "0.0.0",
24900 "filename": "server/api/squareRecording/index.js",
24901 "groupTitle": "Square_Recordings"
24905 "url": "/api/square/recordings/{id}/download",
24906 "title": "Download Recording",
24909 "title": "Example usage:",
24910 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24914 "name": "download",
24915 "group": "Square_Recordings",
24916 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24917 "version": "0.0.0",
24918 "filename": "server/api/squareRecording/index.js",
24919 "groupTitle": "Square_Recordings"
24923 "url": "/api/square/recordings/{id}",
24924 "title": "Update an existing Recording",
24927 "title": "Example usage:",
24928 "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",
24932 "name": "updateRecordings",
24933 "group": "Square_Recordings",
24934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24935 "version": "0.0.0",
24936 "filename": "server/api/squareRecording/index.js",
24937 "groupTitle": "Square_Recordings"
24941 "url": "/api/square/reports",
24942 "title": "Creates a new Square Report",
24945 "title": "Example usage:",
24946 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24950 "name": "CreateSquare_Reports",
24951 "group": "Square_Reports",
24959 "field": "network",
24966 "field": "network_script",
24973 "field": "request",
24980 "field": "channel",
24987 "field": "language",
25001 "field": "uniqueid",
25008 "field": "version",
25015 "field": "callerid",
25022 "field": "calleridname",
25029 "field": "callingpres",
25036 "field": "callingani2",
25043 "field": "callington",
25050 "field": "callingtns",
25071 "field": "context",
25078 "field": "extension",
25085 "field": "priority",
25092 "field": "enhanced",
25099 "field": "accountcode",
25106 "field": "threadid",
25113 "field": "project_name",
25127 "field": "leaveAt",
25140 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25141 "version": "0.0.0",
25142 "filename": "server/api/squareReport/index.js",
25143 "groupTitle": "Square_Reports"
25147 "url": "/api/square/reports/{id}",
25148 "title": "Deletes a Square Report",
25151 "title": "Example usage:",
25152 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25156 "name": "DeleteSquare_Reports",
25157 "group": "Square_Reports",
25158 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25159 "version": "0.0.0",
25160 "filename": "server/api/squareReport/index.js",
25161 "groupTitle": "Square_Reports"
25165 "url": "/api/square/reports/describe",
25166 "title": "Gets table info about Square Reports",
25169 "title": "Example usage:",
25170 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25174 "name": "DescribeSquare_Reports",
25175 "group": "Square_Reports",
25176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25177 "version": "0.0.0",
25178 "filename": "server/api/squareReport/index.js",
25179 "groupTitle": "Square_Reports"
25183 "url": "/api/square/reports",
25184 "title": "Gets a list of Square Reports",
25187 "title": "Example usage:",
25188 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25192 "name": "GetSquare_Reports",
25193 "group": "Square_Reports",
25194 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25195 "version": "0.0.0",
25196 "filename": "server/api/squareReport/index.js",
25197 "groupTitle": "Square_Reports"
25201 "url": "/api/square/reports/{id}",
25202 "title": "Gets a single Square Report",
25205 "title": "Example usage:",
25206 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25210 "name": "ShowSquare_Reports",
25211 "group": "Square_Reports",
25212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25213 "version": "0.0.0",
25214 "filename": "server/api/squareReport/index.js",
25215 "groupTitle": "Square_Reports"
25219 "url": "/api/square/reports/{id}",
25220 "title": "Update an existing Square Report",
25223 "title": "Example usage:",
25224 "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",
25228 "name": "updateSquare_Reports",
25229 "group": "Square_Reports",
25230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25231 "version": "0.0.0",
25232 "filename": "server/api/squareReport/index.js",
25233 "groupTitle": "Square_Reports"
25237 "url": "/api/integrations/sugarcrm/configurations",
25238 "title": "Creates a new SugarCRM Configuration",
25241 "title": "Example usage:",
25242 "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",
25246 "name": "CreateSugarCRM_Configurations",
25247 "group": "SugarCRM_Configurations",
25262 "field": "description",
25268 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25269 "version": "0.0.0",
25270 "filename": "server/api/intSugarcrmConfiguration/index.js",
25271 "groupTitle": "SugarCRM_Configurations"
25275 "url": "/api/integrations/sugarcrm/configurations/{id}",
25276 "title": "Deletes a SugarCRM Configuration",
25279 "title": "Example usage:",
25280 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25284 "name": "DeleteSugarCRM_Configurations",
25285 "group": "SugarCRM_Configurations",
25286 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25287 "version": "0.0.0",
25288 "filename": "server/api/intSugarcrmConfiguration/index.js",
25289 "groupTitle": "SugarCRM_Configurations"
25293 "url": "/api/integrations/sugarcrm/configurations",
25294 "title": "Gets a list of SugarCRM Configurations",
25297 "title": "Example usage:",
25298 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25302 "name": "GetSugarCRM_Configurations",
25303 "group": "SugarCRM_Configurations",
25304 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25305 "version": "0.0.0",
25306 "filename": "server/api/intSugarcrmConfiguration/index.js",
25307 "groupTitle": "SugarCRM_Configurations"
25311 "url": "/api/integrations/sugarcrm/configurations/{id}",
25312 "title": "Gets a single SugarCRM Configuration",
25315 "title": "Example usage:",
25316 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25320 "name": "ShowSugarCRM_Configurations",
25321 "group": "SugarCRM_Configurations",
25322 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25323 "version": "0.0.0",
25324 "filename": "server/api/intSugarcrmConfiguration/index.js",
25325 "groupTitle": "SugarCRM_Configurations"
25329 "url": "/api/integrations/sugarcrm/configurations/{id}",
25330 "title": "Update an existing SugarCRM Configuration",
25333 "title": "Example usage:",
25334 "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",
25338 "name": "updateSugarCRM_Configurations",
25339 "group": "SugarCRM_Configurations",
25340 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25341 "version": "0.0.0",
25342 "filename": "server/api/intSugarcrmConfiguration/index.js",
25343 "groupTitle": "SugarCRM_Configurations"
25347 "url": "/api/integrations/sugarcrm/accounts",
25348 "title": "Creates a new Sugarcrm Account",
25351 "title": "Example usage:",
25352 "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",
25356 "name": "CreateSugarcrm_Accounts",
25357 "group": "Sugarcrm_Accounts",
25372 "field": "description",
25379 "field": "username",
25386 "field": "password",
25393 "field": "remoteUri",
25400 "field": "serverUrl",
25406 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25407 "version": "0.0.0",
25408 "filename": "server/api/intSugarcrmAccount/index.js",
25409 "groupTitle": "Sugarcrm_Accounts"
25413 "url": "/api/integrations/sugarcrm/accounts/{id}",
25414 "title": "Deletes a Sugarcrm Account",
25417 "title": "Example usage:",
25418 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25422 "name": "DeleteSugarcrm_Accounts",
25423 "group": "Sugarcrm_Accounts",
25424 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
25427 "groupTitle": "Sugarcrm_Accounts"
25431 "url": "/api/integrations/sugarcrm/accounts",
25432 "title": "Gets a list of Sugarcrm Accounts",
25435 "title": "Example usage:",
25436 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25440 "name": "GetSugarcrm_Accounts",
25441 "group": "Sugarcrm_Accounts",
25442 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25443 "version": "0.0.0",
25444 "filename": "server/api/intSugarcrmAccount/index.js",
25445 "groupTitle": "Sugarcrm_Accounts"
25449 "url": "/api/integrations/sugarcrm/accounts/{id}",
25450 "title": "Gets a single Sugarcrm Account",
25453 "title": "Example usage:",
25454 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25458 "name": "ShowSugarcrm_Accounts",
25459 "group": "Sugarcrm_Accounts",
25460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25461 "version": "0.0.0",
25462 "filename": "server/api/intSugarcrmAccount/index.js",
25463 "groupTitle": "Sugarcrm_Accounts"
25467 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25468 "title": "Creates new configuration",
25471 "title": "Example usage:",
25472 "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",
25476 "name": "addConfiguration",
25477 "group": "Sugarcrm_Accounts",
25478 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25479 "version": "0.0.0",
25480 "filename": "server/api/intSugarcrmAccount/index.js",
25481 "groupTitle": "Sugarcrm_Accounts"
25485 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25486 "title": "Gets account configurations",
25489 "title": "Example usage:",
25490 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25494 "name": "getConfigurations",
25495 "group": "Sugarcrm_Accounts",
25496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25497 "version": "0.0.0",
25498 "filename": "server/api/intSugarcrmAccount/index.js",
25499 "groupTitle": "Sugarcrm_Accounts"
25503 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25504 "title": "Gets account fields",
25507 "title": "Example usage:",
25508 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25512 "name": "getFields",
25513 "group": "Sugarcrm_Accounts",
25514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25515 "version": "0.0.0",
25516 "filename": "server/api/intSugarcrmAccount/index.js",
25517 "groupTitle": "Sugarcrm_Accounts"
25521 "url": "/api/integrations/sugarcrm/accounts/{id}",
25522 "title": "Update an existing Sugarcrm Account",
25525 "title": "Example usage:",
25526 "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",
25530 "name": "updateSugarcrm_Accounts",
25531 "group": "Sugarcrm_Accounts",
25532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25533 "version": "0.0.0",
25534 "filename": "server/api/intSugarcrmAccount/index.js",
25535 "groupTitle": "Sugarcrm_Accounts"
25539 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25540 "title": "Gets configurations descriptions",
25543 "title": "Example usage:",
25544 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25548 "name": "getDescriptions",
25549 "group": "Sugarcrm_Configurations",
25550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25551 "version": "0.0.0",
25552 "filename": "server/api/intSugarcrmConfiguration/index.js",
25553 "groupTitle": "Sugarcrm_Configurations"
25557 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25558 "title": "Gets configurations fields",
25561 "title": "Example usage:",
25562 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25566 "name": "getFields",
25567 "group": "Sugarcrm_Configurations",
25568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25569 "version": "0.0.0",
25570 "filename": "server/api/intSugarcrmConfiguration/index.js",
25571 "groupTitle": "Sugarcrm_Configurations"
25575 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25576 "title": "Gets configurations subjects",
25579 "title": "Example usage:",
25580 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25584 "name": "getSubjects",
25585 "group": "Sugarcrm_Configurations",
25586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25587 "version": "0.0.0",
25588 "filename": "server/api/intSugarcrmConfiguration/index.js",
25589 "groupTitle": "Sugarcrm_Configurations"
25593 "url": "/api/integrations/sugarcrm/fields",
25594 "title": "Creates a new Sugarcrm Field",
25597 "title": "Example usage:",
25598 "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",
25602 "name": "CreateSugarcrm_Fields",
25603 "group": "Sugarcrm_Fields",
25613 "\"customVariable\"",
25624 "field": "content",
25640 "\"customVariable\""
25643 "field": "keyType",
25650 "field": "keyContent",
25657 "field": "idField",
25664 "field": "nameField",
25671 "field": "customField",
25678 "field": "variableName",
25684 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25685 "version": "0.0.0",
25686 "filename": "server/api/intSugarcrmField/index.js",
25687 "groupTitle": "Sugarcrm_Fields"
25691 "url": "/api/integrations/sugarcrm/fields/{id}",
25692 "title": "Deletes a Sugarcrm Field",
25695 "title": "Example usage:",
25696 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25700 "name": "DeleteSugarcrm_Fields",
25701 "group": "Sugarcrm_Fields",
25702 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25703 "version": "0.0.0",
25704 "filename": "server/api/intSugarcrmField/index.js",
25705 "groupTitle": "Sugarcrm_Fields"
25709 "url": "/api/integrations/sugarcrm/fields",
25710 "title": "Gets a list of Sugarcrm Fields",
25713 "title": "Example usage:",
25714 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25718 "name": "GetSugarcrm_Fields",
25719 "group": "Sugarcrm_Fields",
25720 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25721 "version": "0.0.0",
25722 "filename": "server/api/intSugarcrmField/index.js",
25723 "groupTitle": "Sugarcrm_Fields"
25727 "url": "/api/integrations/sugarcrm/fields/{id}",
25728 "title": "Gets a single Sugarcrm Field",
25731 "title": "Example usage:",
25732 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25736 "name": "ShowSugarcrm_Fields",
25737 "group": "Sugarcrm_Fields",
25738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25739 "version": "0.0.0",
25740 "filename": "server/api/intSugarcrmField/index.js",
25741 "groupTitle": "Sugarcrm_Fields"
25745 "url": "/api/integrations/sugarcrm/fields/{id}",
25746 "title": "Update an existing Sugarcrm Field",
25749 "title": "Example usage:",
25750 "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",
25754 "name": "updateSugarcrm_Fields",
25755 "group": "Sugarcrm_Fields",
25756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25757 "version": "0.0.0",
25758 "filename": "server/api/intSugarcrmField/index.js",
25759 "groupTitle": "Sugarcrm_Fields"
25763 "url": "/api/system",
25764 "title": "Gets system information",
25767 "title": "Example usage:",
25768 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25772 "name": "GetSystemInformation",
25773 "group": "System_Information",
25774 "description": "<p>Motion returns the system information.</p>",
25775 "version": "0.0.0",
25776 "filename": "server/api/system/index.js",
25777 "groupTitle": "System_Information"
25781 "url": "/api/system/process",
25782 "title": "Gets system information",
25785 "title": "Example usage:",
25786 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25790 "name": "GetSystemInformation",
25791 "group": "System_Information",
25792 "description": "<p>Motion returns the system information.</p>",
25793 "version": "0.0.0",
25794 "filename": "server/api/system/index.js",
25795 "groupTitle": "System_Information"
25799 "url": "/api/tags",
25800 "title": "Creates a new Tag",
25803 "title": "Example usage:",
25804 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25808 "name": "CreateTags",
25831 "field": "description",
25837 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25838 "version": "0.0.0",
25839 "filename": "server/api/tag/index.js",
25840 "groupTitle": "Tags"
25844 "url": "/api/tags/{id}",
25845 "title": "Deletes a Tag",
25848 "title": "Example usage:",
25849 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25853 "name": "DeleteTags",
25855 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25856 "version": "0.0.0",
25857 "filename": "server/api/tag/index.js",
25858 "groupTitle": "Tags"
25862 "url": "/api/tags",
25863 "title": "Gets a list of Tags",
25866 "title": "Example usage:",
25867 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25873 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25874 "version": "0.0.0",
25875 "filename": "server/api/tag/index.js",
25876 "groupTitle": "Tags"
25880 "url": "/api/tags/{id}",
25881 "title": "Gets a single Tag",
25884 "title": "Example usage:",
25885 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25889 "name": "ShowTags",
25891 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25892 "version": "0.0.0",
25893 "filename": "server/api/tag/index.js",
25894 "groupTitle": "Tags"
25898 "url": "/api/tags/{id}",
25899 "title": "Update an existing Tag",
25902 "title": "Example usage:",
25903 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25907 "name": "updateTags",
25909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25910 "version": "0.0.0",
25911 "filename": "server/api/tag/index.js",
25912 "groupTitle": "Tags"
25916 "url": "/api/teams/{id}/queues",
25917 "title": "Add queues to a team",
25920 "title": "Example usage:",
25921 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25925 "name": "AddQueues",
25927 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25928 "version": "0.0.0",
25929 "filename": "server/api/team/index.js",
25930 "groupTitle": "Teams"
25934 "url": "/api/teams",
25935 "title": "Creates a new Team",
25938 "title": "Example usage:",
25939 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25943 "name": "CreateTeams",
25959 "field": "description",
25965 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25966 "version": "0.0.0",
25967 "filename": "server/api/team/index.js",
25968 "groupTitle": "Teams"
25972 "url": "/api/teams/{id}",
25973 "title": "Deletes a Team",
25976 "title": "Example usage:",
25977 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25981 "name": "DeleteTeams",
25983 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25984 "version": "0.0.0",
25985 "filename": "server/api/team/index.js",
25986 "groupTitle": "Teams"
25990 "url": "/api/teams/{id}/users",
25991 "title": "Gets agents from team",
25994 "title": "Example usage:",
25995 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25999 "name": "GetAgents",
26001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26002 "version": "0.0.0",
26003 "filename": "server/api/team/index.js",
26004 "groupTitle": "Teams"
26008 "url": "/api/teams/{id}/queues?channel={channel}",
26009 "title": "Gets Queues list",
26012 "title": "Example usage:",
26013 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26017 "name": "GetQueues",
26019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26020 "version": "0.0.0",
26021 "filename": "server/api/team/index.js",
26022 "groupTitle": "Teams"
26026 "url": "/api/teams",
26027 "title": "Gets a list of Teams",
26030 "title": "Example usage:",
26031 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26035 "name": "GetTeams",
26037 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26038 "version": "0.0.0",
26039 "filename": "server/api/team/index.js",
26040 "groupTitle": "Teams"
26044 "url": "/api/teams/{id}/users",
26045 "title": "Removes agents from a team",
26048 "title": "Example usage:",
26049 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26053 "name": "RemoveAgents",
26055 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26056 "version": "0.0.0",
26057 "filename": "server/api/team/index.js",
26058 "groupTitle": "Teams"
26062 "url": "/api/teams/{id}/queues",
26063 "title": "Remove queues to a team",
26066 "title": "Example usage:",
26067 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26071 "name": "RemoveQueues",
26073 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26074 "version": "0.0.0",
26075 "filename": "server/api/team/index.js",
26076 "groupTitle": "Teams"
26080 "url": "/api/whatsapp/queues/{id}/teams",
26081 "title": "Remove teams from a queue",
26084 "title": "Example usage:",
26085 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26089 "name": "RemoveTeams",
26091 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26092 "version": "0.0.0",
26093 "filename": "server/api/whatsappQueue/index.js",
26094 "groupTitle": "Teams"
26098 "url": "/api/openchannel/queues/{id}/teams",
26099 "title": "Remove teams from a queue",
26102 "title": "Example usage:",
26103 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26107 "name": "RemoveTeams",
26109 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26110 "version": "0.0.0",
26111 "filename": "server/api/openchannelQueue/index.js",
26112 "groupTitle": "Teams"
26116 "url": "/api/voice/queues/{id}/teams",
26117 "title": "Remove teams from a queue",
26120 "title": "Example usage:",
26121 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26125 "name": "RemoveTeams",
26127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26128 "version": "0.0.0",
26129 "filename": "server/api/voiceQueue/index.js",
26130 "groupTitle": "Teams"
26134 "url": "/api/sms/queues/{id}/teams",
26135 "title": "Remove teams from a queue",
26138 "title": "Example usage:",
26139 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26143 "name": "RemoveTeams",
26145 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26146 "version": "0.0.0",
26147 "filename": "server/api/smsQueue/index.js",
26148 "groupTitle": "Teams"
26152 "url": "/api/chat/queues/{id}/teams",
26153 "title": "Remove teams from a queue",
26156 "title": "Example usage:",
26157 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26161 "name": "RemoveTeams",
26163 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26164 "version": "0.0.0",
26165 "filename": "server/api/chatQueue/index.js",
26166 "groupTitle": "Teams"
26170 "url": "/api/mail/queues/{id}/teams",
26171 "title": "Remove teams from a queue",
26174 "title": "Example usage:",
26175 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26179 "name": "RemoveTeams",
26181 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26182 "version": "0.0.0",
26183 "filename": "server/api/mailQueue/index.js",
26184 "groupTitle": "Teams"
26188 "url": "/api/fax/queues/{id}/teams",
26189 "title": "Remove teams from a queue",
26192 "title": "Example usage:",
26193 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26197 "name": "RemoveTeams",
26199 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26200 "version": "0.0.0",
26201 "filename": "server/api/faxQueue/index.js",
26202 "groupTitle": "Teams"
26206 "url": "/api/teams/{id}",
26207 "title": "Gets a single Team",
26210 "title": "Example usage:",
26211 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26215 "name": "ShowTeams",
26217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26218 "version": "0.0.0",
26219 "filename": "server/api/team/index.js",
26220 "groupTitle": "Teams"
26224 "url": "/api/teams/{id}/users",
26225 "title": "Adds agents to a team",
26228 "title": "Example usage:",
26229 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26233 "name": "addAgents",
26235 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26236 "version": "0.0.0",
26237 "filename": "server/api/team/index.js",
26238 "groupTitle": "Teams"
26242 "url": "/api/teams/{id}",
26243 "title": "Update an existing Team",
26246 "title": "Example usage:",
26247 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26251 "name": "updateTeams",
26253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26254 "version": "0.0.0",
26255 "filename": "server/api/team/index.js",
26256 "groupTitle": "Teams"
26260 "url": "/api/templates",
26261 "title": "Creates a new Template",
26264 "title": "Example usage:",
26265 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26269 "name": "CreateTemplates",
26270 "group": "Templates",
26285 "field": "description",
26298 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26299 "version": "0.0.0",
26300 "filename": "server/api/template/index.js",
26301 "groupTitle": "Templates"
26305 "url": "/api/templates/{id}",
26306 "title": "Deletes a Template",
26309 "title": "Example usage:",
26310 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26314 "name": "DeleteTemplates",
26315 "group": "Templates",
26316 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26317 "version": "0.0.0",
26318 "filename": "server/api/template/index.js",
26319 "groupTitle": "Templates"
26323 "url": "/api/templates",
26324 "title": "Gets a list of Templates",
26327 "title": "Example usage:",
26328 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26332 "name": "GetTemplates",
26333 "group": "Templates",
26334 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26335 "version": "0.0.0",
26336 "filename": "server/api/template/index.js",
26337 "groupTitle": "Templates"
26341 "url": "/api/templates/{id}",
26342 "title": "Gets a single Template",
26345 "title": "Example usage:",
26346 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26350 "name": "ShowTemplates",
26351 "group": "Templates",
26352 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26353 "version": "0.0.0",
26354 "filename": "server/api/template/index.js",
26355 "groupTitle": "Templates"
26359 "url": "/api/templates/{id}",
26360 "title": "Update an existing Template",
26363 "title": "Example usage:",
26364 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26368 "name": "updateTemplates",
26369 "group": "Templates",
26370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26371 "version": "0.0.0",
26372 "filename": "server/api/template/index.js",
26373 "groupTitle": "Templates"
26377 "url": "/api/triggers",
26378 "title": "Creates a new Trigger",
26381 "title": "Example usage:",
26382 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26386 "name": "CreateTriggers",
26387 "group": "Triggers",
26402 "field": "channel",
26409 "field": "description",
26422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26423 "version": "0.0.0",
26424 "filename": "server/api/trigger/index.js",
26425 "groupTitle": "Triggers"
26429 "url": "/api/triggers/{id}",
26430 "title": "Deletes a Trigger",
26433 "title": "Example usage:",
26434 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26438 "name": "DeleteTriggers",
26439 "group": "Triggers",
26440 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26441 "version": "0.0.0",
26442 "filename": "server/api/trigger/index.js",
26443 "groupTitle": "Triggers"
26447 "url": "/api/triggers",
26448 "title": "Gets a list of Triggers",
26451 "title": "Example usage:",
26452 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26456 "name": "GetTriggers",
26457 "group": "Triggers",
26458 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26459 "version": "0.0.0",
26460 "filename": "server/api/trigger/index.js",
26461 "groupTitle": "Triggers"
26465 "url": "/api/triggers/{id}",
26466 "title": "Gets a single Trigger",
26469 "title": "Example usage:",
26470 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26474 "name": "ShowTriggers",
26475 "group": "Triggers",
26476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26477 "version": "0.0.0",
26478 "filename": "server/api/trigger/index.js",
26479 "groupTitle": "Triggers"
26483 "url": "/api/triggers/{id}/actions",
26484 "title": "Creates new actions",
26487 "title": "Example usage:",
26488 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26492 "name": "addAction",
26493 "group": "Triggers",
26509 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26516 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26523 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26530 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26563 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26564 "version": "0.0.0",
26565 "filename": "server/api/trigger/index.js",
26566 "groupTitle": "Triggers"
26570 "url": "/api/triggers/{id}/all_conditions",
26571 "title": "Creates a new \"AND\"condition",
26574 "title": "Example usage:",
26575 "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",
26579 "name": "addAllCondition",
26580 "group": "Triggers",
26602 "field": "operator",
26615 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26616 "version": "0.0.0",
26617 "filename": "server/api/trigger/index.js",
26618 "groupTitle": "Triggers"
26622 "url": "/api/triggers/{id}/any_conditions",
26623 "title": "Creates a new \"OR\"condition",
26626 "title": "Example usage:",
26627 "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",
26631 "name": "addAnyCondition",
26632 "group": "Triggers",
26654 "field": "operator",
26667 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26668 "version": "0.0.0",
26669 "filename": "server/api/trigger/index.js",
26670 "groupTitle": "Triggers"
26674 "url": "/api/triggers/{id}/actions",
26675 "title": "Gets Trigger Actions",
26678 "title": "Example usage:",
26679 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26683 "name": "getActions",
26684 "group": "Triggers",
26685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26686 "version": "0.0.0",
26687 "filename": "server/api/trigger/index.js",
26688 "groupTitle": "Triggers"
26692 "url": "/api/triggers/{id}/all_conditions",
26693 "title": "Gets \"AND\" Trigger Conditions",
26696 "title": "Example usage:",
26697 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26701 "name": "getAllConditions",
26702 "group": "Triggers",
26703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26704 "version": "0.0.0",
26705 "filename": "server/api/trigger/index.js",
26706 "groupTitle": "Triggers"
26710 "url": "/api/triggers/{id}/any_conditions",
26711 "title": "Gets \"OR\" Trigger Conditions",
26714 "title": "Example usage:",
26715 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26719 "name": "getAnyConditions",
26720 "group": "Triggers",
26721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26722 "version": "0.0.0",
26723 "filename": "server/api/trigger/index.js",
26724 "groupTitle": "Triggers"
26728 "url": "/api/triggers/{id}",
26729 "title": "Update an existing Trigger",
26732 "title": "Example usage:",
26733 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26737 "name": "updateTriggers",
26738 "group": "Triggers",
26739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26740 "version": "0.0.0",
26741 "filename": "server/api/trigger/index.js",
26742 "groupTitle": "Triggers"
26746 "url": "/api/trunks/clone",
26747 "title": "Clone an existing Trunk",
26750 "title": "Example usage:",
26751 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26755 "name": "CloneTrunks",
26757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26758 "version": "0.0.0",
26759 "filename": "server/api/trunk/index.js",
26760 "groupTitle": "Trunks"
26764 "url": "/api/trunks",
26765 "title": "Create a new trunk",
26768 "title": "Example usage:",
26769 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26801 "field": "context",
26808 "\"ALLOWED_NOT_SCREENED\"",
26809 "\"ALLOWED_PASSED_SCREEN\"",
26810 "\"ALLOWED_FAILED_SCREEN\"",
26812 "\"PROHIB_NOT_SCREENED\"",
26813 "\"PROHIB_PASSED_SCREEN\"",
26814 "\"PROHIB_FAILED_SCREEN\"",
26818 "field": "callingpres",
26846 "field": "md5secret",
26853 "field": "remotesecret",
26860 "field": "transport",
26861 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26874 "field": "dtmfmode",
26888 "field": "directmedia",
26899 "field": "directrtpsetup",
26906 "field": "directmediapermit",
26913 "field": "directmediadeny",
26921 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
26927 "field": "callgroup",
26934 "field": "namedcallgroup",
26941 "field": "pickupgroup",
26948 "field": "namedpickupgroup",
26955 "field": "language",
26962 "field": "tonezone",
26969 "field": "disallow",
26977 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
26987 "field": "autoframing",
26994 "field": "insecure",
26995 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27005 "field": "trustrpid",
27016 "field": "trust_id_outbound",
27028 "field": "progressinband",
27039 "field": "promiscredir",
27050 "field": "useclientcode",
27057 "field": "accountcode",
27071 "field": "callerid",
27078 "field": "amaflags",
27089 "field": "callcounter",
27096 "field": "busylevel",
27107 "field": "allowoverlap",
27118 "field": "allowsubscribe",
27129 "field": "allowtransfer",
27140 "field": "ignoresdpversion",
27147 "field": "subscribecontext",
27154 "field": "template",
27166 "field": "videosupport",
27173 "field": "maxcallbitrate",
27184 "field": "rfc2833compensate",
27191 "field": "mailbox",
27203 "field": "session_timers",
27210 "field": "session_expires",
27217 "field": "session_minse",
27228 "field": "session_refresher",
27235 "field": "t38pt_usertpsource",
27242 "field": "regexten",
27249 "field": "fromdomain",
27256 "field": "fromuser",
27274 "field": "qualify",
27281 "field": "keepalive",
27288 "field": "defaultip",
27295 "field": "defaultuser",
27302 "field": "rtptimeout",
27309 "field": "rtpholdtimeout",
27316 "field": "rtpkeepalive",
27328 "field": "sendrpid",
27335 "field": "outboundproxy",
27342 "field": "callbackextension",
27349 "field": "timert1",
27363 "field": "qualifyfreq",
27370 "field": "contactpermit",
27377 "field": "contactdeny",
27384 "field": "contactacl",
27391 "field": "unsolicited_mailbox",
27398 "field": "use_q850_reason",
27405 "field": "maxforwards",
27416 "field": "encryption",
27438 "field": "force_avp",
27449 "field": "icesupport",
27460 "field": "dtlsenable",
27473 "field": "dtlsverify",
27480 "field": "dtlsrekey",
27487 "field": "dtlscertfile",
27494 "field": "dtlsprivatekey",
27501 "field": "dtlscipher",
27508 "field": "dtlscafile",
27515 "field": "dtlscapath",
27527 "field": "dtlssetup",
27534 "field": "dtlsfingerprint",
27545 "field": "usereqphone",
27552 "field": "recordonfeature",
27559 "field": "recordofffeature",
27566 "field": "call_limit",
27577 "field": "registertrying",
27588 "field": "subscribemwi",
27595 "field": "vmexten",
27602 "field": "mohinterpret",
27609 "field": "mohsuggest",
27616 "field": "parkinglot",
27623 "field": "description",
27644 "field": "canreinvite",
27651 "field": "registry",
27658 "field": "otherFields",
27672 "field": "t38pt_udptl",
27678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27679 "version": "0.0.0",
27680 "filename": "server/api/trunk/index.js",
27681 "groupTitle": "Trunks"
27685 "url": "/api/trunks/{id}",
27686 "title": "Deletes a trunk",
27689 "title": "Example usage:",
27690 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27696 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27697 "version": "0.0.0",
27698 "filename": "server/api/trunk/index.js",
27699 "groupTitle": "Trunks"
27703 "url": "/api/trunks",
27704 "title": "Gets a list of Trunks",
27707 "title": "Example usage:",
27708 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27712 "name": "GetTrunks",
27714 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27715 "version": "0.0.0",
27716 "filename": "server/api/trunk/index.js",
27717 "groupTitle": "Trunks"
27721 "url": "/api/trunks/{id}",
27722 "title": "Gets a single Trunk",
27725 "title": "Example usage:",
27726 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27730 "name": "ShowTrunks",
27732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27733 "version": "0.0.0",
27734 "filename": "server/api/trunk/index.js",
27735 "groupTitle": "Trunks"
27739 "url": "/api/trunks/{id}",
27740 "title": "Update an existing trunk",
27743 "title": "Example usage:",
27744 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27751 "version": "0.0.0",
27752 "filename": "server/api/trunk/index.js",
27753 "groupTitle": "Trunks"
27757 "url": "/api/userProfile/resources",
27758 "title": "Creates a new User Profile Resource",
27761 "title": "Example usage:",
27762 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27766 "name": "CreateUser_Profile_Resources",
27767 "group": "User_Profile_Resources",
27782 "field": "resourceId",
27795 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27796 "version": "0.0.0",
27797 "filename": "server/api/userProfileResource/index.js",
27798 "groupTitle": "User_Profile_Resources"
27802 "url": "/api/userProfile/resources/{id}",
27803 "title": "Deletes a User Profile Resource",
27806 "title": "Example usage:",
27807 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27811 "name": "DeleteUser_Profile_Resources",
27812 "group": "User_Profile_Resources",
27813 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27814 "version": "0.0.0",
27815 "filename": "server/api/userProfileResource/index.js",
27816 "groupTitle": "User_Profile_Resources"
27820 "url": "/api/userProfile/resources/describe",
27821 "title": "Gets table info about User Profile Resources",
27824 "title": "Example usage:",
27825 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27829 "name": "DescribeUser_Profile_Resources",
27830 "group": "User_Profile_Resources",
27831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27832 "version": "0.0.0",
27833 "filename": "server/api/userProfileResource/index.js",
27834 "groupTitle": "User_Profile_Resources"
27838 "url": "/api/userProfile/resources",
27839 "title": "Gets a list of User Profile Resources",
27842 "title": "Example usage:",
27843 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27847 "name": "GetUser_Profile_Resources",
27848 "group": "User_Profile_Resources",
27849 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27850 "version": "0.0.0",
27851 "filename": "server/api/userProfileResource/index.js",
27852 "groupTitle": "User_Profile_Resources"
27856 "url": "/api/userProfile/resources/{id}",
27857 "title": "Gets a single User Profile Resource",
27860 "title": "Example usage:",
27861 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27865 "name": "ShowUser_Profile_Resources",
27866 "group": "User_Profile_Resources",
27867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27868 "version": "0.0.0",
27869 "filename": "server/api/userProfileResource/index.js",
27870 "groupTitle": "User_Profile_Resources"
27874 "url": "/api/userProfile/resources/{id}",
27875 "title": "Update an existing User Profile Resource",
27878 "title": "Example usage:",
27879 "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",
27883 "name": "updateUser_Profile_Resources",
27884 "group": "User_Profile_Resources",
27885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27886 "version": "0.0.0",
27887 "filename": "server/api/userProfileResource/index.js",
27888 "groupTitle": "User_Profile_Resources"
27892 "url": "/api/userProfile/sections",
27893 "title": "Creates a new User Profile Section",
27896 "title": "Example usage:",
27897 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27901 "name": "CreateUser_Profile_Sections",
27902 "group": "User_Profile_Sections",
27917 "field": "category",
27924 "field": "sectionId",
27931 "field": "enabled",
27938 "field": "autoAssociation",
27945 "field": "crudPermissions",
27951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27952 "version": "0.0.0",
27953 "filename": "server/api/userProfileSection/index.js",
27954 "groupTitle": "User_Profile_Sections"
27958 "url": "/api/userProfile/sections/{id}",
27959 "title": "Deletes a User Profile Section",
27962 "title": "Example usage:",
27963 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27967 "name": "DeleteUser_Profile_Sections",
27968 "group": "User_Profile_Sections",
27969 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27970 "version": "0.0.0",
27971 "filename": "server/api/userProfileSection/index.js",
27972 "groupTitle": "User_Profile_Sections"
27976 "url": "/api/userProfile/sections/describe",
27977 "title": "Gets table info about User Profile Sections",
27980 "title": "Example usage:",
27981 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27985 "name": "DescribeUser_Profile_Sections",
27986 "group": "User_Profile_Sections",
27987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27988 "version": "0.0.0",
27989 "filename": "server/api/userProfileSection/index.js",
27990 "groupTitle": "User_Profile_Sections"
27994 "url": "/api/userProfile/sections",
27995 "title": "Gets a list of User Profile Sections",
27998 "title": "Example usage:",
27999 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28003 "name": "GetUser_Profile_Sections",
28004 "group": "User_Profile_Sections",
28005 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28006 "version": "0.0.0",
28007 "filename": "server/api/userProfileSection/index.js",
28008 "groupTitle": "User_Profile_Sections"
28012 "url": "/api/userProfile/sections/{id}",
28013 "title": "Gets a single User Profile Section",
28016 "title": "Example usage:",
28017 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28021 "name": "ShowUser_Profile_Sections",
28022 "group": "User_Profile_Sections",
28023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28024 "version": "0.0.0",
28025 "filename": "server/api/userProfileSection/index.js",
28026 "groupTitle": "User_Profile_Sections"
28030 "url": "/api/userProfile/sections/{id}",
28031 "title": "Update an existing User Profile Section",
28034 "title": "Example usage:",
28035 "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",
28039 "name": "updateUser_Profile_Sections",
28040 "group": "User_Profile_Sections",
28041 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28042 "version": "0.0.0",
28043 "filename": "server/api/userProfileSection/index.js",
28044 "groupTitle": "User_Profile_Sections"
28048 "url": "/api/userProfiles/{id}/resources",
28049 "title": "Add resources' permissions to User Profile",
28052 "title": "Example usage:",
28053 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28057 "name": "AddResources",
28058 "group": "User_Profiles",
28059 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28060 "version": "0.0.0",
28061 "filename": "server/api/userProfile/index.js",
28062 "groupTitle": "User_Profiles"
28066 "url": "/api/userProfiles/{id}/sections",
28067 "title": "Add sections' permissions to User Profile",
28070 "title": "Example usage:",
28071 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28075 "name": "AddSections",
28076 "group": "User_Profiles",
28077 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28078 "version": "0.0.0",
28079 "filename": "server/api/userProfile/index.js",
28080 "groupTitle": "User_Profiles"
28084 "url": "/api/userProfiles/clone",
28085 "title": "Clone an existing User Profile",
28088 "title": "Example usage:",
28089 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28093 "name": "CloneUser_Profiles",
28094 "group": "User_Profiles",
28095 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28096 "version": "0.0.0",
28097 "filename": "server/api/userProfile/index.js",
28098 "groupTitle": "User_Profiles"
28102 "url": "/api/userProfiles",
28103 "title": "Creates a new User Profile",
28106 "title": "Example usage:",
28107 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28111 "name": "CreateUser_Profiles",
28112 "group": "User_Profiles",
28127 "field": "crudPermissions",
28134 "field": "description",
28140 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28141 "version": "0.0.0",
28142 "filename": "server/api/userProfile/index.js",
28143 "groupTitle": "User_Profiles"
28147 "url": "/api/userProfiles/{id}",
28148 "title": "Deletes a User Profile",
28151 "title": "Example usage:",
28152 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28156 "name": "DeleteUser_Profiles",
28157 "group": "User_Profiles",
28158 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28159 "version": "0.0.0",
28160 "filename": "server/api/userProfile/index.js",
28161 "groupTitle": "User_Profiles"
28165 "url": "/api/userProfiles/describe",
28166 "title": "Gets table info about User Profiles",
28169 "title": "Example usage:",
28170 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28174 "name": "DescribeUser_Profiles",
28175 "group": "User_Profiles",
28176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28177 "version": "0.0.0",
28178 "filename": "server/api/userProfile/index.js",
28179 "groupTitle": "User_Profiles"
28183 "url": "/api/userProfiles/{id}/resources?section={section}",
28184 "title": "Get Resources assigned to a Section",
28187 "title": "Example usage:",
28188 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28192 "name": "GetResources",
28193 "group": "User_Profiles",
28194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28195 "version": "0.0.0",
28196 "filename": "server/api/userProfile/index.js",
28197 "groupTitle": "User_Profiles"
28201 "url": "/api/userProfiles/{id}/sections",
28202 "title": "Get sections associated to a User Profile",
28205 "title": "Example usage:",
28206 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28210 "name": "GetSections",
28211 "group": "User_Profiles",
28212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28213 "version": "0.0.0",
28214 "filename": "server/api/userProfile/index.js",
28215 "groupTitle": "User_Profiles"
28219 "url": "/api/userProfiles",
28220 "title": "Gets a list of User Profiles",
28223 "title": "Example usage:",
28224 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28228 "name": "GetUser_Profiles",
28229 "group": "User_Profiles",
28230 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28231 "version": "0.0.0",
28232 "filename": "server/api/userProfile/index.js",
28233 "groupTitle": "User_Profiles"
28237 "url": "/api/userProfiles/{id}/resources",
28238 "title": "Removes resources' permissions from User Profile",
28241 "title": "Example usage:",
28242 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28246 "name": "RemoveResources",
28247 "group": "User_Profiles",
28248 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28249 "version": "0.0.0",
28250 "filename": "server/api/userProfile/index.js",
28251 "groupTitle": "User_Profiles"
28255 "url": "/api/userProfiles/{id}/sections",
28256 "title": "Removes sections' permissions from User Profile",
28259 "title": "Example usage:",
28260 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28264 "name": "RemoveSections",
28265 "group": "User_Profiles",
28266 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28267 "version": "0.0.0",
28268 "filename": "server/api/userProfile/index.js",
28269 "groupTitle": "User_Profiles"
28273 "url": "/api/userProfiles/{id}",
28274 "title": "Gets a single User Profile",
28277 "title": "Example usage:",
28278 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28282 "name": "ShowUser_Profiles",
28283 "group": "User_Profiles",
28284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28285 "version": "0.0.0",
28286 "filename": "server/api/userProfile/index.js",
28287 "groupTitle": "User_Profiles"
28291 "url": "/api/userProfiles/{id}",
28292 "title": "Update an existing User Profile",
28295 "title": "Example usage:",
28296 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28300 "name": "updateUser_Profiles",
28301 "group": "User_Profiles",
28302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28303 "version": "0.0.0",
28304 "filename": "server/api/userProfile/index.js",
28305 "groupTitle": "User_Profiles"
28309 "url": "/api/users/{id}/chat_interactions",
28310 "title": "Add chat interaction tabs to an agent",
28313 "title": "Example usage:",
28314 "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",
28318 "name": "AddChatInteractions",
28320 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28321 "version": "0.0.0",
28322 "filename": "server/api/user/index.js",
28323 "groupTitle": "Users"
28327 "url": "/api/users/{id}/chat_websites",
28328 "title": "Add a Chat Website to a user",
28331 "title": "Example usage:",
28332 "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",
28336 "name": "AddChatWebsites",
28338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28339 "version": "0.0.0",
28340 "filename": "server/api/user/index.js",
28341 "groupTitle": "Users"
28345 "url": "/api/users/{id}/contacts",
28346 "title": "Add contacts to a user",
28349 "title": "Example usage:",
28350 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28354 "name": "AddContacts",
28356 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28357 "version": "0.0.0",
28358 "filename": "server/api/user/index.js",
28359 "groupTitle": "Users"
28363 "url": "/api/users/{id}/fax_accounts",
28364 "title": "Add a Fax Account to a user",
28367 "title": "Example usage:",
28368 "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",
28372 "name": "AddFaxAccounts",
28374 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28375 "version": "0.0.0",
28376 "filename": "server/api/user/index.js",
28377 "groupTitle": "Users"
28381 "url": "/api/users/{id}/fax_interactions",
28382 "title": "Add fax interaction tabs to an agent",
28385 "title": "Example usage:",
28386 "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",
28390 "name": "AddFaxInteractions",
28392 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28393 "version": "0.0.0",
28394 "filename": "server/api/user/index.js",
28395 "groupTitle": "Users"
28399 "url": "/api/users/{id}/mail_accounts",
28400 "title": "Add a Mail Account to a user",
28403 "title": "Example usage:",
28404 "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",
28408 "name": "AddMailAccounts",
28410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28411 "version": "0.0.0",
28412 "filename": "server/api/user/index.js",
28413 "groupTitle": "Users"
28417 "url": "/api/users/{id}/mail_interactions",
28418 "title": "Add mail interaction tabs to an agent",
28421 "title": "Example usage:",
28422 "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",
28426 "name": "AddMailInteractions",
28428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28429 "version": "0.0.0",
28430 "filename": "server/api/user/index.js",
28431 "groupTitle": "Users"
28435 "url": "/api/users/{id}/openchannel_accounts",
28436 "title": "Add a Open Channel Account to a user",
28439 "title": "Example usage:",
28440 "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",
28444 "name": "AddOpenchannelAccounts",
28446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28447 "version": "0.0.0",
28448 "filename": "server/api/user/index.js",
28449 "groupTitle": "Users"
28453 "url": "/api/users/{id}/openchannel_interactions",
28454 "title": "Add openchannel interaction tabs to an agent",
28457 "title": "Example usage:",
28458 "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",
28462 "name": "AddOpenchannelInteractions",
28464 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28465 "version": "0.0.0",
28466 "filename": "server/api/user/index.js",
28467 "groupTitle": "Users"
28471 "url": "/api/users/{id}/queues",
28472 "title": "Add queues to an agent",
28475 "title": "Example usage:",
28476 "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",
28480 "name": "AddQueues",
28482 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28483 "version": "0.0.0",
28484 "filename": "server/api/user/index.js",
28485 "groupTitle": "Users"
28489 "url": "/api/users/{id}/sms_accounts",
28490 "title": "Add a Sms Account to a user",
28493 "title": "Example usage:",
28494 "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",
28498 "name": "AddSmsAccounts",
28500 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28501 "version": "0.0.0",
28502 "filename": "server/api/user/index.js",
28503 "groupTitle": "Users"
28507 "url": "/api/users/{id}/sms_interactions",
28508 "title": "Add sms interaction tabs to an agent",
28511 "title": "Example usage:",
28512 "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",
28516 "name": "AddSmsInteractions",
28518 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28519 "version": "0.0.0",
28520 "filename": "server/api/user/index.js",
28521 "groupTitle": "Users"
28525 "url": "/api/users/{id}/square_projects",
28526 "title": "Add a Square Project to a user",
28529 "title": "Example usage:",
28530 "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",
28534 "name": "AddSquareProjects",
28536 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28537 "version": "0.0.0",
28538 "filename": "server/api/user/index.js",
28539 "groupTitle": "Users"
28543 "url": "/api/users/{id}/teams",
28544 "title": "Add teams to an agent",
28547 "title": "Example usage:",
28548 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28552 "name": "AddTeams",
28554 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28555 "version": "0.0.0",
28556 "filename": "server/api/user/index.js",
28557 "groupTitle": "Users"
28561 "url": "/api/users/{id}/whatsapp_accounts",
28562 "title": "Add a Whatsapp Account to a user",
28565 "title": "Example usage:",
28566 "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",
28570 "name": "AddWhatsappAccounts",
28572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28573 "version": "0.0.0",
28574 "filename": "server/api/user/index.js",
28575 "groupTitle": "Users"
28579 "url": "/api/users/{id}/whatsapp_interactions",
28580 "title": "Add Whatsapp interaction tabs to an agent",
28583 "title": "Example usage:",
28584 "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",
28588 "name": "AddWhatsappInteractions",
28590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28591 "version": "0.0.0",
28592 "filename": "server/api/user/index.js",
28593 "groupTitle": "Users"
28597 "url": "/api/users/{id}/password",
28598 "title": "Change user password",
28601 "title": "Example usage:",
28602 "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",
28606 "name": "ChangePwd",
28608 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28609 "version": "0.0.0",
28610 "filename": "server/api/user/index.js",
28611 "groupTitle": "Users"
28615 "url": "/api/users",
28616 "title": "Create a new user",
28619 "title": "Example usage:",
28620 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28626 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28627 "version": "0.0.0",
28628 "filename": "server/api/user/index.js",
28629 "groupTitle": "Users"
28633 "url": "/api/users/{id}/api_key",
28634 "title": "Create a new API access key for the user",
28637 "title": "Example usage:",
28638 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28642 "name": "CreateApiKey",
28644 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28645 "version": "0.0.0",
28646 "filename": "server/api/user/index.js",
28647 "groupTitle": "Users"
28651 "url": "/api/users/{id}",
28652 "title": "Deletes a user",
28655 "title": "Example usage:",
28656 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28662 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28663 "version": "0.0.0",
28664 "filename": "server/api/user/index.js",
28665 "groupTitle": "Users"
28669 "url": "/api/users/describe",
28670 "title": "Gets table info about Users",
28673 "title": "Example usage:",
28674 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28678 "name": "DescribeUsers",
28680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28681 "version": "0.0.0",
28682 "filename": "server/api/user/index.js",
28683 "groupTitle": "Users"
28687 "url": "/api/users/{id}/agents",
28688 "title": "GetAgents",
28691 "title": "Example usage:",
28692 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28696 "name": "GetAgents",
28698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28699 "version": "0.0.0",
28700 "filename": "server/api/user/index.js",
28701 "groupTitle": "Users"
28705 "url": "/api/users/{id}/api_key",
28706 "title": "Get the API access key for the user",
28709 "title": "Example usage:",
28710 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28714 "name": "GetApiKey",
28716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28717 "version": "0.0.0",
28718 "filename": "server/api/user/index.js",
28719 "groupTitle": "Users"
28723 "url": "/api/users/{id}/groups",
28724 "title": "GetChatGroups",
28727 "title": "Example usage:",
28728 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28732 "name": "GetChatGroups",
28734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28735 "version": "0.0.0",
28736 "filename": "server/api/user/index.js",
28737 "groupTitle": "Users"
28741 "url": "/api/users/{id}/chat/interactions",
28742 "title": "GetChatInteractions",
28745 "title": "Example usage:",
28746 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28750 "name": "GetChatInteractions",
28752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28753 "version": "0.0.0",
28754 "filename": "server/api/user/index.js",
28755 "groupTitle": "Users"
28759 "url": "/api/users/{id}/chat_websites",
28760 "title": "GetChatWebsites",
28763 "title": "Example usage:",
28764 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28768 "name": "GetChatWebsites",
28770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28771 "version": "0.0.0",
28772 "filename": "server/api/user/index.js",
28773 "groupTitle": "Users"
28777 "url": "/api/users/{id}/contacts",
28778 "title": "GetContacts",
28781 "title": "Example usage:",
28782 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28786 "name": "GetContacts",
28788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28789 "version": "0.0.0",
28790 "filename": "server/api/user/index.js",
28791 "groupTitle": "Users"
28795 "url": "/api/users/{id}/fax_accounts",
28796 "title": "GetFaxAccounts",
28799 "title": "Example usage:",
28800 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28804 "name": "GetFaxAccounts",
28806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28807 "version": "0.0.0",
28808 "filename": "server/api/user/index.js",
28809 "groupTitle": "Users"
28813 "url": "/api/users/{id}/fax/interactions",
28814 "title": "GetFaxInteractions",
28817 "title": "Example usage:",
28818 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28822 "name": "GetFaxInteractions",
28824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28825 "version": "0.0.0",
28826 "filename": "server/api/user/index.js",
28827 "groupTitle": "Users"
28831 "url": "/api/users/{id}/lists",
28832 "title": "GetLists",
28835 "title": "Example usage:",
28836 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28840 "name": "GetLists",
28842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28843 "version": "0.0.0",
28844 "filename": "server/api/user/index.js",
28845 "groupTitle": "Users"
28849 "url": "/api/users/{id}/mail_accounts",
28850 "title": "GetMailAccounts",
28853 "title": "Example usage:",
28854 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28858 "name": "GetMailAccounts",
28860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28861 "version": "0.0.0",
28862 "filename": "server/api/user/index.js",
28863 "groupTitle": "Users"
28867 "url": "/api/users/{id}/mail/interactions",
28868 "title": "GetMailInteractions",
28871 "title": "Example usage:",
28872 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28876 "name": "GetMailInteractions",
28878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28879 "version": "0.0.0",
28880 "filename": "server/api/user/index.js",
28881 "groupTitle": "Users"
28885 "url": "/api/users/{id}/openchannel_accounts",
28886 "title": "GetOpenchannelAccounts",
28889 "title": "Example usage:",
28890 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28894 "name": "GetOpenchannelAccounts",
28896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28897 "version": "0.0.0",
28898 "filename": "server/api/user/index.js",
28899 "groupTitle": "Users"
28903 "url": "/api/users/{id}/openchannel/interactions",
28904 "title": "GetOpenchannelInteractions",
28907 "title": "Example usage:",
28908 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28912 "name": "GetOpenchannelInteractions",
28914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28915 "version": "0.0.0",
28916 "filename": "server/api/user/index.js",
28917 "groupTitle": "Users"
28921 "url": "/api/users/{id}/prefixes",
28922 "title": "GetPrefixes",
28925 "title": "Example usage:",
28926 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28930 "name": "GetPrefixes",
28932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28933 "version": "0.0.0",
28934 "filename": "server/api/user/index.js",
28935 "groupTitle": "Users"
28939 "url": "/api/users/{id}/queues?channel={channel}",
28940 "title": "Gets Queues list",
28943 "title": "Example usage:",
28944 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
28948 "name": "GetQueues",
28950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28951 "version": "0.0.0",
28952 "filename": "server/api/user/index.js",
28953 "groupTitle": "Users"
28957 "url": "/api/users/{id}/recordings",
28958 "title": "GetRecordings",
28961 "title": "Example usage:",
28962 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
28966 "name": "GetRecordings",
28968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28969 "version": "0.0.0",
28970 "filename": "server/api/user/index.js",
28971 "groupTitle": "Users"
28975 "url": "/api/users/{id}/scheduled_calls",
28976 "title": "GetScheduledCalls",
28979 "title": "Example usage:",
28980 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
28984 "name": "GetScheduledCalls",
28986 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28987 "version": "0.0.0",
28988 "filename": "server/api/user/index.js",
28989 "groupTitle": "Users"
28993 "url": "/api/users/{id}/screen_recordings",
28994 "title": "GetScreenRecordings",
28997 "title": "Example usage:",
28998 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29002 "name": "GetScreenRecordings",
29004 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29005 "version": "0.0.0",
29006 "filename": "server/api/user/index.js",
29007 "groupTitle": "Users"
29011 "url": "/api/users/{id}/sms_accounts",
29012 "title": "GetSmsAccounts",
29015 "title": "Example usage:",
29016 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29020 "name": "GetSmsAccounts",
29022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29023 "version": "0.0.0",
29024 "filename": "server/api/user/index.js",
29025 "groupTitle": "Users"
29029 "url": "/api/users/{id}/sms/interactions",
29030 "title": "GetSmsInteractions",
29033 "title": "Example usage:",
29034 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29038 "name": "GetSmsInteractions",
29040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29041 "version": "0.0.0",
29042 "filename": "server/api/user/index.js",
29043 "groupTitle": "Users"
29047 "url": "/api/users/{id}/square_projects",
29048 "title": "GetSquareProjects",
29051 "title": "Example usage:",
29052 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29056 "name": "GetSquareProjects",
29058 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29059 "version": "0.0.0",
29060 "filename": "server/api/user/index.js",
29061 "groupTitle": "Users"
29065 "url": "/api/users/{id}/teams",
29066 "title": "GetTeams",
29069 "title": "Example usage:",
29070 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29074 "name": "GetTeams",
29076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29077 "version": "0.0.0",
29078 "filename": "server/api/user/index.js",
29079 "groupTitle": "Users"
29083 "url": "/api/users",
29084 "title": "Gets a list of Users",
29087 "title": "Example usage:",
29088 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29092 "name": "GetUsers",
29094 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29095 "version": "0.0.0",
29096 "filename": "server/api/user/index.js",
29097 "groupTitle": "Users"
29101 "url": "/api/users/{id}/queues_rt",
29102 "title": "GetVoiceQueuesRt",
29105 "title": "Example usage:",
29106 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29110 "name": "GetVoiceQueuesRt",
29112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29113 "version": "0.0.0",
29114 "filename": "server/api/user/index.js",
29115 "groupTitle": "Users"
29119 "url": "/api/users/{id}/whatsapp_accounts",
29120 "title": "GetWhatsappAccounts",
29123 "title": "Example usage:",
29124 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29128 "name": "GetWhatsappAccounts",
29130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29131 "version": "0.0.0",
29132 "filename": "server/api/user/index.js",
29133 "groupTitle": "Users"
29137 "url": "/api/users/{id}/whatsapp/interactions",
29138 "title": "GetWhatsappInteractions",
29141 "title": "Example usage:",
29142 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29146 "name": "GetWhatsappInteractions",
29148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29149 "version": "0.0.0",
29150 "filename": "server/api/user/index.js",
29151 "groupTitle": "Users"
29155 "url": "/api/users/{id}/login",
29159 "title": "Example usage:",
29160 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29166 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29167 "version": "0.0.0",
29168 "filename": "server/api/user/index.js",
29169 "groupTitle": "Users"
29173 "url": "/api/users/{id}/logout",
29177 "title": "Example usage:",
29178 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29185 "version": "0.0.0",
29186 "filename": "server/api/user/index.js",
29187 "groupTitle": "Users"
29191 "url": "/api/users/{id}/pause",
29195 "title": "Example usage:",
29196 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29202 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29203 "version": "0.0.0",
29204 "filename": "server/api/user/index.js",
29205 "groupTitle": "Users"
29209 "url": "/api/users/{id}/api_key",
29210 "title": "Remove API access key for the user",
29213 "title": "Example usage:",
29214 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29218 "name": "RemoveApiKey",
29220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29221 "version": "0.0.0",
29222 "filename": "server/api/user/index.js",
29223 "groupTitle": "Users"
29227 "url": "/api/users/{id}/chat_interactions",
29228 "title": "Removes interactions from an agent",
29231 "title": "Example usage:",
29232 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29236 "name": "RemoveChatInteractions",
29238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29239 "version": "0.0.0",
29240 "filename": "server/api/user/index.js",
29241 "groupTitle": "Users"
29245 "url": "/api/users/{id}/chat_websites",
29246 "title": "Removes a Chat Website from a user",
29249 "title": "Example usage:",
29250 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29254 "name": "RemoveChatWebsites",
29256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29257 "version": "0.0.0",
29258 "filename": "server/api/user/index.js",
29259 "groupTitle": "Users"
29263 "url": "/api/users/{id}/fax_accounts",
29264 "title": "Removes a Fax Account from a user",
29267 "title": "Example usage:",
29268 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29272 "name": "RemoveFaxAccounts",
29274 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29275 "version": "0.0.0",
29276 "filename": "server/api/user/index.js",
29277 "groupTitle": "Users"
29281 "url": "/api/users/{id}/fax_interactions",
29282 "title": "Removes interactions from an agent",
29285 "title": "Example usage:",
29286 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29290 "name": "RemoveFaxInteractions",
29292 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29293 "version": "0.0.0",
29294 "filename": "server/api/user/index.js",
29295 "groupTitle": "Users"
29299 "url": "/api/users/{id}/mail_accounts",
29300 "title": "Removes a Mail Account from a user",
29303 "title": "Example usage:",
29304 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29308 "name": "RemoveMailAccounts",
29310 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29311 "version": "0.0.0",
29312 "filename": "server/api/user/index.js",
29313 "groupTitle": "Users"
29317 "url": "/api/users/{id}/mail_interactions",
29318 "title": "Removes interactions from an agent",
29321 "title": "Example usage:",
29322 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29326 "name": "RemoveMailInteractions",
29328 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29329 "version": "0.0.0",
29330 "filename": "server/api/user/index.js",
29331 "groupTitle": "Users"
29335 "url": "/api/users/{id}/openchannel_accounts",
29336 "title": "Removes a Open Channel Account from a user",
29339 "title": "Example usage:",
29340 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29344 "name": "RemoveOpenchannelAccounts",
29346 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29347 "version": "0.0.0",
29348 "filename": "server/api/user/index.js",
29349 "groupTitle": "Users"
29353 "url": "/api/users/{id}/openchannel_interactions",
29354 "title": "Removes openchannel interactions from an agent",
29357 "title": "Example usage:",
29358 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29362 "name": "RemoveOpenchannelInteractions",
29364 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29365 "version": "0.0.0",
29366 "filename": "server/api/user/index.js",
29367 "groupTitle": "Users"
29371 "url": "/api/users/{id}/queues",
29372 "title": "Remove queues to an agent",
29375 "title": "Example usage:",
29376 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29380 "name": "RemoveQueues",
29382 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29383 "version": "0.0.0",
29384 "filename": "server/api/user/index.js",
29385 "groupTitle": "Users"
29389 "url": "/api/users/{id}/sms_accounts",
29390 "title": "Removes a Sms Account from a user",
29393 "title": "Example usage:",
29394 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29398 "name": "RemoveSmsAccounts",
29400 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29401 "version": "0.0.0",
29402 "filename": "server/api/user/index.js",
29403 "groupTitle": "Users"
29407 "url": "/api/users/{id}/sms_interactions",
29408 "title": "Removes interactions from an agent",
29411 "title": "Example usage:",
29412 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29416 "name": "RemoveSmsInteractions",
29418 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29419 "version": "0.0.0",
29420 "filename": "server/api/user/index.js",
29421 "groupTitle": "Users"
29425 "url": "/api/users/{id}/square_projects",
29426 "title": "Removes a Square Project from a user",
29429 "title": "Example usage:",
29430 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29434 "name": "RemoveSquareProjects",
29436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29437 "version": "0.0.0",
29438 "filename": "server/api/user/index.js",
29439 "groupTitle": "Users"
29443 "url": "/api/users/{id}/teams",
29444 "title": "Removes teams from an agent",
29447 "title": "Example usage:",
29448 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29452 "name": "RemoveTeams",
29454 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29455 "version": "0.0.0",
29456 "filename": "server/api/user/index.js",
29457 "groupTitle": "Users"
29461 "url": "/api/users/{id}/whatsapp_accounts",
29462 "title": "Removes a Whatsapp Account from a user",
29465 "title": "Example usage:",
29466 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29470 "name": "RemoveWhatsappAccounts",
29472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29473 "version": "0.0.0",
29474 "filename": "server/api/user/index.js",
29475 "groupTitle": "Users"
29479 "url": "/api/users/{id}/whatsapp_interactions",
29480 "title": "Removes Whatsapp interactions from an agent",
29483 "title": "Example usage:",
29484 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29488 "name": "RemoveWhatsappInteractions",
29490 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29491 "version": "0.0.0",
29492 "filename": "server/api/user/index.js",
29493 "groupTitle": "Users"
29497 "url": "/api/users/{id}",
29498 "title": "Gets a single User",
29501 "title": "Example usage:",
29502 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29506 "name": "ShowUsers",
29508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29509 "version": "0.0.0",
29510 "filename": "server/api/user/index.js",
29511 "groupTitle": "Users"
29515 "url": "/api/users/{id}/unpause",
29516 "title": "Unpause",
29519 "title": "Example usage:",
29520 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29527 "version": "0.0.0",
29528 "filename": "server/api/user/index.js",
29529 "groupTitle": "Users"
29533 "url": "/api/users/whoami",
29537 "title": "Example usage:",
29538 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29545 "version": "0.0.0",
29546 "filename": "server/api/user/index.js",
29547 "groupTitle": "Users"
29551 "url": "/api/users/{id}/avatar",
29552 "title": "Add avatar",
29555 "title": "Example usage:",
29556 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29560 "name": "addAvatar",
29562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29563 "version": "0.0.0",
29564 "filename": "server/api/user/index.js",
29565 "groupTitle": "Users"
29569 "url": "/api/users/create_many",
29570 "title": "Create Users",
29573 "title": "Example usage:",
29574 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29578 "name": "bulkCreate",
29580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29581 "version": "0.0.0",
29582 "filename": "server/api/user/index.js",
29583 "groupTitle": "Users"
29587 "url": "/api/users/{id}/avatar",
29588 "title": "Get avatar",
29591 "title": "Example usage:",
29592 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29596 "name": "getAvatar",
29598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29599 "version": "0.0.0",
29600 "filename": "server/api/user/index.js",
29601 "groupTitle": "Users"
29605 "url": "/api/users/{id}",
29606 "title": "Update an existing User",
29609 "title": "Example usage:",
29610 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29614 "name": "updateUsers",
29616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29617 "version": "0.0.0",
29618 "filename": "server/api/user/index.js",
29619 "groupTitle": "Users"
29623 "url": "/api/variables",
29624 "title": "Creates a new Variable",
29627 "title": "Example usage:",
29628 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29632 "name": "CreateVariables",
29633 "group": "Variables",
29648 "field": "description",
29654 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29655 "version": "0.0.0",
29656 "filename": "server/api/variable/index.js",
29657 "groupTitle": "Variables"
29661 "url": "/api/variables/{id}",
29662 "title": "Deletes a Variable",
29665 "title": "Example usage:",
29666 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29670 "name": "DeleteVariables",
29671 "group": "Variables",
29672 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29673 "version": "0.0.0",
29674 "filename": "server/api/variable/index.js",
29675 "groupTitle": "Variables"
29679 "url": "/api/variables",
29680 "title": "Gets a list of Variables",
29683 "title": "Example usage:",
29684 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29688 "name": "GetVariables",
29689 "group": "Variables",
29690 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29691 "version": "0.0.0",
29692 "filename": "server/api/variable/index.js",
29693 "groupTitle": "Variables"
29697 "url": "/api/variables/{id}",
29698 "title": "Gets a single Variable",
29701 "title": "Example usage:",
29702 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29706 "name": "ShowVariables",
29707 "group": "Variables",
29708 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29709 "version": "0.0.0",
29710 "filename": "server/api/variable/index.js",
29711 "groupTitle": "Variables"
29715 "url": "/api/variables/{id}",
29716 "title": "Update an existing Variable",
29719 "title": "Example usage:",
29720 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29724 "name": "updateVariables",
29725 "group": "Variables",
29726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29727 "version": "0.0.0",
29728 "filename": "server/api/variable/index.js",
29729 "groupTitle": "Variables"
29733 "url": "/api/version/fetch",
29734 "title": "Fetch git version",
29737 "title": "Example usage:",
29738 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29742 "name": "FetchVersion",
29743 "group": "Version",
29744 "description": "<p>Motion run the following command: git fetch origin master</p>",
29745 "version": "0.0.0",
29746 "filename": "server/api/version/index.js",
29747 "groupTitle": "Version"
29751 "url": "/api/version",
29752 "title": "Gets version",
29755 "title": "Example usage:",
29756 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29760 "name": "GetVersion",
29761 "group": "Version",
29762 "description": "<p>Motion returns the current and latest motion version.</p>",
29763 "version": "0.0.0",
29764 "filename": "server/api/version/index.js",
29765 "groupTitle": "Version"
29769 "url": "/api/version/migrations",
29770 "title": "Launch database migrations",
29773 "title": "Example usage:",
29774 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29778 "name": "MigrateVersion",
29779 "group": "Version",
29780 "description": "<p>Motion launch the database migrations, according to the application version</p>",
29781 "version": "0.0.0",
29782 "filename": "server/api/version/index.js",
29783 "groupTitle": "Version"
29787 "url": "/api/version/pull",
29788 "title": "Pull git version",
29791 "title": "Example usage:",
29792 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29796 "name": "PullVersion",
29797 "group": "Version",
29798 "description": "<p>Motion run the following command: git pull</p>",
29799 "version": "0.0.0",
29800 "filename": "server/api/version/index.js",
29801 "groupTitle": "Version"
29805 "url": "/api/version/reset",
29806 "title": "Reset git version",
29809 "title": "Example usage:",
29810 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29814 "name": "ResetVersion",
29815 "group": "Version",
29816 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29817 "version": "0.0.0",
29818 "filename": "server/api/version/index.js",
29819 "groupTitle": "Version"
29823 "url": "/api/version/restart",
29824 "title": "Restart motion2 after update",
29827 "title": "Example usage:",
29828 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29832 "name": "RestartVersion",
29833 "group": "Version",
29834 "description": "<p>Motion run the following command: pm2 restart motion</p>",
29835 "version": "0.0.0",
29836 "filename": "server/api/version/index.js",
29837 "groupTitle": "Version"
29841 "url": "/api/voice/agents/reports/describe",
29842 "title": "Gets table info about Agent Reports",
29845 "title": "Example usage:",
29846 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29850 "name": "DescribeAgent_Reports",
29851 "group": "Voice_Agent_Reports",
29852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29853 "version": "0.0.0",
29854 "filename": "server/api/voiceAgentReport/index.js",
29855 "groupTitle": "Voice_Agent_Reports"
29859 "url": "/api/voice/agents/reports",
29860 "title": "Gets a list of Agent Reports",
29863 "title": "Example usage:",
29864 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29868 "name": "GetAgent_Reports",
29869 "group": "Voice_Agent_Reports",
29870 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29871 "version": "0.0.0",
29872 "filename": "server/api/voiceAgentReport/index.js",
29873 "groupTitle": "Voice_Agent_Reports"
29877 "url": "/api/voice/agents/reports/{id}",
29878 "title": "Gets a single Agent Report",
29881 "title": "Example usage:",
29882 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29886 "name": "ShowAgent_Reports",
29887 "group": "Voice_Agent_Reports",
29888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29889 "version": "0.0.0",
29890 "filename": "server/api/voiceAgentReport/index.js",
29891 "groupTitle": "Voice_Agent_Reports"
29895 "url": "/api/voice/calls/reports/describe",
29896 "title": "Gets table info about Call Reports",
29899 "title": "Example usage:",
29900 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29904 "name": "DescribeCall_Reports",
29905 "group": "Voice_Call_Reports",
29906 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29907 "version": "0.0.0",
29908 "filename": "server/api/voiceCallReport/index.js",
29909 "groupTitle": "Voice_Call_Reports"
29913 "url": "/api/voice/calls/reports",
29914 "title": "Gets a list of Call Reports",
29917 "title": "Example usage:",
29918 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
29922 "name": "GetCall_Reports",
29923 "group": "Voice_Call_Reports",
29924 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29925 "version": "0.0.0",
29926 "filename": "server/api/voiceCallReport/index.js",
29927 "groupTitle": "Voice_Call_Reports"
29931 "url": "/api/voice/calls/reports/{id}",
29932 "title": "Gets a single Call Report",
29935 "title": "Example usage:",
29936 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
29940 "name": "ShowCall_Reports",
29941 "group": "Voice_Call_Reports",
29942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29943 "version": "0.0.0",
29944 "filename": "server/api/voiceCallReport/index.js",
29945 "groupTitle": "Voice_Call_Reports"
29949 "url": "/api/voice/calls/reports/{id}",
29950 "title": "Update a single cdr",
29953 "title": "Example usage:",
29954 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
29959 "group": "Voice_Call_Reports",
29960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29961 "version": "0.0.0",
29962 "filename": "server/api/voiceCallReport/index.js",
29963 "groupTitle": "Voice_Call_Reports"
29967 "url": "/api/voice/chanspy",
29968 "title": "Creates a new ChanSpy",
29971 "title": "Example usage:",
29972 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29976 "name": "CreateChanSpy",
29977 "group": "Voice_ChanSpy",
29999 "field": "options",
30013 "field": "password",
30027 "field": "recordingFormat",
30034 "field": "description",
30040 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30041 "version": "0.0.0",
30042 "filename": "server/api/voiceChanSpy/index.js",
30043 "groupTitle": "Voice_ChanSpy"
30047 "url": "/api/voice/chanspy/{id}",
30048 "title": "Deletes a ChanSpy",
30051 "title": "Example usage:",
30052 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30056 "name": "DeleteChanSpy",
30057 "group": "Voice_ChanSpy",
30058 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30059 "version": "0.0.0",
30060 "filename": "server/api/voiceChanSpy/index.js",
30061 "groupTitle": "Voice_ChanSpy"
30065 "url": "/api/voice/chanspy",
30066 "title": "Gets a list of ChanSpy",
30069 "title": "Example usage:",
30070 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30074 "name": "GetChanSpy",
30075 "group": "Voice_ChanSpy",
30076 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30077 "version": "0.0.0",
30078 "filename": "server/api/voiceChanSpy/index.js",
30079 "groupTitle": "Voice_ChanSpy"
30083 "url": "/api/voice/chanspy/{id}",
30084 "title": "Gets a single ChanSpy",
30087 "title": "Example usage:",
30088 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30092 "name": "ShowChanSpy",
30093 "group": "Voice_ChanSpy",
30094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30095 "version": "0.0.0",
30096 "filename": "server/api/voiceChanSpy/index.js",
30097 "groupTitle": "Voice_ChanSpy"
30101 "url": "/api/voice/chanspy/{id}",
30102 "title": "Update an existing ChanSpy",
30105 "title": "Example usage:",
30106 "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",
30110 "name": "updateChanSpy",
30111 "group": "Voice_ChanSpy",
30112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30113 "version": "0.0.0",
30114 "filename": "server/api/voiceChanSpy/index.js",
30115 "groupTitle": "Voice_ChanSpy"
30119 "url": "/api/voice/contexts",
30120 "title": "Create a new context",
30123 "title": "Example usage:",
30124 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30129 "group": "Voice_Contexts",
30144 "field": "description",
30151 "field": "defaultEntry",
30157 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30158 "version": "0.0.0",
30159 "filename": "server/api/voiceContext/index.js",
30160 "groupTitle": "Voice_Contexts"
30164 "url": "/api/voice/contexts/{id}",
30165 "title": "Deletes a context",
30168 "title": "Example usage:",
30169 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30174 "group": "Voice_Contexts",
30175 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30176 "version": "0.0.0",
30177 "filename": "server/api/voiceContext/index.js",
30178 "groupTitle": "Voice_Contexts"
30182 "url": "/api/voice/contexts",
30183 "title": "Gets a list of Contexts",
30186 "title": "Example usage:",
30187 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30191 "name": "GetContexts",
30192 "group": "Voice_Contexts",
30193 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30194 "version": "0.0.0",
30195 "filename": "server/api/voiceContext/index.js",
30196 "groupTitle": "Voice_Contexts"
30200 "url": "/api/voice/contexts/{id}",
30201 "title": "Gets a single Context",
30204 "title": "Example usage:",
30205 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30209 "name": "ShowContexts",
30210 "group": "Voice_Contexts",
30211 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30212 "version": "0.0.0",
30213 "filename": "server/api/voiceContext/index.js",
30214 "groupTitle": "Voice_Contexts"
30218 "url": "/api/voice/contexts/{id}",
30219 "title": "Update an existing context",
30222 "title": "Example usage:",
30223 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30228 "group": "Voice_Contexts",
30229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30230 "version": "0.0.0",
30231 "filename": "server/api/voiceContext/index.js",
30232 "groupTitle": "Voice_Contexts"
30236 "url": "/api/voice/dials/reports/describe",
30237 "title": "Gets table info about Dial Reports",
30240 "title": "Example usage:",
30241 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30245 "name": "DescribeDial_Reports",
30246 "group": "Voice_Dial_Reports",
30247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30248 "version": "0.0.0",
30249 "filename": "server/api/voiceDialReport/index.js",
30250 "groupTitle": "Voice_Dial_Reports"
30254 "url": "/api/voice/dials/reports",
30255 "title": "Gets a list of Dial Reports",
30258 "title": "Example usage:",
30259 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30263 "name": "GetDial_Reports",
30264 "group": "Voice_Dial_Reports",
30265 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30266 "version": "0.0.0",
30267 "filename": "server/api/voiceDialReport/index.js",
30268 "groupTitle": "Voice_Dial_Reports"
30272 "url": "/api/voice/dials/reports/{id}",
30273 "title": "Gets a single Dial Report",
30276 "title": "Example usage:",
30277 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30281 "name": "ShowDial_Reports",
30282 "group": "Voice_Dial_Reports",
30283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30284 "version": "0.0.0",
30285 "filename": "server/api/voiceDialReport/index.js",
30286 "groupTitle": "Voice_Dial_Reports"
30290 "url": "/api/voice/extensions/{id}",
30291 "title": "Deletes a Extension",
30294 "title": "Example usage:",
30295 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30299 "name": "DeleteExtensions",
30300 "group": "Voice_Extensions",
30301 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30302 "version": "0.0.0",
30303 "filename": "server/api/voiceExtension/index.js",
30304 "groupTitle": "Voice_Extensions"
30308 "url": "/api/voice/extensions",
30309 "title": "Gets a list of Extensions",
30312 "title": "Example usage:",
30313 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30317 "name": "GetExtensions",
30318 "group": "Voice_Extensions",
30319 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30320 "version": "0.0.0",
30321 "filename": "server/api/voiceExtension/index.js",
30322 "groupTitle": "Voice_Extensions"
30326 "url": "/api/voice/extensions/{id}",
30327 "title": "Gets a single Extension",
30330 "title": "Example usage:",
30331 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30335 "name": "ShowExtensions",
30336 "group": "Voice_Extensions",
30337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30338 "version": "0.0.0",
30339 "filename": "server/api/voiceExtension/index.js",
30340 "groupTitle": "Voice_Extensions"
30344 "url": "/api/voice/extensions",
30345 "title": "Create new applications",
30348 "title": "Example usage:",
30349 "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",
30353 "name": "addApplications",
30354 "group": "Voice_Extensions",
30355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30356 "version": "0.0.0",
30357 "filename": "server/api/voiceExtension/index.js",
30358 "groupTitle": "Voice_Extensions"
30362 "url": "/api/voice/extensions",
30363 "title": "Create an extension",
30366 "title": "Example usage:",
30367 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30372 "group": "Voice_Extensions",
30373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30374 "version": "0.0.0",
30375 "filename": "server/api/voiceExtension/index.js",
30376 "groupTitle": "Voice_Extensions"
30380 "url": "/api/voice/extensions/{id}",
30381 "title": "Update an extension",
30384 "title": "Example usage:",
30385 "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",
30390 "group": "Voice_Extensions",
30391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30392 "version": "0.0.0",
30393 "filename": "server/api/voiceExtension/index.js",
30394 "groupTitle": "Voice_Extensions"
30398 "url": "/api/voice/mohs",
30399 "title": "Create a new a new MOH",
30402 "title": "Example usage:",
30403 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30408 "group": "Voice_MOHs",
30409 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30410 "version": "0.0.0",
30411 "filename": "server/api/voiceMusicOnHold/index.js",
30412 "groupTitle": "Voice_MOHs"
30416 "url": "/api/voice/mohs/{id}/sounds",
30417 "title": "Add sound to MOH",
30420 "title": "Example usage:",
30421 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30425 "name": "AddSound",
30426 "group": "Voice_MOHs",
30427 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30428 "version": "0.0.0",
30429 "filename": "server/api/voiceMusicOnHold/index.js",
30430 "groupTitle": "Voice_MOHs"
30434 "url": "/api/voice/mohs/{id}",
30435 "title": "Deletes an MOH",
30438 "title": "Example usage:",
30439 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30443 "name": "DestroyMoh",
30444 "group": "Voice_MOHs",
30445 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30446 "version": "0.0.0",
30447 "filename": "server/api/voiceMusicOnHold/index.js",
30448 "groupTitle": "Voice_MOHs"
30452 "url": "/api/voice/mohs",
30453 "title": "Gets a list of Music On Holds",
30456 "title": "Example usage:",
30457 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30461 "name": "GetMusic_On_Holds",
30462 "group": "Voice_MOHs",
30463 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30464 "version": "0.0.0",
30465 "filename": "server/api/voiceMusicOnHold/index.js",
30466 "groupTitle": "Voice_MOHs"
30470 "url": "/api/voice/mohs/{id}/sounds",
30471 "title": "Gets sounds from MOH",
30474 "title": "Example usage:",
30475 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30479 "name": "GetSounds",
30480 "group": "Voice_MOHs",
30481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30482 "version": "0.0.0",
30483 "filename": "server/api/voiceMusicOnHold/index.js",
30484 "groupTitle": "Voice_MOHs"
30488 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30489 "title": "Remove sound from MOH",
30492 "title": "Example usage:",
30493 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30497 "name": "RemoveSound",
30498 "group": "Voice_MOHs",
30499 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30500 "version": "0.0.0",
30501 "filename": "server/api/voiceMusicOnHold/index.js",
30502 "groupTitle": "Voice_MOHs"
30506 "url": "/api/voice/mohs/{id}",
30507 "title": "Gets a single Music On Hold",
30510 "title": "Example usage:",
30511 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30515 "name": "ShowMusic_On_Holds",
30516 "group": "Voice_MOHs",
30517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30518 "version": "0.0.0",
30519 "filename": "server/api/voiceMusicOnHold/index.js",
30520 "groupTitle": "Voice_MOHs"
30524 "url": "/api/voice/mohs/{id}",
30525 "title": "Update an existing Music On Hold",
30528 "title": "Example usage:",
30529 "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",
30533 "name": "updateMusic_On_Holds",
30534 "group": "Voice_MOHs",
30535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30536 "version": "0.0.0",
30537 "filename": "server/api/voiceMusicOnHold/index.js",
30538 "groupTitle": "Voice_MOHs"
30542 "url": "/api/voice/mails",
30543 "title": "Creates a new Mail",
30546 "title": "Example usage:",
30547 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30551 "name": "CreateMails",
30552 "group": "Voice_Mails",
30560 "field": "customer_id",
30567 "field": "context",
30574 "field": "mailbox",
30581 "field": "password",
30588 "field": "fullname",
30638 "field": "dialout",
30645 "field": "callback",
30667 "field": "operator",
30678 "field": "envelope",
30689 "field": "sayduration",
30696 "field": "saydurationm",
30707 "field": "sendvoicemail",
30729 "field": "nextaftercmd",
30740 "field": "forcename",
30751 "field": "forcegreetings",
30762 "field": "hidefromdir",
30776 "field": "emailsubject",
30783 "field": "emailbody",
30790 "field": "maxsecs",
30810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30811 "version": "0.0.0",
30812 "filename": "server/api/voiceMail/index.js",
30813 "groupTitle": "Voice_Mails"
30817 "url": "/api/voice/mails/{id}",
30818 "title": "Deletes a Mail",
30821 "title": "Example usage:",
30822 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30826 "name": "DeleteMails",
30827 "group": "Voice_Mails",
30828 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30829 "version": "0.0.0",
30830 "filename": "server/api/voiceMail/index.js",
30831 "groupTitle": "Voice_Mails"
30835 "url": "/api/voice/mails",
30836 "title": "Gets a list of Mails",
30839 "title": "Example usage:",
30840 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30844 "name": "GetMails",
30845 "group": "Voice_Mails",
30846 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30847 "version": "0.0.0",
30848 "filename": "server/api/voiceMail/index.js",
30849 "groupTitle": "Voice_Mails"
30853 "url": "/api/voice/mails/{id}",
30854 "title": "Gets a single Mail",
30857 "title": "Example usage:",
30858 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30862 "name": "ShowMails",
30863 "group": "Voice_Mails",
30864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30865 "version": "0.0.0",
30866 "filename": "server/api/voiceMail/index.js",
30867 "groupTitle": "Voice_Mails"
30871 "url": "/api/voice/mails/{id}/messages",
30872 "title": "Gets voice mail messages",
30875 "title": "Example usage:",
30876 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30880 "name": "getMessages",
30881 "group": "Voice_Mails",
30882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30883 "version": "0.0.0",
30884 "filename": "server/api/voiceMail/index.js",
30885 "groupTitle": "Voice_Mails"
30889 "url": "/api/voice/mails/{id}",
30890 "title": "Update an existing Mail",
30893 "title": "Example usage:",
30894 "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",
30898 "name": "updateMails",
30899 "group": "Voice_Mails",
30900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30901 "version": "0.0.0",
30902 "filename": "server/api/voiceMail/index.js",
30903 "groupTitle": "Voice_Mails"
30907 "url": "/api/voice/mails/messages",
30908 "title": "Creates a new Message",
30911 "title": "Example usage:",
30912 "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",
30916 "name": "CreateMessages",
30917 "group": "Voice_Messages",
30946 "field": "context",
30953 "field": "macrocontext",
30960 "field": "callerid",
30967 "field": "origtime",
30974 "field": "duration",
30981 "field": "mailboxuser",
30988 "field": "mailboxcontext",
30995 "field": "recording",
31022 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31023 "version": "0.0.0",
31024 "filename": "server/api/voiceMailMessage/index.js",
31025 "groupTitle": "Voice_Messages"
31029 "url": "/api/voice/mails/messages/{id}",
31030 "title": "Deletes a Message",
31033 "title": "Example usage:",
31034 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31038 "name": "DeleteMessages",
31039 "group": "Voice_Messages",
31040 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31041 "version": "0.0.0",
31042 "filename": "server/api/voiceMailMessage/index.js",
31043 "groupTitle": "Voice_Messages"
31047 "url": "/api/voice/mails/messages",
31048 "title": "Gets a list of Messages",
31051 "title": "Example usage:",
31052 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31056 "name": "GetMessages",
31057 "group": "Voice_Messages",
31058 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31059 "version": "0.0.0",
31060 "filename": "server/api/voiceMailMessage/index.js",
31061 "groupTitle": "Voice_Messages"
31065 "url": "/api/voice/mails/messages/{id}",
31066 "title": "Gets a single Message",
31069 "title": "Example usage:",
31070 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31074 "name": "ShowMessages",
31075 "group": "Voice_Messages",
31076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31077 "version": "0.0.0",
31078 "filename": "server/api/voiceMailMessage/index.js",
31079 "groupTitle": "Voice_Messages"
31083 "url": "voice/mails/messages/{id}/download",
31084 "title": "Download Voice Message",
31087 "title": "Example usage:",
31088 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31092 "name": "download",
31093 "group": "Voice_Messages",
31094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31095 "version": "0.0.0",
31096 "filename": "server/api/voiceMailMessage/index.js",
31097 "groupTitle": "Voice_Messages"
31101 "url": "/api/voice/mails/messages/{id}",
31102 "title": "Update an existing Message",
31105 "title": "Example usage:",
31106 "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",
31110 "name": "updateMessages",
31111 "group": "Voice_Messages",
31112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31113 "version": "0.0.0",
31114 "filename": "server/api/voiceMailMessage/index.js",
31115 "groupTitle": "Voice_Messages"
31119 "url": "/api/voice/prefixes/{id}/users",
31120 "title": "Add agents to a prefix",
31123 "title": "Example usage:",
31124 "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",
31128 "name": "AddAgents",
31129 "group": "Voice_Prefixes",
31130 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31131 "version": "0.0.0",
31132 "filename": "server/api/voicePrefix/index.js",
31133 "groupTitle": "Voice_Prefixes"
31137 "url": "/api/voice/prefixes/{id}",
31138 "title": "Deletes a Prefix",
31141 "title": "Example usage:",
31142 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31146 "name": "DeletePrefixes",
31147 "group": "Voice_Prefixes",
31148 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31149 "version": "0.0.0",
31150 "filename": "server/api/voicePrefix/index.js",
31151 "groupTitle": "Voice_Prefixes"
31155 "url": "/api/voice/prefixes/describe",
31156 "title": "Gets table info about Prefixes",
31159 "title": "Example usage:",
31160 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31164 "name": "DescribePrefixes",
31165 "group": "Voice_Prefixes",
31166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31167 "version": "0.0.0",
31168 "filename": "server/api/voicePrefix/index.js",
31169 "groupTitle": "Voice_Prefixes"
31173 "url": "/api/voice/prefixes/{id}/users",
31174 "title": "Gets agents from prefix",
31177 "title": "Example usage:",
31178 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31182 "name": "GetAgents",
31183 "group": "Voice_Prefixes",
31184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31185 "version": "0.0.0",
31186 "filename": "server/api/voicePrefix/index.js",
31187 "groupTitle": "Voice_Prefixes"
31191 "url": "/api/voice/prefixes",
31192 "title": "Gets a list of Prefixes",
31195 "title": "Example usage:",
31196 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31200 "name": "GetPrefixes",
31201 "group": "Voice_Prefixes",
31202 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31203 "version": "0.0.0",
31204 "filename": "server/api/voicePrefix/index.js",
31205 "groupTitle": "Voice_Prefixes"
31209 "url": "/api/voice/prefixes/{id}/users",
31210 "title": "Removes agents from a prefix",
31213 "title": "Example usage:",
31214 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31218 "name": "RemoveAgents",
31219 "group": "Voice_Prefixes",
31220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31221 "version": "0.0.0",
31222 "filename": "server/api/voicePrefix/index.js",
31223 "groupTitle": "Voice_Prefixes"
31227 "url": "/api/voice/prefixes/{id}",
31228 "title": "Gets a single Prefix",
31231 "title": "Example usage:",
31232 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31236 "name": "ShowPrefixes",
31237 "group": "Voice_Prefixes",
31238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31239 "version": "0.0.0",
31240 "filename": "server/api/voicePrefix/index.js",
31241 "groupTitle": "Voice_Prefixes"
31245 "url": "/api/voice/prefixes/{id}",
31246 "title": "Update an existing prefix",
31249 "title": "Example usage:",
31250 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31255 "group": "Voice_Prefixes",
31256 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31257 "version": "0.0.0",
31258 "filename": "server/api/voicePrefix/index.js",
31259 "groupTitle": "Voice_Prefixes"
31263 "url": "/api/voice/prefixes",
31264 "title": "Create a prefix",
31267 "title": "Example usage:",
31268 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31273 "group": "Voice_Prefixes",
31274 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31275 "version": "0.0.0",
31276 "filename": "server/api/voicePrefix/index.js",
31277 "groupTitle": "Voice_Prefixes"
31281 "url": "/api/voice/queues/reports/describe",
31282 "title": "Gets table info about Queue Reports",
31285 "title": "Example usage:",
31286 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31290 "name": "DescribeQueue_Reports",
31291 "group": "Voice_Queue_Reports",
31292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31293 "version": "0.0.0",
31294 "filename": "server/api/voiceQueueReport/index.js",
31295 "groupTitle": "Voice_Queue_Reports"
31299 "url": "/api/voice/queues/reports",
31300 "title": "Gets a list of Queue Reports",
31303 "title": "Example usage:",
31304 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31308 "name": "GetQueue_Reports",
31309 "group": "Voice_Queue_Reports",
31310 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31311 "version": "0.0.0",
31312 "filename": "server/api/voiceQueueReport/index.js",
31313 "groupTitle": "Voice_Queue_Reports"
31317 "url": "/api/voice/queues/reports/{id}",
31318 "title": "Gets a single Queue Report",
31321 "title": "Example usage:",
31322 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31326 "name": "ShowQueue_Reports",
31327 "group": "Voice_Queue_Reports",
31328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31329 "version": "0.0.0",
31330 "filename": "server/api/voiceQueueReport/index.js",
31331 "groupTitle": "Voice_Queue_Reports"
31335 "url": "/api/voice/queues/reports/index",
31336 "title": "Get Voice Queues Report",
31339 "title": "Example usage:",
31340 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31344 "name": "getVoiceQueuesReport",
31345 "group": "Voice_Queue_Reports",
31346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31347 "version": "0.0.0",
31348 "filename": "server/api/voiceQueueReport/index.js",
31349 "groupTitle": "Voice_Queue_Reports"
31353 "url": "/api/voice/queues/{id}/users",
31354 "title": "Add agents to queue",
31357 "title": "Example usage:",
31358 "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",
31362 "name": "AddAgents",
31363 "group": "Voice_Queues",
31364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31365 "version": "0.0.0",
31366 "filename": "server/api/voiceQueue/index.js",
31367 "groupTitle": "Voice_Queues"
31371 "url": "/api/voice/queues/{id}/blacklists",
31372 "title": "Add blacklists to a queue",
31375 "title": "Example usage:",
31376 "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",
31380 "name": "AddBlackLists",
31381 "group": "Voice_Queues",
31382 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31383 "version": "0.0.0",
31384 "filename": "server/api/voiceQueue/index.js",
31385 "groupTitle": "Voice_Queues"
31389 "url": "/api/voice/queues/{id}/lists",
31390 "title": "Add lists to a queue",
31393 "title": "Example usage:",
31394 "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",
31398 "name": "AddLists",
31399 "group": "Voice_Queues",
31400 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31401 "version": "0.0.0",
31402 "filename": "server/api/voiceQueue/index.js",
31403 "groupTitle": "Voice_Queues"
31407 "url": "/api/voice/queues/{id}/teams",
31408 "title": "Add teams to queue",
31411 "title": "Example usage:",
31412 "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",
31416 "name": "AddTeams",
31417 "group": "Voice_Queues",
31418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31419 "version": "0.0.0",
31420 "filename": "server/api/voiceQueue/index.js",
31421 "groupTitle": "Voice_Queues"
31425 "url": "/api/voice/queues/clone",
31426 "title": "Clone an existing Queue",
31429 "title": "Example usage:",
31430 "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",
31434 "name": "CloneQueues",
31435 "group": "Voice_Queues",
31436 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31437 "version": "0.0.0",
31438 "filename": "server/api/voiceQueue/index.js",
31439 "groupTitle": "Voice_Queues"
31443 "url": "/api/voice/queues",
31444 "title": "Creates a new Queue",
31447 "title": "Example usage:",
31448 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31452 "name": "CreateQueues",
31453 "group": "Voice_Queues",
31479 "field": "musiconhold",
31486 "field": "announce",
31504 "field": "strategy",
31511 "field": "servicelevel",
31518 "field": "context",
31525 "field": "penaltymemberslimit",
31532 "field": "timeout",
31546 "field": "timeoutpriority",
31560 "field": "wrapuptime",
31571 "field": "autofill",
31583 "field": "autopause",
31590 "field": "autopausedelay",
31601 "field": "autopausebusy",
31612 "field": "autopauseunavail",
31630 "field": "setinterfacevar",
31641 "field": "setqueueentryvar",
31652 "field": "setqueuevar",
31663 "field": "eventmemberstatus",
31670 "field": "membermacro",
31677 "field": "membergosub",
31684 "field": "announce_frequency",
31691 "field": "min_announce_frequency",
31698 "field": "periodic_announce_frequency",
31709 "field": "random_periodic_announce",
31720 "field": "relative_periodic_announce",
31732 "field": "announce_holdtime",
31739 "field": "announce_position",
31750 "field": "announce_to_first_user",
31757 "field": "announce_position_limit",
31772 "field": "announce_round_seconds",
31779 "field": "monitor_format",
31786 "field": "monitor_type",
31793 "field": "queue_youarenext",
31800 "field": "queue_thereare",
31807 "field": "queue_callswaiting",
31814 "field": "queue_holdtime",
31821 "field": "queue_minute",
31828 "field": "queue_minutes",
31835 "field": "queue_seconds",
31842 "field": "queue_thankyou",
31849 "field": "queue_reporthold",
31856 "field": "queue_quantity1",
31863 "field": "queue_quantity2",
31870 "field": "queue_periodic_announce",
31877 "field": "queue_less_than",
31884 "field": "periodic_announce",
31891 "field": "joinempty",
31898 "field": "leavewhenempty",
31909 "field": "reportholdtime",
31920 "field": "ringinuse",
31927 "field": "memberdelay",
31938 "field": "timeoutrestart",
31945 "field": "defaultrule",
31952 "field": "description",
31966 "field": "acwTimeout",
31973 "field": "dialActive",
31974 "description": "<p>Active/Disactive Campaign</p>"
31987 "field": "dialMethod",
31988 "description": "<p>Dial Method.</p>"
31994 "field": "dialLimitChannel",
31995 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32001 "field": "dialLimitQueue",
32002 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32008 "field": "dialPowerLevel",
32009 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32015 "\"agentBusyFactor\"",
32019 "field": "dialPredictiveOptimization",
32020 "description": "<p>Only for predictive method.</p>"
32026 "field": "dialPredictiveOptimizationPercentage",
32027 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32033 "field": "dialPredictiveInterval",
32034 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32040 "field": "dialOriginateCallerIdName",
32047 "field": "dialOriginateCallerIdNumber",
32054 "field": "dialOriginateTimeout",
32055 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32061 "field": "dialQueueOptions",
32062 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32068 "field": "dialQueueTimeout",
32069 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32075 "field": "dialQueueProject",
32076 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32082 "field": "dialCongestionMaxRetry",
32083 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32089 "field": "dialCongestionRetryFrequency",
32090 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32096 "field": "dialBusyMaxRetry",
32097 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32103 "field": "dialBusyRetryFrequency",
32104 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32110 "field": "dialNoAnswerMaxRetry",
32111 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32117 "field": "dialNoAnswerRetryFrequency",
32118 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32124 "field": "dialGlobalMaxRetry",
32125 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32131 "field": "dialTimezone",
32138 "field": "dialGlobalInterval",
32145 "field": "dialPrefix",
32157 "field": "dialCheckDuplicateType",
32164 "field": "dialAMDActive",
32165 "description": "<p>Active/Disactive AMD</p>"
32171 "field": "dialAMDInitialSilence",
32172 "description": "<p>#AMD Initial Silence</p>"
32178 "field": "dialAMDGreeting",
32179 "description": "<p>#AMD Greeting</p>"
32185 "field": "dialAMDAfterGreetingSilence",
32186 "description": "<p>#AMD After Greeting Silence</p>"
32192 "field": "dialAMDTotalAnalysisTime",
32193 "description": "<p>#AMD Total Analysis Time</p>"
32199 "field": "dialAMDMinWordLength",
32200 "description": "<p>#AMD Min Word Length</p>"
32206 "field": "dialAMDBetweenWordsSilence",
32207 "description": "<p>#AMD Between Words Silence</p>"
32213 "field": "dialAMDMaximumNumberOfWords",
32214 "description": "<p>#AMD Maximum Number Of Words</p>"
32220 "field": "dialAMDSilenceThreshold",
32221 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32227 "field": "dialAMDMaximumWordLength",
32228 "description": "<p>#AMD Maximum Word Length</p>"
32234 "field": "dialRecallMeTimeout",
32235 "description": "<p>#RecallMe Timeout (min:1)</p>"
32241 "field": "dialRecallInQueue",
32242 "description": "<p>Active/Disactive Recall In Queue</p>"
32252 "field": "dialOrderByScheduledAt",
32259 "field": "dialQueueProject2",
32260 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32266 "field": "dialAgiAfterHangupClient",
32273 "field": "dialAgiAfterHangupAgent",
32280 "field": "dialRandomLastDigitCallerIdNumber",
32281 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32287 "field": "dialCutDigit",
32288 "description": "<p>Cut Digit (min:1, max:15)</p>"
32294 "field": "dialNoSuchNumberMaxRetry",
32295 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32301 "field": "dialNoSuchNumberRetryFrequency",
32302 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32308 "field": "dialDropMaxRetry",
32309 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32315 "field": "dialDropRetryFrequency",
32316 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32322 "field": "dialAbandonedMaxRetry",
32323 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32329 "field": "dialAbandonedRetryFrequency",
32330 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32336 "field": "dialMachineMaxRetry",
32337 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32343 "field": "dialMachineRetryFrequency",
32344 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32350 "field": "dialAgentRejectMaxRetry",
32351 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32357 "field": "dialAgentRejectRetryFrequency",
32358 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32364 "field": "mandatoryDispositionPauseId",
32365 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32371 "field": "mandatoryDisposition",
32372 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32378 "field": "dialPredictiveIntervalMaxThreshold",
32385 "field": "dialPredictiveIntervalMinThreshold",
32391 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32392 "version": "0.0.0",
32393 "filename": "server/api/voiceQueue/index.js",
32394 "groupTitle": "Voice_Queues"
32398 "url": "/api/voice/queues/{id}",
32399 "title": "Deletes a Queue",
32402 "title": "Example usage:",
32403 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32407 "name": "DeleteQueues",
32408 "group": "Voice_Queues",
32409 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32410 "version": "0.0.0",
32411 "filename": "server/api/voiceQueue/index.js",
32412 "groupTitle": "Voice_Queues"
32416 "url": "/api/voice/queues/{id}/users",
32417 "title": "Gets queue agents",
32420 "title": "Example usage:",
32421 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32425 "name": "GetAgents",
32426 "group": "Voice_Queues",
32427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32428 "version": "0.0.0",
32429 "filename": "server/api/voiceQueue/index.js",
32430 "groupTitle": "Voice_Queues"
32434 "url": "/api/voice/queues/{id}/blacklists",
32435 "title": "Get queue blacklists",
32438 "title": "Example usage:",
32439 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32443 "name": "GetBlackLists",
32444 "group": "Voice_Queues",
32445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32446 "version": "0.0.0",
32447 "filename": "server/api/voiceQueue/index.js",
32448 "groupTitle": "Voice_Queues"
32452 "url": "/api/voice/queues/{id}/finals",
32453 "title": "Gets queue hopper finals",
32456 "title": "Example usage:",
32457 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32461 "name": "GetHopperFinals",
32462 "group": "Voice_Queues",
32463 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32464 "version": "0.0.0",
32465 "filename": "server/api/voiceQueue/index.js",
32466 "groupTitle": "Voice_Queues"
32470 "url": "/api/voice/queues/{id}/hopper_histories",
32471 "title": "Gets queue hopper histories",
32474 "title": "Example usage:",
32475 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32479 "name": "GetHopperHistories",
32480 "group": "Voice_Queues",
32481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32482 "version": "0.0.0",
32483 "filename": "server/api/voiceQueue/index.js",
32484 "groupTitle": "Voice_Queues"
32488 "url": "/api/voice/queues/{id}/hoppers",
32489 "title": "Gets queue hoppers",
32492 "title": "Example usage:",
32493 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32497 "name": "GetHoppers",
32498 "group": "Voice_Queues",
32499 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32500 "version": "0.0.0",
32501 "filename": "server/api/voiceQueue/index.js",
32502 "groupTitle": "Voice_Queues"
32506 "url": "/api/voice/queues/{id}/lists",
32507 "title": "Get queue lists",
32510 "title": "Example usage:",
32511 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32515 "name": "GetLists",
32516 "group": "Voice_Queues",
32517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32518 "version": "0.0.0",
32519 "filename": "server/api/voiceQueue/index.js",
32520 "groupTitle": "Voice_Queues"
32524 "url": "/api/voice/queues/{id}/members",
32525 "title": "Gets queue members",
32528 "title": "Example usage:",
32529 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32533 "name": "GetMembers",
32534 "group": "Voice_Queues",
32535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32536 "version": "0.0.0",
32537 "filename": "server/api/voiceQueue/index.js",
32538 "groupTitle": "Voice_Queues"
32542 "url": "/api/voice/queues",
32543 "title": "Gets a list of Queues",
32546 "title": "Example usage:",
32547 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32551 "name": "GetQueues",
32552 "group": "Voice_Queues",
32553 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32554 "version": "0.0.0",
32555 "filename": "server/api/voiceQueue/index.js",
32556 "groupTitle": "Voice_Queues"
32560 "url": "/api/voice/queues/{id}/teams",
32561 "title": "Gets queue team",
32564 "title": "Example usage:",
32565 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32569 "name": "GetTeams",
32570 "group": "Voice_Queues",
32571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32572 "version": "0.0.0",
32573 "filename": "server/api/voiceQueue/index.js",
32574 "groupTitle": "Voice_Queues"
32578 "url": "/api/voice/queues/{id}/users",
32579 "title": "Removes agents from a queue",
32582 "title": "Example usage:",
32583 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32587 "name": "RemoveAgents",
32588 "group": "Voice_Queues",
32589 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32590 "version": "0.0.0",
32591 "filename": "server/api/voiceQueue/index.js",
32592 "groupTitle": "Voice_Queues"
32596 "url": "/api/voice/queues/{id}/blacklists",
32597 "title": "Remove blacklists from a queue",
32600 "title": "Example usage:",
32601 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32605 "name": "RemoveBlackLists",
32606 "group": "Voice_Queues",
32607 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32608 "version": "0.0.0",
32609 "filename": "server/api/voiceQueue/index.js",
32610 "groupTitle": "Voice_Queues"
32614 "url": "/api/voice/queues/{id}/lists",
32615 "title": "Remove lists from a queue",
32618 "title": "Example usage:",
32619 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32623 "name": "RemoveLists",
32624 "group": "Voice_Queues",
32625 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32626 "version": "0.0.0",
32627 "filename": "server/api/voiceQueue/index.js",
32628 "groupTitle": "Voice_Queues"
32632 "url": "/api/voice/queues/{id}",
32633 "title": "Gets a single Queue",
32636 "title": "Example usage:",
32637 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32641 "name": "ShowQueues",
32642 "group": "Voice_Queues",
32643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32644 "version": "0.0.0",
32645 "filename": "server/api/voiceQueue/index.js",
32646 "groupTitle": "Voice_Queues"
32650 "url": "/api/voice/queues/{id}/blacks",
32651 "title": "Gets queue hopper blacks",
32654 "title": "Example usage:",
32655 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
32659 "name": "getHopperBlacks",
32660 "group": "Voice_Queues",
32661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32662 "version": "0.0.0",
32663 "filename": "server/api/voiceQueue/index.js",
32664 "groupTitle": "Voice_Queues"
32668 "url": "/api/voice/queues/{id}",
32669 "title": "Update an existing Queue",
32672 "title": "Example usage:",
32673 "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",
32677 "name": "updateQueues",
32678 "group": "Voice_Queues",
32679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32680 "version": "0.0.0",
32681 "filename": "server/api/voiceQueue/index.js",
32682 "groupTitle": "Voice_Queues"
32686 "url": "/api/voice/recordings",
32687 "title": "Creates a new Recording",
32690 "title": "Example usage:",
32691 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32695 "name": "CreateRecordings",
32696 "group": "Voice_Recordings",
32711 "field": "uniqueid",
32718 "field": "channel",
32725 "field": "membername",
32732 "field": "calleridnum",
32739 "field": "calleridname",
32746 "field": "connectedlinenum",
32753 "field": "connectedlinename",
32760 "field": "accountcode",
32767 "field": "context",
32809 "field": "userDisposition",
32816 "field": "userSecondDisposition",
32823 "field": "userThirdDisposition",
32830 "field": "location",
32837 "field": "transcribeName",
32844 "field": "transcribeStatus",
32851 "field": "fileUri",
32858 "field": "fileText",
32865 "field": "failureReason",
32872 "field": "sentiment",
32879 "field": "sPositive",
32886 "field": "sNegative",
32893 "field": "sNeutral",
32907 "field": "tempSentiment",
32914 "field": "createdAt",
32921 "field": "updatedAt",
32927 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32928 "version": "0.0.0",
32929 "filename": "server/api/voiceRecording/index.js",
32930 "groupTitle": "Voice_Recordings"
32934 "url": "/api/voice/recordings/describe",
32935 "title": "Gets table info about Recordings",
32938 "title": "Example usage:",
32939 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
32943 "name": "DescribeRecordings",
32944 "group": "Voice_Recordings",
32945 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32946 "version": "0.0.0",
32947 "filename": "server/api/voiceRecording/index.js",
32948 "groupTitle": "Voice_Recordings"
32952 "url": "/api/voice/recordings",
32953 "title": "Gets a list of Recordings",
32956 "title": "Example usage:",
32957 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
32961 "name": "GetRecordings",
32962 "group": "Voice_Recordings",
32963 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32964 "version": "0.0.0",
32965 "filename": "server/api/voiceRecording/index.js",
32966 "groupTitle": "Voice_Recordings"
32970 "url": "/api/voice/recordings/{id}",
32971 "title": "Gets a single Recording",
32974 "title": "Example usage:",
32975 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
32979 "name": "ShowRecordings",
32980 "group": "Voice_Recordings",
32981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32982 "version": "0.0.0",
32983 "filename": "server/api/voiceRecording/index.js",
32984 "groupTitle": "Voice_Recordings"
32988 "url": "/api/voice/recordings/{id}",
32989 "title": "Delete voice recording",
32992 "title": "Example usage:",
32993 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
32998 "group": "Voice_Recordings",
32999 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33000 "version": "0.0.0",
33001 "filename": "server/api/voiceRecording/index.js",
33002 "groupTitle": "Voice_Recordings"
33006 "url": "/api/voice/recordings/{id}/download",
33007 "title": "Download Recording",
33010 "title": "Example usage:",
33011 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33015 "name": "download",
33016 "group": "Voice_Recordings",
33017 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33018 "version": "0.0.0",
33019 "filename": "server/api/voiceRecording/index.js",
33020 "groupTitle": "Voice_Recordings"
33024 "url": "/api/voice/recordings/{id}/downloads",
33025 "title": "Download Recording",
33028 "title": "Example usage:",
33029 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33033 "name": "downloads",
33034 "group": "Voice_Recordings",
33035 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33036 "version": "0.0.0",
33037 "filename": "server/api/voiceRecording/index.js",
33038 "groupTitle": "Voice_Recordings"
33042 "url": "/api/voice/recordings/{id}/transcribe",
33043 "title": "Run Transcribe Recording",
33046 "title": "Example usage:",
33047 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33051 "name": "transcribe",
33052 "group": "Voice_Recordings",
33053 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33054 "version": "0.0.0",
33055 "filename": "server/api/voiceRecording/index.js",
33056 "groupTitle": "Voice_Recordings"
33060 "url": "/api/voice/recordings/{id}/transcribe",
33061 "title": "Run Transcribe Recording",
33064 "title": "Example usage:",
33065 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33069 "name": "transcribe",
33070 "group": "Voice_Recordings",
33071 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33072 "version": "0.0.0",
33073 "filename": "server/api/voiceRecording/index.js",
33074 "groupTitle": "Voice_Recordings"
33078 "url": "/api/voice/recordings/{id}",
33079 "title": "Update an existing Recording",
33082 "title": "Example usage:",
33083 "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",
33087 "name": "updateRecordings",
33088 "group": "Voice_Recordings",
33089 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33090 "version": "0.0.0",
33091 "filename": "server/api/voiceRecording/index.js",
33092 "groupTitle": "Voice_Recordings"
33096 "url": "/api/voice/transfers/reports",
33097 "title": "Creates a new Transfer Report",
33100 "title": "Example usage:",
33101 "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",
33105 "name": "CreateTransfer_Reports",
33106 "group": "Voice_Transfer_Reports",
33132 "field": "transfererchannel",
33139 "field": "transferercalleridnum",
33146 "field": "transferercalleridname",
33153 "field": "transfererconnectedlinenum",
33160 "field": "transfererconnectedlinename",
33167 "field": "transfereraccountcode",
33174 "field": "transferercontext",
33181 "field": "transfererexten",
33188 "field": "transfererlinkedid",
33195 "field": "transfereechannel",
33202 "field": "transfereecalleridnum",
33209 "field": "transfereecalleridname",
33216 "field": "transfereeconnectedlinenum",
33223 "field": "transfereeconnectedlinename",
33230 "field": "transfereeaccountcode",
33237 "field": "transfereecontext",
33244 "field": "transfereeexten",
33251 "field": "transfereelinkedid",
33262 "field": "isexternal",
33269 "field": "context",
33276 "field": "extension",
33282 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33283 "version": "0.0.0",
33284 "filename": "server/api/voiceTransferReport/index.js",
33285 "groupTitle": "Voice_Transfer_Reports"
33289 "url": "/api/voice/transfers/reports/{id}",
33290 "title": "Deletes a Transfer Report",
33293 "title": "Example usage:",
33294 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33298 "name": "DeleteTransfer_Reports",
33299 "group": "Voice_Transfer_Reports",
33300 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33301 "version": "0.0.0",
33302 "filename": "server/api/voiceTransferReport/index.js",
33303 "groupTitle": "Voice_Transfer_Reports"
33307 "url": "/api/voice/transfers/reports",
33308 "title": "Gets a list of Transfer Reports",
33311 "title": "Example usage:",
33312 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33316 "name": "GetTransfer_Reports",
33317 "group": "Voice_Transfer_Reports",
33318 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33319 "version": "0.0.0",
33320 "filename": "server/api/voiceTransferReport/index.js",
33321 "groupTitle": "Voice_Transfer_Reports"
33325 "url": "/api/voice/transfers/reports/{id}",
33326 "title": "Gets a single Transfer Report",
33329 "title": "Example usage:",
33330 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33334 "name": "ShowTransfer_Reports",
33335 "group": "Voice_Transfer_Reports",
33336 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33337 "version": "0.0.0",
33338 "filename": "server/api/voiceTransferReport/index.js",
33339 "groupTitle": "Voice_Transfer_Reports"
33343 "url": "/api/voice/transfers/reports/{id}",
33344 "title": "Update an existing Transfer Report",
33347 "title": "Example usage:",
33348 "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",
33352 "name": "updateTransfer_Reports",
33353 "group": "Voice_Transfer_Reports",
33354 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33355 "version": "0.0.0",
33356 "filename": "server/api/voiceTransferReport/index.js",
33357 "groupTitle": "Voice_Transfer_Reports"
33361 "url": "/api/integrations/vtiger/accounts",
33362 "title": "Creates a new Vtiger Account",
33365 "title": "Example usage:",
33366 "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",
33370 "name": "CreateVtiger_Accounts",
33371 "group": "Vtiger_Accounts",
33386 "field": "description",
33393 "field": "username",
33400 "field": "moduleName",
33407 "field": "remoteUri",
33414 "field": "serverUrl",
33421 "field": "accessKey",
33427 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33428 "version": "0.0.0",
33429 "filename": "server/api/intVtigerAccount/index.js",
33430 "groupTitle": "Vtiger_Accounts"
33434 "url": "/api/integrations/vtiger/accounts/{id}",
33435 "title": "Deletes a Vtiger Account",
33438 "title": "Example usage:",
33439 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33443 "name": "DeleteVtiger_Accounts",
33444 "group": "Vtiger_Accounts",
33445 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33446 "version": "0.0.0",
33447 "filename": "server/api/intVtigerAccount/index.js",
33448 "groupTitle": "Vtiger_Accounts"
33452 "url": "/api/integrations/vtiger/accounts",
33453 "title": "Gets a list of Vtiger Accounts",
33456 "title": "Example usage:",
33457 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33461 "name": "GetVtiger_Accounts",
33462 "group": "Vtiger_Accounts",
33463 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33464 "version": "0.0.0",
33465 "filename": "server/api/intVtigerAccount/index.js",
33466 "groupTitle": "Vtiger_Accounts"
33470 "url": "/api/integrations/vtiger/accounts/{id}",
33471 "title": "Gets a single Vtiger Account",
33474 "title": "Example usage:",
33475 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33479 "name": "ShowVtiger_Accounts",
33480 "group": "Vtiger_Accounts",
33481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33482 "version": "0.0.0",
33483 "filename": "server/api/intVtigerAccount/index.js",
33484 "groupTitle": "Vtiger_Accounts"
33488 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33489 "title": "Creates new configuration",
33492 "title": "Example usage:",
33493 "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",
33497 "name": "addConfiguration",
33498 "group": "Vtiger_Accounts",
33499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33500 "version": "0.0.0",
33501 "filename": "server/api/intVtigerAccount/index.js",
33502 "groupTitle": "Vtiger_Accounts"
33506 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33507 "title": "Gets account configurations",
33510 "title": "Example usage:",
33511 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33515 "name": "getConfigurations",
33516 "group": "Vtiger_Accounts",
33517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33518 "version": "0.0.0",
33519 "filename": "server/api/intVtigerAccount/index.js",
33520 "groupTitle": "Vtiger_Accounts"
33524 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33525 "title": "Gets account fields",
33528 "title": "Example usage:",
33529 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33533 "name": "getFields",
33534 "group": "Vtiger_Accounts",
33535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33536 "version": "0.0.0",
33537 "filename": "server/api/intVtigerAccount/index.js",
33538 "groupTitle": "Vtiger_Accounts"
33542 "url": "/api/integrations/vtiger/accounts/{id}",
33543 "title": "Update an existing Vtiger Account",
33546 "title": "Example usage:",
33547 "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",
33551 "name": "updateVtiger_Accounts",
33552 "group": "Vtiger_Accounts",
33553 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33554 "version": "0.0.0",
33555 "filename": "server/api/intVtigerAccount/index.js",
33556 "groupTitle": "Vtiger_Accounts"
33560 "url": "/api/integrations/vtiger/configurations",
33561 "title": "Creates a new Vtiger Configuration",
33564 "title": "Example usage:",
33565 "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",
33569 "name": "CreateVtiger_Configurations",
33570 "group": "Vtiger_Configurations",
33585 "field": "description",
33591 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33592 "version": "0.0.0",
33593 "filename": "server/api/intVtigerConfiguration/index.js",
33594 "groupTitle": "Vtiger_Configurations"
33598 "url": "/api/integrations/vtiger/configurations/{id}",
33599 "title": "Deletes a Vtiger Configuration",
33602 "title": "Example usage:",
33603 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33607 "name": "DeleteVtiger_Configurations",
33608 "group": "Vtiger_Configurations",
33609 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33610 "version": "0.0.0",
33611 "filename": "server/api/intVtigerConfiguration/index.js",
33612 "groupTitle": "Vtiger_Configurations"
33616 "url": "/api/integrations/vtiger/configurations",
33617 "title": "Gets a list of Vtiger Configurations",
33620 "title": "Example usage:",
33621 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33625 "name": "GetVtiger_Configurations",
33626 "group": "Vtiger_Configurations",
33627 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33628 "version": "0.0.0",
33629 "filename": "server/api/intVtigerConfiguration/index.js",
33630 "groupTitle": "Vtiger_Configurations"
33634 "url": "/api/integrations/vtiger/configurations/{id}",
33635 "title": "Gets a single Vtiger Configuration",
33638 "title": "Example usage:",
33639 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33643 "name": "ShowVtiger_Configurations",
33644 "group": "Vtiger_Configurations",
33645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33646 "version": "0.0.0",
33647 "filename": "server/api/intVtigerConfiguration/index.js",
33648 "groupTitle": "Vtiger_Configurations"
33652 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33653 "title": "Gets configurations descriptions",
33656 "title": "Example usage:",
33657 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33661 "name": "getDescriptions",
33662 "group": "Vtiger_Configurations",
33663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33664 "version": "0.0.0",
33665 "filename": "server/api/intVtigerConfiguration/index.js",
33666 "groupTitle": "Vtiger_Configurations"
33670 "url": "/api/integrations/vtiger/configurations/{id}/fields",
33671 "title": "Gets configurations fields",
33674 "title": "Example usage:",
33675 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33679 "name": "getFields",
33680 "group": "Vtiger_Configurations",
33681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33682 "version": "0.0.0",
33683 "filename": "server/api/intVtigerConfiguration/index.js",
33684 "groupTitle": "Vtiger_Configurations"
33688 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33689 "title": "Gets configurations subjects",
33692 "title": "Example usage:",
33693 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33697 "name": "getSubjects",
33698 "group": "Vtiger_Configurations",
33699 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33700 "version": "0.0.0",
33701 "filename": "server/api/intVtigerConfiguration/index.js",
33702 "groupTitle": "Vtiger_Configurations"
33706 "url": "/api/integrations/vtiger/configurations/{id}",
33707 "title": "Update an existing Vtiger Configuration",
33710 "title": "Example usage:",
33711 "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",
33715 "name": "updateVtiger_Configurations",
33716 "group": "Vtiger_Configurations",
33717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33718 "version": "0.0.0",
33719 "filename": "server/api/intVtigerConfiguration/index.js",
33720 "groupTitle": "Vtiger_Configurations"
33724 "url": "/api/integrations/vtiger/fields",
33725 "title": "Creates a new Vtiger Field",
33728 "title": "Example usage:",
33729 "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",
33733 "name": "CreateVtiger_Fields",
33734 "group": "Vtiger_Fields",
33744 "\"customVariable\"",
33755 "field": "content",
33771 "\"customVariable\""
33774 "field": "keyType",
33781 "field": "keyContent",
33788 "field": "idField",
33795 "field": "nameField",
33802 "field": "customField",
33809 "field": "variableName",
33815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33816 "version": "0.0.0",
33817 "filename": "server/api/intVtigerField/index.js",
33818 "groupTitle": "Vtiger_Fields"
33822 "url": "/api/integrations/vtiger/fields/{id}",
33823 "title": "Deletes a Vtiger Field",
33826 "title": "Example usage:",
33827 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33831 "name": "DeleteVtiger_Fields",
33832 "group": "Vtiger_Fields",
33833 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33834 "version": "0.0.0",
33835 "filename": "server/api/intVtigerField/index.js",
33836 "groupTitle": "Vtiger_Fields"
33840 "url": "/api/integrations/vtiger/fields",
33841 "title": "Gets a list of Vtiger Fields",
33844 "title": "Example usage:",
33845 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33849 "name": "GetVtiger_Fields",
33850 "group": "Vtiger_Fields",
33851 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33852 "version": "0.0.0",
33853 "filename": "server/api/intVtigerField/index.js",
33854 "groupTitle": "Vtiger_Fields"
33858 "url": "/api/integrations/vtiger/fields/{id}",
33859 "title": "Gets a single Vtiger Field",
33862 "title": "Example usage:",
33863 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33867 "name": "ShowVtiger_Fields",
33868 "group": "Vtiger_Fields",
33869 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33870 "version": "0.0.0",
33871 "filename": "server/api/intVtigerField/index.js",
33872 "groupTitle": "Vtiger_Fields"
33876 "url": "/api/integrations/vtiger/fields/{id}",
33877 "title": "Update an existing Vtiger Field",
33880 "title": "Example usage:",
33881 "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",
33885 "name": "updateVtiger_Fields",
33886 "group": "Vtiger_Fields",
33887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33888 "version": "0.0.0",
33889 "filename": "server/api/intVtigerField/index.js",
33890 "groupTitle": "Vtiger_Fields"
33894 "url": "/api/webbar/answer",
33895 "title": "answer webrtc call",
33898 "title": "Example usage:",
33899 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33903 "name": "Web_Bar_answer",
33912 "field": "sessionId",
33925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33926 "version": "0.0.0",
33927 "filename": "server/api/webbar/index.js",
33928 "groupTitle": "WebBar"
33932 "url": "/api/webbar/calls",
33933 "title": "webrtc call list",
33936 "title": "Example usage:",
33937 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33941 "name": "Web_Bar_calls",
33956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33957 "version": "0.0.0",
33958 "filename": "server/api/webbar/index.js",
33959 "groupTitle": "WebBar"
33963 "url": "/api/webbar/hangup",
33964 "title": "hangup webrtc call",
33967 "title": "Example usage:",
33968 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33972 "name": "Web_Bar_hangup",
33981 "field": "sessionId",
33994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33995 "version": "0.0.0",
33996 "filename": "server/api/webbar/index.js",
33997 "groupTitle": "WebBar"
34001 "url": "/api/webbar/unhold",
34002 "title": "unhold webrtc call",
34005 "title": "Example usage:",
34006 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34010 "name": "Web_Bar_hold",
34019 "field": "sessionId",
34032 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34033 "version": "0.0.0",
34034 "filename": "server/api/webbar/index.js",
34035 "groupTitle": "WebBar"
34039 "url": "/api/webbar/hold",
34040 "title": "hold webrtc call",
34043 "title": "Example usage:",
34044 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34048 "name": "Web_Bar_hold",
34057 "field": "sessionId",
34070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34071 "version": "0.0.0",
34072 "filename": "server/api/webbar/index.js",
34073 "groupTitle": "WebBar"
34077 "url": "/api/webbar/originate",
34078 "title": "Originate new webrtc call",
34081 "title": "Example usage:",
34082 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34086 "name": "Web_Bar_originate",
34095 "field": "callNumber",
34109 "field": "callerId",
34116 "field": "callbackUrl",
34122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34123 "version": "0.0.0",
34124 "filename": "server/api/webbar/index.js",
34125 "groupTitle": "WebBar"
34129 "url": "/api/webbar/transfer",
34130 "title": "blind transfer webrtc call",
34133 "title": "Example usage:",
34134 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34138 "name": "Web_Bar_transfer",
34154 "field": "sessionId",
34161 "field": "transferNumber",
34167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34168 "version": "0.0.0",
34169 "filename": "server/api/webbar/index.js",
34170 "groupTitle": "WebBar"
34174 "url": "/api/whatsapp/accounts/{id}/users",
34175 "title": "Add agents to a whatsapp account",
34178 "title": "Example usage:",
34179 "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",
34183 "name": "AddAgents",
34184 "group": "Whatsapp_Accounts",
34185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34186 "version": "0.0.0",
34187 "filename": "server/api/whatsappAccount/index.js",
34188 "groupTitle": "Whatsapp_Accounts"
34192 "url": "/api/whatsapp/accounts",
34193 "title": "Creates a new Account",
34196 "title": "Example usage:",
34197 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34201 "name": "CreateAccounts",
34202 "group": "Whatsapp_Accounts",
34255 "field": "accountSid",
34262 "field": "authToken",
34269 "field": "notificationTemplate",
34276 "field": "notificationSound",
34283 "field": "notificationShake",
34290 "field": "waitForTheAssignedAgent",
34297 "field": "queueTransfer",
34304 "field": "queueTransferTimeout",
34311 "field": "agentTransfer",
34318 "field": "agentTransferTimeout",
34325 "field": "mandatoryDispositionPauseId",
34326 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34332 "field": "mandatoryDisposition",
34333 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34339 "field": "description",
34345 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34346 "version": "0.0.0",
34347 "filename": "server/api/whatsappAccount/index.js",
34348 "groupTitle": "Whatsapp_Accounts"
34352 "url": "/api/whatsapp/accounts/{id}",
34353 "title": "Deletes a Account",
34356 "title": "Example usage:",
34357 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34361 "name": "DeleteAccounts",
34362 "group": "Whatsapp_Accounts",
34363 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34364 "version": "0.0.0",
34365 "filename": "server/api/whatsappAccount/index.js",
34366 "groupTitle": "Whatsapp_Accounts"
34370 "url": "/api/whatsapp/accounts/describe",
34371 "title": "Gets table info about Accounts",
34374 "title": "Example usage:",
34375 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34379 "name": "DescribeAccounts",
34380 "group": "Whatsapp_Accounts",
34381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34382 "version": "0.0.0",
34383 "filename": "server/api/whatsappAccount/index.js",
34384 "groupTitle": "Whatsapp_Accounts"
34388 "url": "/api/whatsapp/accounts",
34389 "title": "Gets a list of Accounts",
34392 "title": "Example usage:",
34393 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34397 "name": "GetAccounts",
34398 "group": "Whatsapp_Accounts",
34399 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34400 "version": "0.0.0",
34401 "filename": "server/api/whatsappAccount/index.js",
34402 "groupTitle": "Whatsapp_Accounts"
34406 "url": "/api/whatsapp/accounts/{id}/users",
34407 "title": "Gets agents from whatsapp account",
34410 "title": "Example usage:",
34411 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34415 "name": "GetAgents",
34416 "group": "Whatsapp_Accounts",
34417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/{id}/users",
34425 "title": "Removes agents from a whatsapp account",
34428 "title": "Example usage:",
34429 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34433 "name": "RemoveAgents",
34434 "group": "Whatsapp_Accounts",
34435 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34436 "version": "0.0.0",
34437 "filename": "server/api/whatsappAccount/index.js",
34438 "groupTitle": "Whatsapp_Accounts"
34442 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34443 "title": "Removes canned answers from account",
34446 "title": "Example usage:",
34447 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34451 "name": "RemoveAnswers",
34452 "group": "Whatsapp_Accounts",
34453 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34454 "version": "0.0.0",
34455 "filename": "server/api/whatsappAccount/index.js",
34456 "groupTitle": "Whatsapp_Accounts"
34460 "url": "/api/whatsapp/accounts/{id}/dispositions",
34461 "title": "Removes dispositions from account",
34464 "title": "Example usage:",
34465 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34469 "name": "RemoveDispositions",
34470 "group": "Whatsapp_Accounts",
34471 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34472 "version": "0.0.0",
34473 "filename": "server/api/whatsappAccount/index.js",
34474 "groupTitle": "Whatsapp_Accounts"
34478 "url": "/api/whatsapp/accounts/{id}",
34479 "title": "Gets a single Account",
34482 "title": "Example usage:",
34483 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34487 "name": "ShowAccounts",
34488 "group": "Whatsapp_Accounts",
34489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34490 "version": "0.0.0",
34491 "filename": "server/api/whatsappAccount/index.js",
34492 "groupTitle": "Whatsapp_Accounts"
34496 "url": "/api/whatsapp/messages/{id}/accept",
34497 "title": "Accepts message",
34500 "title": "Example usage:",
34501 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34505 "name": "acceptMessage",
34506 "group": "Whatsapp_Accounts",
34507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34508 "version": "0.0.0",
34509 "filename": "server/api/whatsappMessage/index.js",
34510 "groupTitle": "Whatsapp_Accounts"
34514 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34515 "title": "Creates new canned answer",
34518 "title": "Example usage:",
34519 "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",
34523 "name": "addAnswer",
34524 "group": "Whatsapp_Accounts",
34546 "field": "description",
34559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34560 "version": "0.0.0",
34561 "filename": "server/api/whatsappAccount/index.js",
34562 "groupTitle": "Whatsapp_Accounts"
34566 "url": "/api/whatsapp/accounts/{id}/applications",
34567 "title": "Creates new applications",
34570 "title": "Example usage:",
34571 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34575 "name": "addApplications",
34576 "group": "Whatsapp_Accounts",
34584 "field": "priority",
34598 "field": "appdata",
34605 "field": "description",
34612 "field": "interval",
34618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34619 "version": "0.0.0",
34620 "filename": "server/api/whatsappAccount/index.js",
34621 "groupTitle": "Whatsapp_Accounts"
34625 "url": "/api/whatsapp/accounts/{id}/dispositions",
34626 "title": "Creates new disposition",
34629 "title": "Example usage:",
34630 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34634 "name": "addDisposition",
34635 "group": "Whatsapp_Accounts",
34662 "field": "description",
34668 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34669 "version": "0.0.0",
34670 "filename": "server/api/whatsappAccount/index.js",
34671 "groupTitle": "Whatsapp_Accounts"
34675 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34676 "title": "Gets account canned answers",
34679 "title": "Example usage:",
34680 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34684 "name": "getAnswers",
34685 "group": "Whatsapp_Accounts",
34686 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34687 "version": "0.0.0",
34688 "filename": "server/api/whatsappAccount/index.js",
34689 "groupTitle": "Whatsapp_Accounts"
34693 "url": "/api/whatsapp/accounts/{id}/applications",
34694 "title": "Gets account applications",
34697 "title": "Example usage:",
34698 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34702 "name": "getApplications",
34703 "group": "Whatsapp_Accounts",
34704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34705 "version": "0.0.0",
34706 "filename": "server/api/whatsappAccount/index.js",
34707 "groupTitle": "Whatsapp_Accounts"
34711 "url": "/api/whatsapp/accounts/{id}/dispositions",
34712 "title": "Gets account dispositions",
34715 "title": "Example usage:",
34716 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34720 "name": "getDispositions",
34721 "group": "Whatsapp_Accounts",
34722 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34723 "version": "0.0.0",
34724 "filename": "server/api/whatsappAccount/index.js",
34725 "groupTitle": "Whatsapp_Accounts"
34729 "url": "/api/whatsapp/accounts/{id}/notify",
34730 "title": "Notify new message",
34733 "title": "Example usage:",
34734 "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",
34739 "group": "Whatsapp_Accounts",
34740 "description": "<p>Motion 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>",
34741 "version": "0.0.0",
34742 "filename": "server/api/whatsappAccount/index.js",
34743 "groupTitle": "Whatsapp_Accounts"
34747 "url": "/api/whatsapp/messages/{id}/reject",
34748 "title": "Rejects message",
34751 "title": "Example usage:",
34752 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34756 "name": "rejectMessage",
34757 "group": "Whatsapp_Accounts",
34758 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34759 "version": "0.0.0",
34760 "filename": "server/api/whatsappMessage/index.js",
34761 "groupTitle": "Whatsapp_Accounts"
34765 "url": "/api/whatsapp/accounts/{id}/send",
34766 "title": "Send new whatsapp message",
34769 "title": "Example usage:",
34770 "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",
34774 "name": "sendWhatsapp",
34775 "group": "Whatsapp_Accounts",
34776 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34777 "version": "0.0.0",
34778 "filename": "server/api/whatsappAccount/index.js",
34779 "groupTitle": "Whatsapp_Accounts"
34783 "url": "/api/whatsapp/messages/{id}/status",
34784 "title": "Receive message status",
34787 "title": "Example usage:",
34788 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34792 "name": "statusMessage",
34793 "group": "Whatsapp_Accounts",
34794 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34795 "version": "0.0.0",
34796 "filename": "server/api/whatsappMessage/index.js",
34797 "groupTitle": "Whatsapp_Accounts"
34801 "url": "/api/whatsapp/accounts/{id}",
34802 "title": "Update an existing Account",
34805 "title": "Example usage:",
34806 "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",
34810 "name": "updateAccounts",
34811 "group": "Whatsapp_Accounts",
34812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34813 "version": "0.0.0",
34814 "filename": "server/api/whatsappAccount/index.js",
34815 "groupTitle": "Whatsapp_Accounts"
34819 "url": "/api/whatsapp/applications",
34820 "title": "Creates a new Application",
34823 "title": "Example usage:",
34824 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34828 "name": "CreateApplications",
34829 "group": "Whatsapp_Applications",
34837 "field": "priority",
34851 "field": "appdata",
34858 "field": "description",
34865 "field": "interval",
34871 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34872 "version": "0.0.0",
34873 "filename": "server/api/whatsappApplication/index.js",
34874 "groupTitle": "Whatsapp_Applications"
34878 "url": "/api/whatsapp/applications/{id}",
34879 "title": "Deletes a Application",
34882 "title": "Example usage:",
34883 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34887 "name": "DeleteApplications",
34888 "group": "Whatsapp_Applications",
34889 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34890 "version": "0.0.0",
34891 "filename": "server/api/whatsappApplication/index.js",
34892 "groupTitle": "Whatsapp_Applications"
34896 "url": "/api/whatsapp/applications",
34897 "title": "Gets a list of Applications",
34900 "title": "Example usage:",
34901 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
34905 "name": "GetApplications",
34906 "group": "Whatsapp_Applications",
34907 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34908 "version": "0.0.0",
34909 "filename": "server/api/whatsappApplication/index.js",
34910 "groupTitle": "Whatsapp_Applications"
34914 "url": "/api/whatsapp/applications/{id}",
34915 "title": "Gets a single Application",
34918 "title": "Example usage:",
34919 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
34923 "name": "ShowApplications",
34924 "group": "Whatsapp_Applications",
34925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34926 "version": "0.0.0",
34927 "filename": "server/api/whatsappApplication/index.js",
34928 "groupTitle": "Whatsapp_Applications"
34932 "url": "/api/whatsapp/applications/{id}",
34933 "title": "Update an existing Application",
34936 "title": "Example usage:",
34937 "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",
34941 "name": "updateApplications",
34942 "group": "Whatsapp_Applications",
34943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34944 "version": "0.0.0",
34945 "filename": "server/api/whatsappApplication/index.js",
34946 "groupTitle": "Whatsapp_Applications"
34950 "url": "/api/whatsapp/interactions/{id}/tags",
34951 "title": "Add tags to the interaction",
34954 "title": "Example usage:",
34955 "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",
34960 "group": "Whatsapp_Interactions",
34961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34962 "version": "0.0.0",
34963 "filename": "server/api/whatsappInteraction/index.js",
34964 "groupTitle": "Whatsapp_Interactions"
34968 "url": "/api/whatsapp/interactions",
34969 "title": "Creates a new Interaction",
34972 "title": "Example usage:",
34973 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34977 "name": "CreateInteractions",
34978 "group": "Whatsapp_Interactions",
34993 "field": "closedAt",
35000 "field": "disposition",
35007 "field": "secondDisposition",
35014 "field": "thirdDisposition",
35035 "field": "read1stAt",
35046 "field": "firstMsgDirection",
35053 "field": "lastMsgAt",
35064 "field": "lastMsgDirection",
35070 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35071 "version": "0.0.0",
35072 "filename": "server/api/whatsappInteraction/index.js",
35073 "groupTitle": "Whatsapp_Interactions"
35077 "url": "/api/whatsapp/interactions/{id}",
35078 "title": "Deletes a Interaction",
35081 "title": "Example usage:",
35082 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35086 "name": "DeleteInteractions",
35087 "group": "Whatsapp_Interactions",
35088 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35089 "version": "0.0.0",
35090 "filename": "server/api/whatsappInteraction/index.js",
35091 "groupTitle": "Whatsapp_Interactions"
35095 "url": "/api/whatsapp/interactions/describe",
35096 "title": "Gets table info about Interactions",
35099 "title": "Example usage:",
35100 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35104 "name": "DescribeInteractions",
35105 "group": "Whatsapp_Interactions",
35106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35107 "version": "0.0.0",
35108 "filename": "server/api/whatsappInteraction/index.js",
35109 "groupTitle": "Whatsapp_Interactions"
35113 "url": "/api/whatsapp/interactions",
35114 "title": "Gets a list of Interactions",
35117 "title": "Example usage:",
35118 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35122 "name": "GetInteractions",
35123 "group": "Whatsapp_Interactions",
35124 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35125 "version": "0.0.0",
35126 "filename": "server/api/whatsappInteraction/index.js",
35127 "groupTitle": "Whatsapp_Interactions"
35131 "url": "/api/whatsapp/interactions/{id}/tags",
35132 "title": "Removes tags from interaction",
35135 "title": "Example usage:",
35136 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35140 "name": "RemoveTags",
35141 "group": "Whatsapp_Interactions",
35142 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35143 "version": "0.0.0",
35144 "filename": "server/api/whatsappInteraction/index.js",
35145 "groupTitle": "Whatsapp_Interactions"
35149 "url": "/api/whatsapp/interactions/{id}",
35150 "title": "Gets a single Interaction",
35153 "title": "Example usage:",
35154 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35158 "name": "ShowInteractions",
35159 "group": "Whatsapp_Interactions",
35160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35161 "version": "0.0.0",
35162 "filename": "server/api/whatsappInteraction/index.js",
35163 "groupTitle": "Whatsapp_Interactions"
35167 "url": "/api/whatsapp/interactions/{id}/messages",
35168 "title": "Creates new messages",
35171 "title": "Example usage:",
35172 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35176 "name": "addMessage",
35177 "group": "Whatsapp_Interactions",
35203 "field": "direction",
35210 "field": "messageId",
35238 "field": "providerName",
35245 "field": "providerResponse",
35251 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35252 "version": "0.0.0",
35253 "filename": "server/api/whatsappInteraction/index.js",
35254 "groupTitle": "Whatsapp_Interactions"
35258 "url": "/api/whatsapp/interactions/{id}/download",
35259 "title": "Gets interaction",
35262 "title": "Example usage:",
35263 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35267 "name": "download",
35268 "group": "Whatsapp_Interactions",
35269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35270 "version": "0.0.0",
35271 "filename": "server/api/whatsappInteraction/index.js",
35272 "groupTitle": "Whatsapp_Interactions"
35276 "url": "/api/whatsapp/interactions/{id}/messages",
35277 "title": "Gets interaction messages",
35280 "title": "Example usage:",
35281 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35285 "name": "getMessages",
35286 "group": "Whatsapp_Interactions",
35287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35288 "version": "0.0.0",
35289 "filename": "server/api/whatsappInteraction/index.js",
35290 "groupTitle": "Whatsapp_Interactions"
35294 "url": "/api/whatsapp/interactions/{id}",
35295 "title": "Update an existing Interaction",
35298 "title": "Example usage:",
35299 "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",
35303 "name": "updateInteractions",
35304 "group": "Whatsapp_Interactions",
35305 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35306 "version": "0.0.0",
35307 "filename": "server/api/whatsappInteraction/index.js",
35308 "groupTitle": "Whatsapp_Interactions"
35312 "url": "/api/whatsapp/messages",
35313 "title": "Creates a new Message",
35316 "title": "Example usage:",
35317 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35321 "name": "CreateMessages",
35322 "group": "Whatsapp_Messages",
35348 "field": "direction",
35355 "field": "messageId",
35383 "field": "providerName",
35390 "field": "providerResponse",
35396 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35397 "version": "0.0.0",
35398 "filename": "server/api/whatsappMessage/index.js",
35399 "groupTitle": "Whatsapp_Messages"
35403 "url": "/api/whatsapp/messages/{id}",
35404 "title": "Deletes a Message",
35407 "title": "Example usage:",
35408 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35412 "name": "DeleteMessages",
35413 "group": "Whatsapp_Messages",
35414 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35415 "version": "0.0.0",
35416 "filename": "server/api/whatsappMessage/index.js",
35417 "groupTitle": "Whatsapp_Messages"
35421 "url": "/api/whatsapp/messages/describe",
35422 "title": "Gets table info about Messages",
35425 "title": "Example usage:",
35426 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35430 "name": "DescribeMessages",
35431 "group": "Whatsapp_Messages",
35432 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35433 "version": "0.0.0",
35434 "filename": "server/api/whatsappMessage/index.js",
35435 "groupTitle": "Whatsapp_Messages"
35439 "url": "/api/whatsapp/messages",
35440 "title": "Gets a list of Messages",
35443 "title": "Example usage:",
35444 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35448 "name": "GetMessages",
35449 "group": "Whatsapp_Messages",
35450 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35451 "version": "0.0.0",
35452 "filename": "server/api/whatsappMessage/index.js",
35453 "groupTitle": "Whatsapp_Messages"
35457 "url": "/api/whatsapp/messages/{id}",
35458 "title": "Gets a single Message",
35461 "title": "Example usage:",
35462 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35466 "name": "ShowMessages",
35467 "group": "Whatsapp_Messages",
35468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35469 "version": "0.0.0",
35470 "filename": "server/api/whatsappMessage/index.js",
35471 "groupTitle": "Whatsapp_Messages"
35475 "url": "/api/whatsapp/messages/{id}",
35476 "title": "Update an existing Message",
35479 "title": "Example usage:",
35480 "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",
35484 "name": "updateMessages",
35485 "group": "Whatsapp_Messages",
35486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35487 "version": "0.0.0",
35488 "filename": "server/api/whatsappMessage/index.js",
35489 "groupTitle": "Whatsapp_Messages"
35493 "url": "/api/whatsapp/reports/queue",
35494 "title": "Creates a new Whatsapp Queue Report",
35497 "title": "Example usage:",
35498 "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",
35502 "name": "CreateWhatsapp_Queue_Reports",
35503 "group": "Whatsapp_Queue_Reports",
35511 "field": "uniqueid",
35532 "field": "leaveAt",
35539 "field": "acceptAt",
35559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35560 "version": "0.0.0",
35561 "filename": "server/api/whatsappQueueReport/index.js",
35562 "groupTitle": "Whatsapp_Queue_Reports"
35566 "url": "/api/whatsapp/reports/queue/{id}",
35567 "title": "Deletes a Whatsapp Queue Report",
35570 "title": "Example usage:",
35571 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35575 "name": "DeleteWhatsapp_Queue_Reports",
35576 "group": "Whatsapp_Queue_Reports",
35577 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35578 "version": "0.0.0",
35579 "filename": "server/api/whatsappQueueReport/index.js",
35580 "groupTitle": "Whatsapp_Queue_Reports"
35584 "url": "/api/whatsapp/reports/queue/describe",
35585 "title": "Gets table info about Whatsapp Queue Reports",
35588 "title": "Example usage:",
35589 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35593 "name": "DescribeWhatsapp_Queue_Reports",
35594 "group": "Whatsapp_Queue_Reports",
35595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35596 "version": "0.0.0",
35597 "filename": "server/api/whatsappQueueReport/index.js",
35598 "groupTitle": "Whatsapp_Queue_Reports"
35602 "url": "/api/whatsapp/reports/queue",
35603 "title": "Gets a list of Whatsapp Queue Reports",
35606 "title": "Example usage:",
35607 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35611 "name": "GetWhatsapp_Queue_Reports",
35612 "group": "Whatsapp_Queue_Reports",
35613 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35614 "version": "0.0.0",
35615 "filename": "server/api/whatsappQueueReport/index.js",
35616 "groupTitle": "Whatsapp_Queue_Reports"
35620 "url": "/api/whatsapp/reports/queue/{id}",
35621 "title": "Gets a single Whatsapp Queue Report",
35624 "title": "Example usage:",
35625 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35629 "name": "ShowWhatsapp_Queue_Reports",
35630 "group": "Whatsapp_Queue_Reports",
35631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35632 "version": "0.0.0",
35633 "filename": "server/api/whatsappQueueReport/index.js",
35634 "groupTitle": "Whatsapp_Queue_Reports"
35638 "url": "/api/whatsapp/reports/queue/{id}",
35639 "title": "Update an existing Whatsapp Queue Report",
35642 "title": "Example usage:",
35643 "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",
35647 "name": "updateWhatsapp_Queue_Reports",
35648 "group": "Whatsapp_Queue_Reports",
35649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35650 "version": "0.0.0",
35651 "filename": "server/api/whatsappQueueReport/index.js",
35652 "groupTitle": "Whatsapp_Queue_Reports"
35656 "url": "/api/whatsapp/queues/{id}/users",
35657 "title": "Add agents to a queue",
35660 "title": "Example usage:",
35661 "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",
35665 "name": "AddAgents",
35666 "group": "Whatsapp_Queues",
35667 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35668 "version": "0.0.0",
35669 "filename": "server/api/whatsappQueue/index.js",
35670 "groupTitle": "Whatsapp_Queues"
35674 "url": "/api/whatsapp/queues/{id}/teams",
35675 "title": "Add teams to a queue",
35678 "title": "Example usage:",
35679 "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",
35683 "name": "AddTeams",
35684 "group": "Whatsapp_Queues",
35685 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35686 "version": "0.0.0",
35687 "filename": "server/api/whatsappQueue/index.js",
35688 "groupTitle": "Whatsapp_Queues"
35692 "url": "/api/whatsapp/queues",
35693 "title": "Creates a new Queue",
35696 "title": "Example usage:",
35697 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35701 "name": "CreateQueues",
35702 "group": "Whatsapp_Queues",
35717 "field": "timeout",
35729 "field": "strategy",
35736 "field": "description",
35742 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35743 "version": "0.0.0",
35744 "filename": "server/api/whatsappQueue/index.js",
35745 "groupTitle": "Whatsapp_Queues"
35749 "url": "/api/whatsapp/queues/{id}",
35750 "title": "Deletes a Queue",
35753 "title": "Example usage:",
35754 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35758 "name": "DeleteQueues",
35759 "group": "Whatsapp_Queues",
35760 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35761 "version": "0.0.0",
35762 "filename": "server/api/whatsappQueue/index.js",
35763 "groupTitle": "Whatsapp_Queues"
35767 "url": "/api/whatsapp/queues/describe",
35768 "title": "Gets table info about Queues",
35771 "title": "Example usage:",
35772 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35776 "name": "DescribeQueues",
35777 "group": "Whatsapp_Queues",
35778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35779 "version": "0.0.0",
35780 "filename": "server/api/whatsappQueue/index.js",
35781 "groupTitle": "Whatsapp_Queues"
35785 "url": "/api/whatsapp/queues/{id}/users",
35786 "title": "Gets queue agents",
35789 "title": "Example usage:",
35790 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35794 "name": "GetAgents",
35795 "group": "Whatsapp_Queues",
35796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35797 "version": "0.0.0",
35798 "filename": "server/api/whatsappQueue/index.js",
35799 "groupTitle": "Whatsapp_Queues"
35803 "url": "/api/whatsapp/queues/{id}/members",
35804 "title": "GetMembers",
35807 "title": "Example usage:",
35808 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
35812 "name": "GetMembers",
35813 "group": "Whatsapp_Queues",
35814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35815 "version": "0.0.0",
35816 "filename": "server/api/whatsappQueue/index.js",
35817 "groupTitle": "Whatsapp_Queues"
35821 "url": "/api/whatsapp/queues",
35822 "title": "Gets a list of Queues",
35825 "title": "Example usage:",
35826 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35830 "name": "GetQueues",
35831 "group": "Whatsapp_Queues",
35832 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35833 "version": "0.0.0",
35834 "filename": "server/api/whatsappQueue/index.js",
35835 "groupTitle": "Whatsapp_Queues"
35839 "url": "/api/whatsapp/queues/{id}/teams",
35840 "title": "Gets queues list",
35843 "title": "Example usage:",
35844 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35848 "name": "GetTeams",
35849 "group": "Whatsapp_Queues",
35850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35851 "version": "0.0.0",
35852 "filename": "server/api/whatsappQueue/index.js",
35853 "groupTitle": "Whatsapp_Queues"
35857 "url": "/api/whatsapp/queues/{id}/users",
35858 "title": "Removes agents from a queue",
35861 "title": "Example usage:",
35862 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35866 "name": "RemoveAgents",
35867 "group": "Whatsapp_Queues",
35868 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35869 "version": "0.0.0",
35870 "filename": "server/api/whatsappQueue/index.js",
35871 "groupTitle": "Whatsapp_Queues"
35875 "url": "/api/whatsapp/queues/{id}",
35876 "title": "Gets a single Queue",
35879 "title": "Example usage:",
35880 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35884 "name": "ShowQueues",
35885 "group": "Whatsapp_Queues",
35886 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35887 "version": "0.0.0",
35888 "filename": "server/api/whatsappQueue/index.js",
35889 "groupTitle": "Whatsapp_Queues"
35893 "url": "/api/whatsapp/queues/{id}",
35894 "title": "Update an existing Queue",
35897 "title": "Example usage:",
35898 "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",
35902 "name": "updateQueues",
35903 "group": "Whatsapp_Queues",
35904 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35905 "version": "0.0.0",
35906 "filename": "server/api/whatsappQueue/index.js",
35907 "groupTitle": "Whatsapp_Queues"
35911 "url": "/api/whatsapp/reports/transfer",
35912 "title": "Creates a new Whatsapp Transfer Report",
35915 "title": "Example usage:",
35916 "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",
35920 "name": "CreateWhatsapp_Transfer_Reports",
35921 "group": "Whatsapp_Transfer_Reports",
35929 "field": "uniqueid",
35948 "field": "transferredAt",
35954 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35955 "version": "0.0.0",
35956 "filename": "server/api/whatsappTransferReport/index.js",
35957 "groupTitle": "Whatsapp_Transfer_Reports"
35961 "url": "/api/whatsapp/reports/transfer/{id}",
35962 "title": "Deletes a Whatsapp Transfer Report",
35965 "title": "Example usage:",
35966 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
35970 "name": "DeleteWhatsapp_Transfer_Reports",
35971 "group": "Whatsapp_Transfer_Reports",
35972 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35973 "version": "0.0.0",
35974 "filename": "server/api/whatsappTransferReport/index.js",
35975 "groupTitle": "Whatsapp_Transfer_Reports"
35979 "url": "/api/whatsapp/reports/transfer/describe",
35980 "title": "Gets table info about Whatsapp Transfer Reports",
35983 "title": "Example usage:",
35984 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
35988 "name": "DescribeWhatsapp_Transfer_Reports",
35989 "group": "Whatsapp_Transfer_Reports",
35990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35991 "version": "0.0.0",
35992 "filename": "server/api/whatsappTransferReport/index.js",
35993 "groupTitle": "Whatsapp_Transfer_Reports"
35997 "url": "/api/whatsapp/reports/transfer",
35998 "title": "Gets a list of Whatsapp Transfer Reports",
36001 "title": "Example usage:",
36002 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36006 "name": "GetWhatsapp_Transfer_Reports",
36007 "group": "Whatsapp_Transfer_Reports",
36008 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36009 "version": "0.0.0",
36010 "filename": "server/api/whatsappTransferReport/index.js",
36011 "groupTitle": "Whatsapp_Transfer_Reports"
36015 "url": "/api/whatsapp/reports/transfer/{id}",
36016 "title": "Gets a single Whatsapp Transfer Report",
36019 "title": "Example usage:",
36020 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36024 "name": "ShowWhatsapp_Transfer_Reports",
36025 "group": "Whatsapp_Transfer_Reports",
36026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36027 "version": "0.0.0",
36028 "filename": "server/api/whatsappTransferReport/index.js",
36029 "groupTitle": "Whatsapp_Transfer_Reports"
36033 "url": "/api/whatsapp/reports/transfer/{id}",
36034 "title": "Update an existing Whatsapp Transfer Report",
36037 "title": "Example usage:",
36038 "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",
36042 "name": "updateWhatsapp_Transfer_Reports",
36043 "group": "Whatsapp_Transfer_Reports",
36044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36045 "version": "0.0.0",
36046 "filename": "server/api/whatsappTransferReport/index.js",
36047 "groupTitle": "Whatsapp_Transfer_Reports"
36051 "url": "/api/integrations/zendesk/accounts",
36052 "title": "Creates a new Zendesk Account",
36055 "title": "Example usage:",
36056 "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",
36060 "name": "CreateZendesk_Accounts",
36061 "group": "Zendesk_Accounts",
36076 "field": "description",
36083 "field": "username",
36090 "field": "password",
36104 "field": "remoteUri",
36115 "field": "authType",
36122 "field": "serverUrl",
36129 "\"integrationTab\"",
36139 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36140 "version": "0.0.0",
36141 "filename": "server/api/intZendeskAccount/index.js",
36142 "groupTitle": "Zendesk_Accounts"
36146 "url": "/api/integrations/zendesk/accounts/{id}",
36147 "title": "Deletes a Zendesk Account",
36150 "title": "Example usage:",
36151 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36155 "name": "DeleteZendesk_Accounts",
36156 "group": "Zendesk_Accounts",
36157 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36158 "version": "0.0.0",
36159 "filename": "server/api/intZendeskAccount/index.js",
36160 "groupTitle": "Zendesk_Accounts"
36164 "url": "/api/integrations/zendesk/accounts",
36165 "title": "Gets a list of Zendesk Accounts",
36168 "title": "Example usage:",
36169 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36173 "name": "GetZendesk_Accounts",
36174 "group": "Zendesk_Accounts",
36175 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36176 "version": "0.0.0",
36177 "filename": "server/api/intZendeskAccount/index.js",
36178 "groupTitle": "Zendesk_Accounts"
36182 "url": "/api/integrations/zendesk/accounts/{id}",
36183 "title": "Gets a single Zendesk Account",
36186 "title": "Example usage:",
36187 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36191 "name": "ShowZendesk_Accounts",
36192 "group": "Zendesk_Accounts",
36193 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36194 "version": "0.0.0",
36195 "filename": "server/api/intZendeskAccount/index.js",
36196 "groupTitle": "Zendesk_Accounts"
36200 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36201 "title": "Creates new configuration",
36204 "title": "Example usage:",
36205 "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",
36209 "name": "addConfiguration",
36210 "group": "Zendesk_Accounts",
36211 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36212 "version": "0.0.0",
36213 "filename": "server/api/intZendeskAccount/index.js",
36214 "groupTitle": "Zendesk_Accounts"
36218 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36219 "title": "Gets account configurations",
36222 "title": "Example usage:",
36223 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36227 "name": "getConfigurations",
36228 "group": "Zendesk_Accounts",
36229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36230 "version": "0.0.0",
36231 "filename": "server/api/intZendeskAccount/index.js",
36232 "groupTitle": "Zendesk_Accounts"
36236 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36237 "title": "Gets account fields",
36240 "title": "Example usage:",
36241 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36245 "name": "getFields",
36246 "group": "Zendesk_Accounts",
36247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36248 "version": "0.0.0",
36249 "filename": "server/api/intZendeskAccount/index.js",
36250 "groupTitle": "Zendesk_Accounts"
36254 "url": "/api/integrations/zendesk/accounts/{id}",
36255 "title": "Update an existing Zendesk Account",
36258 "title": "Example usage:",
36259 "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",
36263 "name": "updateZendesk_Accounts",
36264 "group": "Zendesk_Accounts",
36265 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36266 "version": "0.0.0",
36267 "filename": "server/api/intZendeskAccount/index.js",
36268 "groupTitle": "Zendesk_Accounts"
36272 "url": "/api/integrations/zendesk/configurations",
36273 "title": "Creates a new Zendesk Configuration",
36276 "title": "Example usage:",
36277 "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",
36281 "name": "CreateZendesk_Configurations",
36282 "group": "Zendesk_Configurations",
36297 "field": "description",
36303 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36304 "version": "0.0.0",
36305 "filename": "server/api/intZendeskConfiguration/index.js",
36306 "groupTitle": "Zendesk_Configurations"
36310 "url": "/api/integrations/zendesk/configurations/{id}",
36311 "title": "Deletes a Zendesk Configuration",
36314 "title": "Example usage:",
36315 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36319 "name": "DeleteZendesk_Configurations",
36320 "group": "Zendesk_Configurations",
36321 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36322 "version": "0.0.0",
36323 "filename": "server/api/intZendeskConfiguration/index.js",
36324 "groupTitle": "Zendesk_Configurations"
36328 "url": "/api/integrations/zendesk/configurations",
36329 "title": "Gets a list of Zendesk Configurations",
36332 "title": "Example usage:",
36333 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36337 "name": "GetZendesk_Configurations",
36338 "group": "Zendesk_Configurations",
36339 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36340 "version": "0.0.0",
36341 "filename": "server/api/intZendeskConfiguration/index.js",
36342 "groupTitle": "Zendesk_Configurations"
36346 "url": "/api/integrations/zendesk/configurations/{id}",
36347 "title": "Gets a single Zendesk Configuration",
36350 "title": "Example usage:",
36351 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36355 "name": "ShowZendesk_Configurations",
36356 "group": "Zendesk_Configurations",
36357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36358 "version": "0.0.0",
36359 "filename": "server/api/intZendeskConfiguration/index.js",
36360 "groupTitle": "Zendesk_Configurations"
36364 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36365 "title": "Gets configurations descriptions",
36368 "title": "Example usage:",
36369 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36373 "name": "getDescriptions",
36374 "group": "Zendesk_Configurations",
36375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36376 "version": "0.0.0",
36377 "filename": "server/api/intZendeskConfiguration/index.js",
36378 "groupTitle": "Zendesk_Configurations"
36382 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36383 "title": "Gets configurations fields",
36386 "title": "Example usage:",
36387 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36391 "name": "getFields",
36392 "group": "Zendesk_Configurations",
36393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36394 "version": "0.0.0",
36395 "filename": "server/api/intZendeskConfiguration/index.js",
36396 "groupTitle": "Zendesk_Configurations"
36400 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36401 "title": "Gets configurations subjects",
36404 "title": "Example usage:",
36405 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36409 "name": "getSubjects",
36410 "group": "Zendesk_Configurations",
36411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36412 "version": "0.0.0",
36413 "filename": "server/api/intZendeskConfiguration/index.js",
36414 "groupTitle": "Zendesk_Configurations"
36418 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36419 "title": "Gets configurations tags",
36422 "title": "Example usage:",
36423 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36428 "group": "Zendesk_Configurations",
36429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36430 "version": "0.0.0",
36431 "filename": "server/api/intZendeskConfiguration/index.js",
36432 "groupTitle": "Zendesk_Configurations"
36436 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36437 "title": "Sets new tags",
36440 "title": "Example usage:",
36441 "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",
36446 "group": "Zendesk_Configurations",
36447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36448 "version": "0.0.0",
36449 "filename": "server/api/intZendeskConfiguration/index.js",
36450 "groupTitle": "Zendesk_Configurations"
36454 "url": "/api/integrations/zendesk/configurations/{id}",
36455 "title": "Update an existing Zendesk Configuration",
36458 "title": "Example usage:",
36459 "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",
36463 "name": "updateZendesk_Configurations",
36464 "group": "Zendesk_Configurations",
36465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36466 "version": "0.0.0",
36467 "filename": "server/api/intZendeskConfiguration/index.js",
36468 "groupTitle": "Zendesk_Configurations"
36472 "url": "/api/integrations/zendesk/fields",
36473 "title": "Creates a new Zendesk Field",
36476 "title": "Example usage:",
36477 "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",
36481 "name": "CreateZendesk_Fields",
36482 "group": "Zendesk_Fields",
36492 "\"customVariable\"",
36503 "field": "content",
36519 "\"customVariable\""
36522 "field": "keyType",
36529 "field": "keyContent",
36536 "field": "idField",
36543 "field": "nameField",
36550 "field": "customField",
36557 "field": "variableName",
36563 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36564 "version": "0.0.0",
36565 "filename": "server/api/intZendeskField/index.js",
36566 "groupTitle": "Zendesk_Fields"
36570 "url": "/api/integrations/zendesk/fields/{id}",
36571 "title": "Deletes a Zendesk Field",
36574 "title": "Example usage:",
36575 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36579 "name": "DeleteZendesk_Fields",
36580 "group": "Zendesk_Fields",
36581 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36582 "version": "0.0.0",
36583 "filename": "server/api/intZendeskField/index.js",
36584 "groupTitle": "Zendesk_Fields"
36588 "url": "/api/integrations/zendesk/fields",
36589 "title": "Gets a list of Zendesk Fields",
36592 "title": "Example usage:",
36593 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36597 "name": "GetZendesk_Fields",
36598 "group": "Zendesk_Fields",
36599 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36600 "version": "0.0.0",
36601 "filename": "server/api/intZendeskField/index.js",
36602 "groupTitle": "Zendesk_Fields"
36606 "url": "/api/integrations/zendesk/fields/{id}",
36607 "title": "Gets a single Zendesk Field",
36610 "title": "Example usage:",
36611 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36615 "name": "ShowZendesk_Fields",
36616 "group": "Zendesk_Fields",
36617 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36618 "version": "0.0.0",
36619 "filename": "server/api/intZendeskField/index.js",
36620 "groupTitle": "Zendesk_Fields"
36624 "url": "/api/integrations/zendesk/fields/{id}",
36625 "title": "Update an existing Zendesk Field",
36628 "title": "Example usage:",
36629 "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",
36633 "name": "updateZendesk_Fields",
36634 "group": "Zendesk_Fields",
36635 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36636 "version": "0.0.0",
36637 "filename": "server/api/intZendeskField/index.js",
36638 "groupTitle": "Zendesk_Fields"
36642 "url": "/api/integrations/zoho/accounts",
36643 "title": "Creates a new Zoho Account",
36646 "title": "Example usage:",
36647 "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",
36651 "name": "CreateZoho_Accounts",
36652 "group": "Zoho_Accounts",
36667 "field": "description",
36688 "field": "clientId",
36695 "field": "clientSecret",
36702 "field": "serverUrl",
36716 "field": "refreshToken",
36722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36723 "version": "0.0.0",
36724 "filename": "server/api/intZohoAccount/index.js",
36725 "groupTitle": "Zoho_Accounts"
36729 "url": "/api/integrations/zoho/accounts/{id}",
36730 "title": "Deletes a Zoho Account",
36733 "title": "Example usage:",
36734 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36738 "name": "DeleteZoho_Accounts",
36739 "group": "Zoho_Accounts",
36740 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36741 "version": "0.0.0",
36742 "filename": "server/api/intZohoAccount/index.js",
36743 "groupTitle": "Zoho_Accounts"
36747 "url": "/api/integrations/zoho/accounts",
36748 "title": "Gets a list of Zoho Accounts",
36751 "title": "Example usage:",
36752 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36756 "name": "GetZoho_Accounts",
36757 "group": "Zoho_Accounts",
36758 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36759 "version": "0.0.0",
36760 "filename": "server/api/intZohoAccount/index.js",
36761 "groupTitle": "Zoho_Accounts"
36765 "url": "/api/integrations/zoho/accounts/{id}",
36766 "title": "Gets a single Zoho Account",
36769 "title": "Example usage:",
36770 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36774 "name": "ShowZoho_Accounts",
36775 "group": "Zoho_Accounts",
36776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36777 "version": "0.0.0",
36778 "filename": "server/api/intZohoAccount/index.js",
36779 "groupTitle": "Zoho_Accounts"
36783 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36784 "title": "Creates new configuration",
36787 "title": "Example usage:",
36788 "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",
36792 "name": "addConfiguration",
36793 "group": "Zoho_Accounts",
36794 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36795 "version": "0.0.0",
36796 "filename": "server/api/intZohoAccount/index.js",
36797 "groupTitle": "Zoho_Accounts"
36801 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36802 "title": "Gets account configurations",
36805 "title": "Example usage:",
36806 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36810 "name": "getConfigurations",
36811 "group": "Zoho_Accounts",
36812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36813 "version": "0.0.0",
36814 "filename": "server/api/intZohoAccount/index.js",
36815 "groupTitle": "Zoho_Accounts"
36819 "url": "/api/integrations/zoho/accounts/{id}/fields",
36820 "title": "Gets account fields",
36823 "title": "Example usage:",
36824 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36828 "name": "getFields",
36829 "group": "Zoho_Accounts",
36830 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36831 "version": "0.0.0",
36832 "filename": "server/api/intZohoAccount/index.js",
36833 "groupTitle": "Zoho_Accounts"
36837 "url": "/api/integrations/zoho/accounts/{id}",
36838 "title": "Update an existing Zoho Account",
36841 "title": "Example usage:",
36842 "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",
36846 "name": "updateZoho_Accounts",
36847 "group": "Zoho_Accounts",
36848 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36849 "version": "0.0.0",
36850 "filename": "server/api/intZohoAccount/index.js",
36851 "groupTitle": "Zoho_Accounts"
36855 "url": "/api/integrations/zoho/configurations",
36856 "title": "Creates a new Zoho Configuration",
36859 "title": "Example usage:",
36860 "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",
36864 "name": "CreateZoho_Configurations",
36865 "group": "Zoho_Configurations",
36885 "field": "moduleCreate",
36892 "\"contact_lead\"",
36897 "field": "moduleSearch",
36904 "field": "description",
36910 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36911 "version": "0.0.0",
36912 "filename": "server/api/intZohoConfiguration/index.js",
36913 "groupTitle": "Zoho_Configurations"
36917 "url": "/api/integrations/zoho/configurations/{id}",
36918 "title": "Deletes a Zoho Configuration",
36921 "title": "Example usage:",
36922 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
36926 "name": "DeleteZoho_Configurations",
36927 "group": "Zoho_Configurations",
36928 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36929 "version": "0.0.0",
36930 "filename": "server/api/intZohoConfiguration/index.js",
36931 "groupTitle": "Zoho_Configurations"
36935 "url": "/api/integrations/zoho/configurations",
36936 "title": "Gets a list of Zoho Configurations",
36939 "title": "Example usage:",
36940 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
36944 "name": "GetZoho_Configurations",
36945 "group": "Zoho_Configurations",
36946 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36947 "version": "0.0.0",
36948 "filename": "server/api/intZohoConfiguration/index.js",
36949 "groupTitle": "Zoho_Configurations"
36953 "url": "/api/integrations/zoho/configurations/{id}",
36954 "title": "Gets a single Zoho Configuration",
36957 "title": "Example usage:",
36958 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
36962 "name": "ShowZoho_Configurations",
36963 "group": "Zoho_Configurations",
36964 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36965 "version": "0.0.0",
36966 "filename": "server/api/intZohoConfiguration/index.js",
36967 "groupTitle": "Zoho_Configurations"
36971 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
36972 "title": "Gets configurations descriptions",
36975 "title": "Example usage:",
36976 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36980 "name": "getDescriptions",
36981 "group": "Zoho_Configurations",
36982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36983 "version": "0.0.0",
36984 "filename": "server/api/intZohoConfiguration/index.js",
36985 "groupTitle": "Zoho_Configurations"
36989 "url": "/api/integrations/zoho/configurations/{id}/fields",
36990 "title": "Gets configurations fields",
36993 "title": "Example usage:",
36994 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
36998 "name": "getFields",
36999 "group": "Zoho_Configurations",
37000 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37001 "version": "0.0.0",
37002 "filename": "server/api/intZohoConfiguration/index.js",
37003 "groupTitle": "Zoho_Configurations"
37007 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37008 "title": "Gets configurations subjects",
37011 "title": "Example usage:",
37012 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37016 "name": "getSubjects",
37017 "group": "Zoho_Configurations",
37018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37019 "version": "0.0.0",
37020 "filename": "server/api/intZohoConfiguration/index.js",
37021 "groupTitle": "Zoho_Configurations"
37025 "url": "/api/integrations/zoho/configurations/{id}",
37026 "title": "Update an existing Zoho Configuration",
37029 "title": "Example usage:",
37030 "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",
37034 "name": "updateZoho_Configurations",
37035 "group": "Zoho_Configurations",
37036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37037 "version": "0.0.0",
37038 "filename": "server/api/intZohoConfiguration/index.js",
37039 "groupTitle": "Zoho_Configurations"
37043 "url": "/api/integrations/zoho/fields",
37044 "title": "Creates a new Zoho Field",
37047 "title": "Example usage:",
37048 "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",
37052 "name": "CreateZoho_Fields",
37053 "group": "Zoho_Fields",
37063 "\"customVariable\"",
37074 "field": "content",
37090 "\"customVariable\""
37093 "field": "keyType",
37100 "field": "keyContent",
37107 "field": "idField",
37114 "field": "nameField",
37121 "field": "customField",
37128 "field": "variableName",
37134 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37135 "version": "0.0.0",
37136 "filename": "server/api/intZohoField/index.js",
37137 "groupTitle": "Zoho_Fields"
37141 "url": "/api/integrations/zoho/fields/{id}",
37142 "title": "Deletes a Zoho Field",
37145 "title": "Example usage:",
37146 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37150 "name": "DeleteZoho_Fields",
37151 "group": "Zoho_Fields",
37152 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37153 "version": "0.0.0",
37154 "filename": "server/api/intZohoField/index.js",
37155 "groupTitle": "Zoho_Fields"
37159 "url": "/api/integrations/zoho/fields",
37160 "title": "Gets a list of Zoho Fields",
37163 "title": "Example usage:",
37164 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37168 "name": "GetZoho_Fields",
37169 "group": "Zoho_Fields",
37170 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37171 "version": "0.0.0",
37172 "filename": "server/api/intZohoField/index.js",
37173 "groupTitle": "Zoho_Fields"
37177 "url": "/api/integrations/zoho/fields/{id}",
37178 "title": "Gets a single Zoho Field",
37181 "title": "Example usage:",
37182 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37186 "name": "ShowZoho_Fields",
37187 "group": "Zoho_Fields",
37188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37189 "version": "0.0.0",
37190 "filename": "server/api/intZohoField/index.js",
37191 "groupTitle": "Zoho_Fields"
37195 "url": "/api/integrations/zoho/fields/{id}",
37196 "title": "Update an existing Zoho Field",
37199 "title": "Example usage:",
37200 "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",
37204 "name": "updateZoho_Fields",
37205 "group": "Zoho_Fields",
37206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37207 "version": "0.0.0",
37208 "filename": "server/api/intZohoField/index.js",
37209 "groupTitle": "Zoho_Fields"
37214 "title": "Creates a new Cdr",
37217 "title": "Example usage:",
37218 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37222 "name": "CreateCdrs",
37231 "field": "calldate",
37259 "field": "dcontext",
37266 "field": "channel",
37273 "field": "dstchannel",
37280 "field": "lastapp",
37287 "field": "lastdata",
37294 "field": "duration",
37301 "field": "billsec",
37308 "field": "disposition",
37315 "field": "amaflags",
37322 "field": "accountcode",
37329 "field": "userfield",
37336 "field": "uniqueid",
37343 "field": "linkedid",
37350 "field": "sequence",
37357 "field": "peeraccount",
37377 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37378 "version": "0.0.0",
37379 "filename": "server/api/cdr/index.js",
37380 "groupTitle": "cdr"
37384 "url": "/api/cdr/{id}",
37385 "title": "Deletes a Cdr",
37388 "title": "Example usage:",
37389 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37393 "name": "DeleteCdrs",
37395 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37396 "version": "0.0.0",
37397 "filename": "server/api/cdr/index.js",
37398 "groupTitle": "cdr"
37402 "url": "/api/cdr/describe",
37403 "title": "Gets table info about Cdrs",
37406 "title": "Example usage:",
37407 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37411 "name": "DescribeCdrs",
37413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37414 "version": "0.0.0",
37415 "filename": "server/api/cdr/index.js",
37416 "groupTitle": "cdr"
37421 "title": "Gets a list of Cdrs",
37424 "title": "Example usage:",
37425 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37431 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37432 "version": "0.0.0",
37433 "filename": "server/api/cdr/index.js",
37434 "groupTitle": "cdr"
37438 "url": "/api/cdr/{id}",
37439 "title": "Gets a single Cdr",
37442 "title": "Example usage:",
37443 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37447 "name": "ShowCdrs",
37449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37450 "version": "0.0.0",
37451 "filename": "server/api/cdr/index.js",
37452 "groupTitle": "cdr"
37456 "url": "/api/cdr/{id}",
37457 "title": "Update an existing Cdr",
37460 "title": "Example usage:",
37461 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37465 "name": "updateCdrs",
37467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37468 "version": "0.0.0",
37469 "filename": "server/api/cdr/index.js",
37470 "groupTitle": "cdr"
37474 "url": "/api/voiceQueuesLog",
37475 "title": "Creates a new VoiceQueuesLog",
37478 "title": "Example usage:",
37479 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37483 "name": "CreateVoiceQueuesLogs",
37484 "group": "voiceQueuesLog",
37506 "field": "queuename",
37575 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37576 "version": "0.0.0",
37577 "filename": "server/api/voiceQueuesLog/index.js",
37578 "groupTitle": "voiceQueuesLog"
37582 "url": "/api/voiceQueuesLog/{id}",
37583 "title": "Deletes a VoiceQueuesLog",
37586 "title": "Example usage:",
37587 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37591 "name": "DeleteVoiceQueuesLogs",
37592 "group": "voiceQueuesLog",
37593 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37594 "version": "0.0.0",
37595 "filename": "server/api/voiceQueuesLog/index.js",
37596 "groupTitle": "voiceQueuesLog"
37600 "url": "/api/voiceQueuesLog",
37601 "title": "Gets a list of VoiceQueuesLogs",
37604 "title": "Example usage:",
37605 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37609 "name": "GetVoiceQueuesLogs",
37610 "group": "voiceQueuesLog",
37611 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37612 "version": "0.0.0",
37613 "filename": "server/api/voiceQueuesLog/index.js",
37614 "groupTitle": "voiceQueuesLog"
37618 "url": "/api/voiceQueuesLog/{id}",
37619 "title": "Gets a single VoiceQueuesLog",
37622 "title": "Example usage:",
37623 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37627 "name": "ShowVoiceQueuesLogs",
37628 "group": "voiceQueuesLog",
37629 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/voiceQueuesLog/index.js",
37632 "groupTitle": "voiceQueuesLog"
37636 "url": "/api/voiceQueuesLog/{id}",
37637 "title": "Update an existing VoiceQueuesLog",
37640 "title": "Example usage:",
37641 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37645 "name": "updateVoiceQueuesLogs",
37646 "group": "voiceQueuesLog",
37647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37648 "version": "0.0.0",
37649 "filename": "server/api/voiceQueuesLog/index.js",
37650 "groupTitle": "voiceQueuesLog"